< prev index next >

src/share/classes/javax/script/Compilable.java

Print this page
rev 10769 : 8072002: The spec on javax.script.Compilable contains a typo and confusing inconsistency
Reviewed-by: lagergren, attila


  25 
  26 package javax.script;
  27 
  28 import java.util.Map;
  29 import java.io.Reader;
  30 
  31 /**
  32  * The optional interface implemented by ScriptEngines whose methods compile scripts
  33  * to a form that can be executed repeatedly without recompilation.
  34  *
  35  * @author Mike Grogan
  36  * @since 1.6
  37  */
  38 public interface Compilable {
  39     /**
  40      * Compiles the script (source represented as a <code>String</code>) for
  41      * later execution.
  42      *
  43      * @param script The source of the script, represented as a <code>String</code>.
  44      *
  45      * @return An subclass of <code>CompiledScript</code> to be executed later using one
  46      * of the <code>eval</code> methods of <code>CompiledScript</code>.
  47      *
  48      * @throws ScriptException if compilation fails.
  49      * @throws NullPointerException if the argument is null.
  50      *
  51      */
  52 
  53     public CompiledScript compile(String script) throws
  54             ScriptException;
  55 
  56     /**
  57      * Compiles the script (source read from <code>Reader</code>) for
  58      * later execution.  Functionality is identical to
  59      * <code>compile(String)</code> other than the way in which the source is
  60      * passed.
  61      *
  62      * @param script The reader from which the script source is obtained.
  63      *
  64      * @return An implementation of <code>CompiledScript</code> to be executed
  65      * later using one of its <code>eval</code> methods of <code>CompiledScript</code>.
  66      *
  67      * @throws ScriptException if compilation fails.
  68      * @throws NullPointerException if argument is null.
  69      */
  70     public CompiledScript compile(Reader script) throws
  71             ScriptException;
  72 }


  25 
  26 package javax.script;
  27 
  28 import java.util.Map;
  29 import java.io.Reader;
  30 
  31 /**
  32  * The optional interface implemented by ScriptEngines whose methods compile scripts
  33  * to a form that can be executed repeatedly without recompilation.
  34  *
  35  * @author Mike Grogan
  36  * @since 1.6
  37  */
  38 public interface Compilable {
  39     /**
  40      * Compiles the script (source represented as a <code>String</code>) for
  41      * later execution.
  42      *
  43      * @param script The source of the script, represented as a <code>String</code>.
  44      *
  45      * @return An instance of a subclass of <code>CompiledScript</code> to be executed later using one
  46      * of the <code>eval</code> methods of <code>CompiledScript</code>.
  47      *
  48      * @throws ScriptException if compilation fails.
  49      * @throws NullPointerException if the argument is null.
  50      *
  51      */
  52 
  53     public CompiledScript compile(String script) throws
  54             ScriptException;
  55 
  56     /**
  57      * Compiles the script (source read from <code>Reader</code>) for
  58      * later execution.  Functionality is identical to
  59      * <code>compile(String)</code> other than the way in which the source is
  60      * passed.
  61      *
  62      * @param script The reader from which the script source is obtained.
  63      *
  64      * @return An instance of a subclass of <code>CompiledScript</code> to be executed
  65      * later using one of its <code>eval</code> methods of <code>CompiledScript</code>.
  66      *
  67      * @throws ScriptException if compilation fails.
  68      * @throws NullPointerException if argument is null.
  69      */
  70     public CompiledScript compile(Reader script) throws
  71             ScriptException;
  72 }
< prev index next >