1 /*

     2  * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    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 }