Interface ScriptContext

engine/javax-src/javax/script/ScriptContext.java:24–185

The interface whose implementing classes are used to connect Script Engines with objects, such as scoped Bindings, in hosting applications. Each scope is a set of named attributes whose values can be set and retrieved using the ScriptContext methods. ScriptContexts also expose Readers

 * @since 1.6
 */
public interface ScriptContext {
    
    
    /**
     * EngineScope attributes are visible during the lifetime of a single
     * <code>ScriptEngine</code> and a set of attributes is maintained for each
     * engine.
     */
    public static final int ENGINE_SCOPE = 100;
    
    /**
     * GlobalScope attributes are visible to all engines created by same ScriptEngineFactory.
     */
    public static final int GLOBAL_SCOPE = 200;
    
    
    /**
     * Associates a <code>Bindings</code> instance with a particular scope in this
     * <code>ScriptContext</code>.  Calls to the <code>getAttribute</code> and
     * <code>setAttribute</code> methods must map to the <code>put</code> and
     * <code>get</code> methods of the <code>Bindings</code> for the specified scope.
     *
     * @param  bindings The <code>Bindings</code> to associate with the given scope
     * @param scope The scope
     *
     * @throws <code>IllegalArgumentException</code> If no <code>Bindings</code> is defined for the
     * specified scope value in ScriptContexts of this type.
     * @throws <code>NullPointerException</code> if value of scope is <code>ENGINE_SCOPE</code> and
     * the specified <code>Bindings</code> is null.
     *
     */
    public void setBindings(Bindings bindings, int scope);
    
    /**
     * Gets the <code>Bindings</code>  associated with the given scope in this
     * <code>ScriptContext</code>.
     *
     * @return The associated <code>Bindings</code>.  Returns <code>null</code> if it has not
     * been set.
     *
     * @throws IllegalArgumentException If no <code>Bindings</code> is defined for the
     * specified scope value in <code>ScriptContext</code> of this type.
     */
    public Bindings getBindings(int scope);
    
    /**
     * Sets the value of an attribute in a given scope.
     *
     * @param name The name of the attribute to set.
     * @param scope The scope in which to set the attribute
     *
     * @throws <code>IllegalArgumentException</code> if the scope
     * is invalid.
     * @throws <code>NullPointerException</code> if the name is null.
     * @throws <code>ClassCastException</code> if the name is not a String.
     */
    public void setAttribute(String name, Object value, int scope);