| javax.script.ScriptEngineFactory
All known Subclasses: bsh.engine.BshScriptEngineFactory,
| ScriptEngineFactory | | public interface ScriptEngineFactory (Code) | | ScriptEngineFactory is used to describe and instantiate
ScriptEngines.
Each class implementing ScriptEngine has a corresponding factory
that exposes metadata describing the engine class.
The ScriptEngineManager
uses the service provider mechanism described in the Jar File Specification to obtain
instances of all ScriptEngineFactories available in
the current ClassLoader.
since:
1.6 |
| Method Summary | |
| public String | getEngineName()
Returns the full name of the ScriptEngine. | | public String | getEngineVersion()
Returns the version of the ScriptEngine. | | public List<String> | getExtensions()
Returns an immutable list of filename extensions, which generally identify scripts
written in the language supported by this ScriptEngine. | | public String | getLanguageName()
Returns the name of the scripting langauge supported by this
ScriptEngine. | | public String | getLanguageVersion()
Returns the version of the scripting language supported by this
ScriptEngine. | | public String | getMethodCallSyntax(String obj, String m, String... args)
Returns a String which can be used to invoke a method of a Java object using the syntax
of the supported scripting language. | | public List<String> | getMimeTypes()
Returns an immutable list of mimetypes, associated with scripts that
can be executed by the engine. | | public List<String> | getNames()
Returns an immutable list of short names for the ScriptEngine, which may be used to
identify the ScriptEngine by the ScriptEngineManager. | | public String | getOutputStatement(String toDisplay)
Returns a String that can be used as a statement to display the specified String using
the syntax of the supported scripting language. | | public Object | getParameter(String key)
Returns the value of an attribute whose meaning may be implementation-specific.
Keys for which the value is defined in all implementations are:
- ScriptEngine.ENGINE
- ScriptEngine.ENGINE_VERSION
- ScriptEngine.NAME
- ScriptEngine.LANGUAGE
- ScriptEngine.LANGUAGE_VERSION
The values for these keys are the Strings returned by getEngineName,
getEngineVersion, getName, getLanguageName and
getLanguageVersion respectively.
A reserved key, THREADING, whose value describes the behavior of the engine
with respect to concurrent execution of scripts and maintenance of state is also defined.
These values for the THREADING key are:
null - The engine implementation is not thread safe, and cannot
be used to execute scripts concurrently on multiple threads.
"MULTITHREADED" - The engine implementation is internally
thread-safe and scripts may execute concurrently although effects of script execution
on one thread may be visible to scripts on other threads.
"THREAD-ISOLATED" - The implementation satisfies the requirements
of "MULTITHREADED", and also, the engine maintains independent values
for symbols in scripts executing on different threads.
"STATELESS" - The implementation satisfies the requirements of
"THREAD-ISOLATED".
| | public String | getProgram(String... statements)
Returns A valid scripting language executable progam with given statements.
For instance an implementation for a PHP engine might be:
public String getProgram(String...
| | public ScriptEngine | getScriptEngine()
Returns an instance of the ScriptEngine associated with this
ScriptEngineFactory. |
| getEngineName | | public String getEngineName()(Code) | | Returns the full name of the ScriptEngine. For
instance an implementation based on the Mozilla Rhino Javascript engine
might return Rhino Mozilla Javascript Engine.
The name of the engine implementation. |
| getEngineVersion | | public String getEngineVersion()(Code) | | Returns the version of the ScriptEngine.
The ScriptEngine implementation version. |
| getExtensions | | public List<String> getExtensions()(Code) | | Returns an immutable list of filename extensions, which generally identify scripts
written in the language supported by this ScriptEngine.
The array is used by the ScriptEngineManager to implement its
getEngineByExtension method.
The list of extensions. |
| getLanguageName | | public String getLanguageName()(Code) | | Returns the name of the scripting langauge supported by this
ScriptEngine.
The name of the supported language. |
| getLanguageVersion | | public String getLanguageVersion()(Code) | | Returns the version of the scripting language supported by this
ScriptEngine.
The version of the supported language. |
| getMethodCallSyntax | | public String getMethodCallSyntax(String obj, String m, String... args)(Code) | | Returns a String which can be used to invoke a method of a Java object using the syntax
of the supported scripting language. For instance, an implementaton for a Javascript
engine might be;
public String getMethodCallSyntax(String obj,
String method, String... args) {
int ret = obj;
obj += "." + method + "(";
for (int i = 0; i < args.length; i++) {
return += args[i];
if (i == args.length - 1) {
obj += ")";
} else {
obj += ",");
}
}
return ret;
}
Parameters:
obj - The name representing the object whose method is to be invoked. Thename is the one used to create bindings using the put method ofScriptEngine, the put method of an ENGINE_SCOPEBindings,or the setAttribute methodof ScriptContext. The identifier used in scripts may be a decorated form of thespecified one.
Parameters:
m - The name of the method to invoke.
Parameters:
args - names of the arguments in the method call. The String used to invoke the method in the syntax of the scripting language. |
| getMimeTypes | | public List<String> getMimeTypes()(Code) | | Returns an immutable list of mimetypes, associated with scripts that
can be executed by the engine. The list is used by the
ScriptEngineManager class to implement its
getEngineByMimetype method.
The list of mime types. |
| getNames | | public List<String> getNames()(Code) | | Returns an immutable list of short names for the ScriptEngine, which may be used to
identify the ScriptEngine by the ScriptEngineManager.
For instance, an implementation based on the Mozilla Rhino Javascript engine might
return list containing {"javascript", "rhino"}.
|
| getOutputStatement | | public String getOutputStatement(String toDisplay)(Code) | | Returns a String that can be used as a statement to display the specified String using
the syntax of the supported scripting language. For instance, the implementaton for a Perl
engine might be;
public String getOutputStatement(String toDisplay) {
return "print(" + toDisplay + ")";
}
Parameters:
toDisplay - The String to be displayed by the returned statement. The string used to display the String in the syntax of the scripting language. |
| getParameter | | public Object getParameter(String key)(Code) | | Returns the value of an attribute whose meaning may be implementation-specific.
Keys for which the value is defined in all implementations are:
- ScriptEngine.ENGINE
- ScriptEngine.ENGINE_VERSION
- ScriptEngine.NAME
- ScriptEngine.LANGUAGE
- ScriptEngine.LANGUAGE_VERSION
The values for these keys are the Strings returned by getEngineName,
getEngineVersion, getName, getLanguageName and
getLanguageVersion respectively.
A reserved key, THREADING, whose value describes the behavior of the engine
with respect to concurrent execution of scripts and maintenance of state is also defined.
These values for the THREADING key are:
null - The engine implementation is not thread safe, and cannot
be used to execute scripts concurrently on multiple threads.
"MULTITHREADED" - The engine implementation is internally
thread-safe and scripts may execute concurrently although effects of script execution
on one thread may be visible to scripts on other threads.
"THREAD-ISOLATED" - The implementation satisfies the requirements
of "MULTITHREADED", and also, the engine maintains independent values
for symbols in scripts executing on different threads.
"STATELESS" - The implementation satisfies the requirements of
"THREAD-ISOLATED". In addition, script executions do not alter the
mappings in the Bindings which is the engine scope of the
ScriptEngine. In particular, the keys in the Bindings
and their associated values are the same before and after the execution of the script.
Implementations may define implementation-specific keys.
Parameters:
key - The name of the parameter The value for the given parameter. Returns null if novalue is assigned to the key. |
| getProgram | | public String getProgram(String... statements)(Code) | | Returns A valid scripting language executable progam with given statements.
For instance an implementation for a PHP engine might be:
public String getProgram(String... statements) {
$retval = "<?\n";
int len = statements.length;
for (int i = 0; i < len; i++) {
$retval += statements[i] + ";\n";
}
$retval += "?>";
}
Parameters:
statements - The statements to be executed. May be return values ofcalls to the getMethodCallSyntax and getOutputStatement methods. The Program |
| getScriptEngine | | public ScriptEngine getScriptEngine()(Code) | | Returns an instance of the ScriptEngine associated with this
ScriptEngineFactory. A new ScriptEngine is generally
returned, but implementations may pool, share or reuse engines.
A new ScriptEngine instance. |
|
|