The scripting API consists of interfaces and classes that define Java TM Scripting Engines and provides a framework for their use in Java applications.
See: Description
Interface | Description |
---|---|
Bindings | A mapping of key/value pairs, all of whose keys are |
Compilable | The optional interface implemented by ScriptEngines whose methods compile scripts to a form that can be executed repeatedly without recompilation. |
Invocable | The optional interface implemented by ScriptEngines whose methods allow the invocation of procedures in scripts that have previously been executed. |
ScriptContext | The interface whose implementing classes are used to connect Script Engines with objects, such as scoped Bindings, in hosting applications. |
ScriptEngine |
|
ScriptEngineFactory |
|
Class | Description |
---|---|
AbstractScriptEngine | Provides a standard implementation for several of the variants of the |
CompiledScript | Extended by classes that store results of compilations. |
ScriptEngineManager | The |
SimpleBindings | A simple implementation of Bindings backed by a |
SimpleScriptContext | Simple implementation of ScriptContext. |
Exception | Description |
---|---|
ScriptException | The generic |
The scripting API consists of interfaces and classes that define Java TM Scripting Engines and provides a framework for their use in Java applications. This API is intended for use by application programmers who wish to execute programs written in scripting languages in their Java applications. The scripting language programs are usually provided by the end-users of the applications.
The main areas of functionality of javax.script
package include
Script execution: Scripts are streams of characters used as sources for programs executed by script engines. Script execution uses eval
methods of ScriptEngine
and methods of the Invocable
interface.
Binding: This facility allows Java objects to be exposed to script programs as named variables. Bindings
and ScriptContext
classes are used for this purpose.
Compilation: This functionality allows the intermediate code generated by the front-end of a script engine to be stored and executed repeatedly. This benefits applications that execute the same script multiple times. These applications can gain efficiency since the engines' front-ends only need to execute once per script rather than once per script execution. Note that this functionality is optional and script engines may choose not to implement it. Callers need to check for availability of the Compilable
interface using an instanceof check.
Invocation: This functionality allows the reuse of intermediate code generated by a script engine's front-end. Whereas Compilation allows entire scripts represented by intermediate code to be re-executed, Invocation functionality allows individual procedures/methods in the scripts to be re-executed. As in the case with compilation, not all script engines are required to provide this facility. Caller has to check for Invocable
availability.
Script engine discovery and Metadata: Applications written to the Scripting API might have specific requirements on script engines. Some may require a specific scripting language and/or version while others may require a specific implementation engine and/or version. Script engines are packaged in a specified way so that engines can be discovered at runtime and queried for attributes. The Engine discovery mechanism is based on the Service discovery mechanism described in the Jar File Specification. Script engine implementing classes are packaged in jar files that include a text resource named META-INF/services/javax.script.ScriptEngineFactory. This resource must include a line for each ScriptEngineFactory
that is packaged in the jar file. ScriptEngineManager
includes getEngineFactories
method to get all ScriptEngineFactory
instances discovered using this mechanism. ScriptEngineFactory
has methods to query attributes about script engine.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.