org.forgerock.script

Interface Scope

All Known Subinterfaces:

Script, ScriptEntry

public interface Scope

A NAME does ...

Method Summary

Modifier and Type	Method and Description
Bindings	createBindings() Returns an uninitialized Bindings.
void	flush()
Object	get(String key) Retrieves a value set in the state of this engine.
Bindings	getBindings() Returns a scope of named values.
void	put(String key, Object value) Sets a key/value pair in the state of the ScriptEngine that may either create a Java Language Binding to be used in the execution of scripts or be used in some other way, depending on whether the key is reserved.
void	setBindings(Bindings bindings) Sets a scope of named values to be used by scripts.

Method Detail

put

void put(String key,
         Object value)

Sets a key/value pair in the state of the ScriptEngine that may either create a Java Language Binding to be used in the execution of scripts or be used in some other way, depending on whether the key is reserved. Must have the same effect as getBindings(ScriptContext.ENGINE_SCOPE).put.

Parameters:

key - The name of named value to add

value - The value of named value to add.

Throws:

NullPointerException - if key is null.

IllegalArgumentException - if key is empty.

get

Object get(String key)

Retrieves a value set in the state of this engine. The value might be one which was set using setValue or some other value in the state of the ScriptEngine, depending on the implementation. Must have the same effect as getBindings(ScriptContext.ENGINE_SCOPE).get

Parameters:

key - The key whose value is to be returned

Returns:

the value for the given key

Throws:

NullPointerException - if key is null.

IllegalArgumentException - if key is empty.

getBindings

Bindings getBindings()

Returns a scope of named values. The possible scopes are:

• ScriptContext.GLOBAL_SCOPE - The set of named values representing global scope. If this ScriptEngine is created by a ScriptEngineManager, then the manager sets global scope bindings. This may be null if no global scope is associated with this ScriptEngine
• ScriptContext.ENGINE_SCOPE - The set of named values representing the state of this ScriptEngine. The values are generally visible in scripts using the associated keys as variable names.
• Any other value of scope defined in the default ScriptContext of the ScriptEngine.

The Bindings instances that are returned must be identical to those returned by the getBindings method of ScriptContext called with corresponding arguments on the default ScriptContext of the ScriptEngine.

Returns:

The Bindings with the specified scope.

Throws:

IllegalArgumentException - if specified scope is invalid

setBindings

void setBindings(Bindings bindings)

Sets a scope of named values to be used by scripts. The possible scopes are:

• ScriptContext.ENGINE_SCOPE - The specified Bindings replaces the engine scope of the ScriptEngine.
• ScriptContext.GLOBAL_SCOPE - The specified Bindings must be visible as the GLOBAL_SCOPE.
• Any other value of scope defined in the default ScriptContext of the ScriptEngine.

The method must have the same effect as calling the setBindings method of ScriptContext with the corresponding value of scope on the default ScriptContext of the ScriptEngine.

Parameters:

bindings - The Bindings for the specified scope.

Throws:

IllegalArgumentException - if the scope is invalid

NullPointerException - if the bindings is null and the scope is ScriptContext.ENGINE_SCOPE

flush

void flush()

createBindings

Bindings createBindings()

Returns an uninitialized Bindings.

Returns:

A Bindings that can be used to replace the state of this ScriptEngine.