1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
/* * @(#)ScriptContext.java 1.4 05/11/17 14:24:13 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTAIL. Use is subject to license terms. */ package javax.script; import java.util.List; import java.io.Writer; import java.io.Reader; /** * 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 * <code>ScriptContext</code> methods. ScriptContexts also expose Readers and Writers * that can be used by the ScriptEngines for input and output. * * @author Mike Grogan * @version 1.0 * @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>get</code> and * <code>put</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 IllegalArgumentException If no <code>Bindings</code> is defined for the * specified scope value in ScriptContexts of this type. * @throws NullPointerException 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 value The value of the attribute * @param scope The scope in which to set the attribute * * @throws IllegalArgumentException * if the name is empty or if the scope is invalid. * @throws NullPointerException if the name is null. */ public void setAttribute(String name, Object value, int scope); /** * Gets the value of an attribute in a given scope. * * @param name The name of the attribute to retrieve. * @param scope The scope in which to retrieve the attribute. * @return The value of the attribute. Returns <code>null</code> is the name * does not exist in the given scope. * * @throws IllegalArgumentException * if the name is empty or if the value of scope is invalid. * @throws NullPointerException if the name is null. */ public Object getAttribute(String name, int scope); /** * Remove an attribute in a given scope. * * @param name The name of the attribute to remove * @param scope The scope in which to remove the attribute * * @return The removed value. * @throws IllegalArgumentException * if the name is empty or if the scope is invalid. * @throws NullPointerException if the name is null. */ public Object removeAttribute(String name, int scope); /** * Retrieves the value of the attribute with the given name in * the scope occurring earliest in the search order. The order * is determined by the numeric value of the scope parameter (lowest * scope values first.) * * @param name The name of the the attribute to retrieve. * @return The value of the attribute in the lowest scope for * which an attribute with the given name is defined. Returns * null if no attribute with the name exists in any scope. * @throws NullPointerException if the name is null. * @throws IllegalArgumentException if the name is empty. */ public Object getAttribute(String name); /** * Get the lowest scope in which an attribute is defined. * @param name Name of the attribute * . * @return The lowest scope. Returns -1 if no attribute with the given * name is defined in any scope. * @throws NullPointerException if name is null. * @throws IllegalArgumentException if name is empty. */ public int getAttributesScope(String name); /** * Returns the <code>Writer</code> for scripts to use when displaying output. * * @return The <code>Writer</code>. */ public Writer getWriter(); /** * Returns the <code>Writer</code> used to display error output. * * @return The <code>Writer</code> */ public Writer getErrorWriter(); /** * Sets the <code>Writer</code> for scripts to use when displaying output. * * @param writer The new <code>Writer</code>. */ public void setWriter(Writer writer); /** * Sets the <code>Writer</code> used to display error output. * * @param writer The <code>Writer</code>. */ public void setErrorWriter(Writer writer); /** * Returns a <code>Reader</code> to be used by the script to read * input. * * @return The <code>Reader</code>. */ public Reader getReader(); /** * Sets the <code>Reader</code> for scripts to read input * . * @param reader The new <code>Reader</code>. */ public void setReader(Reader reader); /** * Returns immutable <code>List</code> of all the valid values for * scope in the ScriptContext. * * @return list of scope values */ public List<Integer> getScopes(); }