public interface ScriptContext
ScriptContext methods. ScriptContexts also expose Readers and Writers
that can be used by the ScriptEngines for input and output.| Modifier and Type | Field and Description |
|---|---|
static int |
ENGINE_SCOPE
EngineScope attributes are visible during the lifetime of a single
ScriptEngine and a set of attributes is maintained for each
engine. |
static int |
GLOBAL_SCOPE
GlobalScope attributes are visible to all engines created by same ScriptEngineFactory.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
getAttribute(String name)
Retrieves the value of the attribute with the given name in
the scope occurring earliest in the search order.
|
Object |
getAttribute(String name,
int scope)
Gets the value of an attribute in a given scope.
|
int |
getAttributesScope(String name)
Get the lowest scope in which an attribute is defined.
|
Bindings |
getBindings(int scope)
Gets the
Bindings associated with the given scope in this
ScriptContext. |
Writer |
getErrorWriter()
Returns the
Writer used to display error output. |
Reader |
getReader()
Returns a
Reader to be used by the script to read
input. |
List<Integer> |
getScopes()
Returns immutable
List of all the valid values for
scope in the ScriptContext. |
Writer |
getWriter()
Returns the
Writer for scripts to use when displaying output. |
Object |
removeAttribute(String name,
int scope)
Remove an attribute in a given scope.
|
void |
setAttribute(String name,
Object value,
int scope)
Sets the value of an attribute in a given scope.
|
void |
setBindings(Bindings bindings,
int scope)
Associates a
Bindings instance with a particular scope in this
ScriptContext. |
void |
setErrorWriter(Writer writer)
Sets the
Writer used to display error output. |
void |
setReader(Reader reader)
Sets the
Reader for scripts to read input
. |
void |
setWriter(Writer writer)
Sets the
Writer for scripts to use when displaying output. |
static final int ENGINE_SCOPE
ScriptEngine and a set of attributes is maintained for each
engine.static final int GLOBAL_SCOPE
void setBindings(Bindings bindings, int scope)
Bindings instance with a particular scope in this
ScriptContext. Calls to the getAttribute and
setAttribute methods must map to the get and
put methods of the Bindings for the specified scope.bindings - The Bindings to associate with the given scopescope - The scopeIllegalArgumentException - If no Bindings is defined for the
specified scope value in ScriptContexts of this type.NullPointerException - if value of scope is ENGINE_SCOPE and
the specified Bindings is null.Bindings getBindings(int scope)
Bindings associated with the given scope in this
ScriptContext.scope - The scopeBindings. Returns null if it has not
been set.IllegalArgumentException - If no Bindings is defined for the
specified scope value in ScriptContext of this type.void setAttribute(String name, Object value, int scope)
name - The name of the attribute to setvalue - The value of the attributescope - The scope in which to set the attributeIllegalArgumentException - if the name is empty or if the scope is invalid.NullPointerException - if the name is null.Object getAttribute(String name, int scope)
name - The name of the attribute to retrieve.scope - The scope in which to retrieve the attribute.null is the name
does not exist in the given scope.IllegalArgumentException - if the name is empty or if the value of scope is invalid.NullPointerException - if the name is null.Object removeAttribute(String name, int scope)
name - The name of the attribute to removescope - The scope in which to remove the attributeIllegalArgumentException - if the name is empty or if the scope is invalid.NullPointerException - if the name is null.Object getAttribute(String name)
name - The name of the the attribute to retrieve.NullPointerException - if the name is null.IllegalArgumentException - if the name is empty.int getAttributesScope(String name)
name - Name of the attribute
.NullPointerException - if name is null.IllegalArgumentException - if name is empty.Writer getWriter()
Writer for scripts to use when displaying output.Writer.Writer getErrorWriter()
Writer used to display error output.Writervoid setWriter(Writer writer)
Writer for scripts to use when displaying output.writer - The new Writer.void setErrorWriter(Writer writer)
Writer used to display error output.writer - The Writer.Reader getReader()
Reader to be used by the script to read
input.Reader.void setReader(Reader reader)
Reader for scripts to read input
.reader - The new Reader. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.