|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScriptContext
The ScriptContext interface exposes the key-value pairs in various scopes.
Field Summary | |
---|---|
static int |
ENGINE_SCOPE
defines an integer for the level of scope, ENGINE_SCOPE |
static int |
GLOBAL_SCOPE
defines an integer for the level of scope, GLOBAL_SCOPE |
Method Summary | |
---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Retrieves the value of the getAttribute(String, int) for the lowest scope in which it returns a non-null value. |
java.lang.Object |
getAttribute(java.lang.String name,
int scope)
Retrieves the value of an attribute in the specified scope. |
int |
getAttributesScope(java.lang.String name)
Retrieves the lowest value of the scope for which the attribute is defined. |
Bindings |
getBindings(int scope)
Retrieves the Namespace instance associated with the gieve scope. |
java.io.Writer |
getErrorWriter()
Returns the Writer used to display error output. |
java.io.Reader |
getReader()
Returns a Reader to be used by the script to read
input. |
java.util.List |
getScopes()
Returns immutable List of all the valid values for
scope in the ScriptContext. |
java.io.Writer |
getWriter()
Returns the Writer for scripts to use when displaying output. |
java.lang.Object |
removeAttribute(java.lang.String name,
int scope)
Removes the given attribute form the specified scope. |
void |
setAttribute(java.lang.String key,
java.lang.Object value,
int scope)
Associates a specified value with the specifed name in the specified scope. |
void |
setBindings(Bindings namespace,
int scope)
Associates the specified namespace with the specified scope. |
void |
setErrorWriter(java.io.Writer writer)
Sets the Writer used to display error output. |
void |
setReader(java.io.Reader reader)
Sets the Reader for scripts to read input
. |
void |
setWriter(java.io.Writer writer)
Sets the Writer for scripts to use when displaying output. |
Field Detail |
---|
static final int ENGINE_SCOPE
static final int GLOBAL_SCOPE
Method Detail |
---|
java.lang.Object getAttribute(java.lang.String name) throws java.lang.IllegalArgumentException
name
- the name of the attribute
java.lang.IllegalArgumentException
- if the name is nulljava.lang.Object getAttribute(java.lang.String name, int scope) throws java.lang.IllegalArgumentException
name
- the name of the attributescope
- the value of the scope
java.lang.IllegalArgumentException
- if the name is null or the
scope is invalidint getAttributesScope(java.lang.String name)
name
- the name of attribute
Bindings getBindings(int scope)
scope
- the level of the scope
java.lang.Object removeAttribute(java.lang.String name, int scope) throws java.lang.IllegalArgumentException
name
- the name of the attributescope
- the level of scope which inherit the attribute
java.lang.IllegalArgumentException
- if the name is null or if the
scope is invalidvoid setAttribute(java.lang.String key, java.lang.Object value, int scope) throws java.lang.IllegalArgumentException
key
- the name of the attributevalue
- the value of the attributescope
- the level of the scope
java.lang.IllegalArgumentException
- if the name is null or the
scope is invalidvoid setBindings(Bindings namespace, int scope) throws java.lang.IllegalArgumentException
namespace
- the namespace to be associated with the
specified level of scopescope
- the specified level of scope
java.lang.IllegalArgumentException
- if the scope is invalidjava.io.Writer getWriter()
Writer
for scripts to use when displaying output.
Writer
.java.io.Writer getErrorWriter()
Writer
used to display error output.
Writer
void setWriter(java.io.Writer writer)
Writer
for scripts to use when displaying output.
writer
- The new Writer
.void setErrorWriter(java.io.Writer writer)
Writer
used to display error output.
writer
- The Writer
.java.io.Reader getReader()
Reader
to be used by the script to read
input.
Reader
.void setReader(java.io.Reader reader)
Reader
for scripts to read input
.
reader
- The new Reader
.java.util.List getScopes()
List
of all the valid values for
scope in the ScriptContext.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |