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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
/* * @(#)AbstractScriptEngine.java 1.5 06/06/19 20:54:01 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTAIL. Use is subject to license terms. */ package javax.script; import java.io.Reader; import java.util.Map; import java.util.Iterator; /** * Provides a standard implementation for several of the variants of the <code>eval</code> * method. * <br><br> * <code><b>eval(Reader)</b></code><p><code><b>eval(String)</b></code><p> * <code><b>eval(String, Bindings)</b></code><p><code><b>eval(Reader, Bindings)</b></code> * <br><br> are implemented using the abstract methods * <br><br> * <code><b>eval(Reader,ScriptContext)</b></code> or * <code><b>eval(String, ScriptContext)</b></code> * <br><br> * with a <code>SimpleScriptContext</code>. * <br><br> * A <code>SimpleScriptContext</code> is used as the default <code>ScriptContext</code> * of the <code>AbstractScriptEngine</code>.. * * @author Mike Grogan * @version 1.0 * @since 1.6 */ public abstract class AbstractScriptEngine implements ScriptEngine { /** * The default <code>ScriptContext</code> of this <code>AbstractScriptEngine</code>. */ protected ScriptContext context; /** * Creates a new instance of AbstractScriptEngine using a <code>SimpleScriptContext</code> * as its default <code>ScriptContext</code>. */ public AbstractScriptEngine() { context = new SimpleScriptContext(); } /** * Creates a new instance using the specified <code>Bindings</code> as the * <code>ENGINE_SCOPE</code> <code>Bindings</code> in the protected <code>context</code> field. * * @param n The specified <code>Bindings</code>. * @throws NullPointerException if n is null. */ public AbstractScriptEngine(Bindings n) { this(); if (n == null) { throw new NullPointerException("n is null"); } context.setBindings(n, ScriptContext.ENGINE_SCOPE); } /** * Sets the value of the protected <code>context</code> field to the specified * <code>ScriptContext</code>. * * @param ctxt The specified <code>ScriptContext</code>. * @throws NullPointerException if ctxt is null. */ public void setContext(ScriptContext ctxt) { if (ctxt == null) { throw new NullPointerException("null context"); } context = ctxt; } /** * Returns the value of the protected <code>context</code> field. * * @return The value of the protected <code>context</code> field. */ public ScriptContext getContext() { return context; } /** * Returns the <code>Bindings</code> with the specified scope value in * the protected <code>context</code> field. * * @param scope The specified scope * * @return The corresponding <code>Bindings</code>. * * @throws IllegalArgumentException if the value of scope is * invalid for the type the protected <code>context</code> field. */ public Bindings getBindings(int scope) { if (scope == ScriptContext.GLOBAL_SCOPE) { return context.getBindings(ScriptContext.GLOBAL_SCOPE); } else if (scope == ScriptContext.ENGINE_SCOPE) { return context.getBindings(ScriptContext.ENGINE_SCOPE); } else { throw new IllegalArgumentException("Invalid scope value."); } } /** * Sets the <code>Bindings</code> with the corresponding scope value in the * <code>context</code> field. * * @param bindings The specified <code>Bindings</code>. * @param scope The specified scope. * * @throws IllegalArgumentException if the value of scope is * invalid for the type the <code>context</code> field. * @throws NullPointerException if the bindings is null and the scope is * <code>ScriptContext.ENGINE_SCOPE</code> */ public void setBindings(Bindings bindings, int scope) { if (scope == ScriptContext.GLOBAL_SCOPE) { context.setBindings(bindings, ScriptContext.GLOBAL_SCOPE);; } else if (scope == ScriptContext.ENGINE_SCOPE) { context.setBindings(bindings, ScriptContext.ENGINE_SCOPE);; } else { throw new IllegalArgumentException("Invalid scope value."); } } /** * Sets the specified value with the specified key in the <code>ENGINE_SCOPE</code> * <code>Bindings</code> of the protected <code>context</code> field. * * @param key The specified key. * @param value The specified value. * * @throws NullPointerException if key is null. * @throws IllegalArgumentException if key is empty. */ public void put(String key, Object value) { Bindings nn = getBindings(ScriptContext.ENGINE_SCOPE); if (nn != null) { nn.put(key, value); } } /** * Gets the value for the specified key in the <code>ENGINE_SCOPE</code> of the * protected <code>context</code> field. * * @return The value for the specified key. * * @throws NullPointerException if key is null. * @throws IllegalArgumentException if key is empty. */ public Object get(String key) { Bindings nn = getBindings(ScriptContext.ENGINE_SCOPE); if (nn != null) { return nn.get(key); } return null; } /** * <code>eval(Reader, Bindings)</code> calls the abstract * <code>eval(Reader, ScriptContext)</code> method, passing it a <code>ScriptContext</code> * whose Reader, Writers and Bindings for scopes other that <code>ENGINE_SCOPE</code> * are identical to those members of the protected <code>context</code> field. The specified * <code>Bindings</code> is used instead of the <code>ENGINE_SCOPE</code> * * <code>Bindings</code> of the <code>context</code> field. * * @param reader A <code>Reader</code> containing the source of the script. * @param bindings A <code>Bindings</code> to use for the <code>ENGINE_SCOPE</code> * while the script executes. * * @return The return value from <code>eval(Reader, ScriptContext)</code> * @throws ScriptException if an error occurs in script. * @throws NullPointerException if any of the parameters is null. */ public Object eval(Reader reader, Bindings bindings ) throws ScriptException { ScriptContext ctxt = getScriptContext(bindings); return eval(reader, ctxt); } /** * Same as <code>eval(Reader, Bindings)</code> except that the abstract * <code>eval(String, ScriptContext)</code> is used. * * @param script A <code>String</code> containing the source of the script. * * @param bindings A <code>Bindings</code> to use as the <code>ENGINE_SCOPE</code> * while the script executes. * * @return The return value from <code>eval(String, ScriptContext)</code> * @throws ScriptException if an error occurs in script. * @throws NullPointerException if any of the parameters is null. */ public Object eval(String script, Bindings bindings) throws ScriptException { ScriptContext ctxt = getScriptContext(bindings); return eval(script , ctxt); } /** * <code>eval(Reader)</code> calls the abstract * <code>eval(Reader, ScriptContext)</code> passing the value of the <code>context</code> * field. * * @param reader A <code>Reader</code> containing the source of the script. * @return The return value from <code>eval(Reader, ScriptContext)</code> * @throws ScriptException if an error occurs in script. * @throws NullPointerException if any of the parameters is null. */ public Object eval(Reader reader) throws ScriptException { return eval(reader, context); } /** * Same as <code>eval(Reader)</code> except that the abstract * <code>eval(String, ScriptContext)</code> is used. * * @param script A <code>String</code> containing the source of the script. * @return The return value from <code>eval(String, ScriptContext)</code> * @throws ScriptException if an error occurrs in script. * @throws NullPointerException if any of the parameters is null. */ public Object eval(String script) throws ScriptException { return eval(script, context); } /** * Returns a <code>SimpleScriptContext</code>. The <code>SimpleScriptContext</code>: *<br><br> * <ul> * <li>Uses the specified <code>Bindings</code> for its <code>ENGINE_SCOPE</code> * </li> * <li>Uses the <code>Bindings</code> returned by the abstract <code>getGlobalScope</code> * method as its <code>GLOBAL_SCOPE</code> * </li> * <li>Uses the Reader and Writer in the default <code>ScriptContext</code> of this * <code>ScriptEngine</code> * </li> * </ul> * <br><br> * A <code>SimpleScriptContext</code> returned by this method is used to implement eval methods * using the abstract <code>eval(Reader,Bindings)</code> and <code>eval(String,Bindings)</code> * versions. * * @param nn Bindings to use for the <code>ENGINE_SCOPE</code> * @return The <code>SimpleScriptContext</code> */ protected ScriptContext getScriptContext(Bindings nn) { SimpleScriptContext ctxt = new SimpleScriptContext(); Bindings gs = getBindings(ScriptContext.GLOBAL_SCOPE); if (gs != null) { ctxt.setBindings(gs, ScriptContext.GLOBAL_SCOPE); } if (nn != null) { ctxt.setBindings(nn, ScriptContext.ENGINE_SCOPE); } else { throw new NullPointerException("Engine scope Bindings may not be null."); } ctxt.setReader(context.getReader()); ctxt.setWriter(context.getWriter()); ctxt.setErrorWriter(context.getErrorWriter()); return ctxt; } }