com.threecrickets.scripturian.adapter

Class LanguageAdapterBase

java.lang.Object

com.threecrickets.scripturian.adapter.LanguageAdapterBase

All Implemented Interfaces:

LanguageAdapter

Direct Known Subclasses:

ClojureAdapter, GroovyAdapter, JeppAdapter, JRubyAdapter, JythonAdapter, LuajAdapter, NashornAdapter, PegdownAdapter, QuercusAdapter, RhinoAdapter, ScalaAdapter, SuccinctAdapter, VelocityAdapter, WikiTextAdapterBase

public abstract class LanguageAdapterBase
extends Object
implements LanguageAdapter

Common implementation base for language adapters.

Author:

Tal Liron

Field Summary

Fields inherited from interface com.threecrickets.scripturian.LanguageAdapter

DEFAULT_EXTENSION, DEFAULT_TAG, EXTENSIONS, LANGUAGE_NAME, LANGUAGE_VERSION, NAME, TAGS, VERSION

Constructor Summary

Constructors

Constructor and Description
LanguageAdapterBase(String name, String version, String languageName, String languageVersion, Collection<String> extensions, String defaultExtension, Collection<String> tags, String defaultTag) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	enter(String entryPointName, Executable executable, ExecutionContext executionContext, Object... arguments) Enters the executable at a stored, named location.
Map<String,Object>	getAttributes() Adapter attributes.
Lock	getLock() Used when LanguageAdapter.isThreadSafe() returns false.
LanguageManager	getManager() The language manager.
String	getSourceCodeForExpressionInclude(String expression, Executable executable) Creates source code for including the output of a text-with-scriptlets document.
String	getSourceCodeForExpressionOutput(String expression, Executable executable) Creates source code for outputting a source code expression to standard output.
String	getSourceCodeForLiteralOutput(String literal, Executable executable) Creates source code for outputting literal text to standard output.
boolean	isEphemeral() Some languages are meant for use in one segment only.
boolean	isThreadSafe() Some languages or their script engines are inherently broken when called by multiple threads.
void	releaseContext(ExecutionContext executionContext) Cleans up any resources used for an execution context.
void	setManager(LanguageManager manager) The language manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.threecrickets.scripturian.LanguageAdapter

createProgram

Constructor Detail

LanguageAdapterBase

public LanguageAdapterBase(String name,
                           String version,
                           String languageName,
                           String languageVersion,
                           Collection<String> extensions,
                           String defaultExtension,
                           Collection<String> tags,
                           String defaultTag)
                    throws LanguageAdapterException

Constructor.

Parameters:

name - The name of the language adapter implementation

version - The version of the language adapter implementation

languageName - The name of the implemented language

languageVersion - The version of the implemented language

extensions - Standard source code filename extensions

defaultExtension - Default source code filename extension

tags - Language tags supported for scriptlets

defaultTag - Default language tag used for scriptlets

Throws:

LanguageAdapterException - In case of an initialization error

Method Detail

getManager

public LanguageManager getManager()

Description copied from interface: LanguageAdapter

The language manager.

Specified by:

getManager in interface LanguageAdapter

Returns:

The language manager

setManager

public void setManager(LanguageManager manager)

Description copied from interface: LanguageAdapter

The language manager.

Specified by:

setManager in interface LanguageAdapter

Parameters:

manager - The manager

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: LanguageAdapter

Adapter attributes. Adapter must at least support the keys listed in this interface, but may support their own special keys.

Specified by:

getAttributes in interface LanguageAdapter

Returns:

The attributes

isThreadSafe

public boolean isThreadSafe()

Description copied from interface: LanguageAdapter

Some languages or their script engines are inherently broken when called by multiple threads. Returning false here makes sure Scripturian respects this and blocks.

Specified by:

isThreadSafe in interface LanguageAdapter

Returns:

True if we support being run by concurrent threads

isEphemeral

public boolean isEphemeral()

Description copied from interface: LanguageAdapter

Some languages are meant for use in one segment only. Return true here makes sure that Scripturian will not change the current language tag after each segment parsed by this adapter.

Specified by:

isEphemeral in interface LanguageAdapter

Returns:

True if the current language tag should not change

getLock

public Lock getLock()

Description copied from interface: LanguageAdapter

Used when LanguageAdapter.isThreadSafe() returns false.

Specified by:

getLock in interface LanguageAdapter

Returns:

The lock

enter

public Object enter(String entryPointName,
                    Executable executable,
                    ExecutionContext executionContext,
                    Object... arguments)
             throws NoSuchMethodException,
                    ParsingException,
                    ExecutionException

Description copied from interface: LanguageAdapter

Enters the executable at a stored, named location. According to the language, the entry point can be a function, method, lambda, closure, etc.

Specified by:

enter in interface LanguageAdapter

Parameters:

entryPointName - The entry point name

executable - The executable

executionContext - The executable context

arguments - Optional state to pass to the entry point

Returns:

State returned from to the entry point or null

Throws:

NoSuchMethodException - In case the entry point does not exist

ParsingException - In case of a parsing error

ExecutionException - In case of an execution error

releaseContext

public void releaseContext(ExecutionContext executionContext)

Description copied from interface: LanguageAdapter

Cleans up any resources used for an execution context.

Specified by:

releaseContext in interface LanguageAdapter

Parameters:

executionContext - The execution context

See Also:

ExecutionContext.getAttributes()

getSourceCodeForLiteralOutput

public String getSourceCodeForLiteralOutput(String literal,
                                            Executable executable)
                                     throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting literal text to standard output.

Specified by:

getSourceCodeForLiteralOutput in interface LanguageAdapter

Parameters:

literal - The literal text

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionOutput

public String getSourceCodeForExpressionOutput(String expression,
                                               Executable executable)
                                        throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting a source code expression to standard output.

Specified by:

getSourceCodeForExpressionOutput in interface LanguageAdapter

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionInclude

public String getSourceCodeForExpressionInclude(String expression,
                                                Executable executable)
                                         throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for including the output of a text-with-scriptlets document.

For this to work, the executable must have been created with a container that supports an inclusion command named according to the language manager attribute LanguageManager.CONTAINER_INCLUDE_COMMAND_ATTRIBUTE.

Specified by:

getSourceCodeForExpressionInclude in interface LanguageAdapter

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

See Also:

LanguageManager.getAttributes()