java.lang.Object
javax.script.ScriptEngineManager
The
The
ScriptEngineManager implements a discovery and instantiation
mechanism for ScriptEngine classes and also maintains a
collection of key/value pairs storing state shared by all engines created
by the Manager. This class uses the service provider mechanism described in the
ServiceLoader class to enumerate all the
implementations of ScriptEngineFactory. The
ScriptEngineManager provides a method to return a list of all these factories
as well as utility methods which look up factories on the basis of language name, file extension
and mime type.
The Bindings of key/value pairs, referred to as the "Global Scope" maintained
by the manager is available to all instances of ScriptEngine created
by the ScriptEngineManager. The values in the Bindings are
generally exposed in all scripts.
- Since:
- 1.6
-
Constructor Summary
ConstructorsConstructorDescriptionThe effect of calling this constructor is the same as callingScriptEngineManager(Thread.currentThread().getContextClassLoader()).ScriptEngineManager(ClassLoader loader) This constructor loads the implementations ofScriptEngineFactoryvisible to the givenClassLoaderusing the service provider mechanism.
If loader isnull, the script engine factories that are bundled with the platform are loaded. -
Method Summary
Modifier and TypeMethodDescriptionGets the value for the specified key in the Global ScopegetBindingsreturns the value of theglobalScopefield.getEngineByExtension(String extension) Look up and create aScriptEnginefor a given extension.getEngineByMimeType(String mimeType) Look up and create aScriptEnginefor a given mime type.getEngineByName(String shortName) Looks up and creates aScriptEnginefor a given name.Returns a list whose elements are instances of all theScriptEngineFactoryclasses found by the discovery mechanism.voidSets the specified key/value pair in the Global Scope.voidregisterEngineExtension(String extension, ScriptEngineFactory factory) Registers aScriptEngineFactoryto handle an extension.voidregisterEngineMimeType(String type, ScriptEngineFactory factory) Registers aScriptEngineFactoryto handle a mime type.voidregisterEngineName(String name, ScriptEngineFactory factory) Registers aScriptEngineFactoryto handle a language name.voidsetBindings(Bindings bindings) setBindingsstores the specifiedBindingsin theglobalScopefield.
-
Constructor Details
-
ScriptEngineManager
public ScriptEngineManager()The effect of calling this constructor is the same as callingScriptEngineManager(Thread.currentThread().getContextClassLoader()).- See Also:
-
ScriptEngineManager
This constructor loads the implementations ofScriptEngineFactoryvisible to the givenClassLoaderusing the service provider mechanism.
If loader isnull, the script engine factories that are bundled with the platform are loaded.- Parameters:
loader- ClassLoader used to discover script engine factories.
-
-
Method Details
-
setBindings
setBindingsstores the specifiedBindingsin theglobalScopefield. ScriptEngineManager sets thisBindingsas global bindings forScriptEngineobjects created by it.- Parameters:
bindings- The specifiedBindings- Throws:
IllegalArgumentException- if bindings is null.
-
getBindings
getBindingsreturns the value of theglobalScopefield. ScriptEngineManager sets thisBindingsas global bindings forScriptEngineobjects created by it.- Returns:
- The globalScope field.
-
put
Sets the specified key/value pair in the Global Scope.- Parameters:
key- Key to setvalue- Value to set.- Throws:
NullPointerException- if key is null.IllegalArgumentException- if key is empty string.
-
get
Gets the value for the specified key in the Global Scope- Parameters:
key- The key whose value is to be returned.- Returns:
- The value for the specified key.
-
getEngineByName
Looks up and creates aScriptEnginefor a given name. The algorithm first searches for aScriptEngineFactorythat has been registered as a handler for the specified name using theregisterEngineNamemethod.
If one is not found, it searches the set ofScriptEngineFactoryinstances stored by the constructor for one with the specified name. If aScriptEngineFactoryis found by either method, it is used to create instance ofScriptEngine.- Parameters:
shortName- The short name of theScriptEngineimplementation. returned by thegetNamesmethod of itsScriptEngineFactory.- Returns:
- A
ScriptEnginecreated by the factory located in the search. Returns null if no such factory was found. TheScriptEngineManagersets its ownglobalScopeBindingsas theGLOBAL_SCOPEBindingsof the newly createdScriptEngine. - Throws:
NullPointerException- if shortName is null.
-
getEngineByExtension
Look up and create aScriptEnginefor a given extension. The algorithm used bygetEngineByNameis used except that the search starts by looking for aScriptEngineFactoryregistered to handle the given extension usingregisterEngineExtension.- Parameters:
extension- The given extension- Returns:
- The engine to handle scripts with this extension. Returns
nullif not found. - Throws:
NullPointerException- if extension is null.
-
getEngineByMimeType
Look up and create aScriptEnginefor a given mime type. The algorithm used bygetEngineByNameis used except that the search starts by looking for aScriptEngineFactoryregistered to handle the given mime type usingregisterEngineMimeType.- Parameters:
mimeType- The given mime type- Returns:
- The engine to handle scripts with this mime type. Returns
nullif not found. - Throws:
NullPointerException- if mimeType is null.
-
getEngineFactories
Returns a list whose elements are instances of all theScriptEngineFactoryclasses found by the discovery mechanism.- Returns:
- List of all discovered
ScriptEngineFactorys.
-
registerEngineName
Registers aScriptEngineFactoryto handle a language name. Overrides any such association found using the Discovery mechanism.- Parameters:
name- The name to be associated with theScriptEngineFactory.factory- The class to associate with the given name.- Throws:
NullPointerException- if any of the parameters is null.
-
registerEngineMimeType
Registers aScriptEngineFactoryto handle a mime type. Overrides any such association found using the Discovery mechanism.- Parameters:
type- The mime type to be associated with theScriptEngineFactory.factory- The class to associate with the given mime type.- Throws:
NullPointerException- if any of the parameters is null.
-
registerEngineExtension
Registers aScriptEngineFactoryto handle an extension. Overrides any such association found using the Discovery mechanism.- Parameters:
extension- The extension type to be associated with theScriptEngineFactory.factory- The class to associate with the given extension.- Throws:
NullPointerException- if any of the parameters is null.
-