/*
 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.script;

import java.util.Map;
import java.io.Reader;

The optional interface implemented by ScriptEngines whose methods compile scripts to a form that can be executed repeatedly without recompilation.
Author:Mike Grogan
Since:1.6
/** * The optional interface implemented by ScriptEngines whose methods compile scripts * to a form that can be executed repeatedly without recompilation. * * @author Mike Grogan * @since 1.6 */
public interface Compilable {
Compiles the script (source represented as a String) for later execution.
Params:
  • script – The source of the script, represented as a String.
Throws:
Returns:An subclass of CompiledScript to be executed later using one of the eval methods of CompiledScript.
/** * Compiles the script (source represented as a <code>String</code>) for * later execution. * * @param script The source of the script, represented as a <code>String</code>. * * @return An subclass of <code>CompiledScript</code> to be executed later using one * of the <code>eval</code> methods of <code>CompiledScript</code>. * * @throws ScriptException if compilation fails. * @throws NullPointerException if the argument is null. * */
public CompiledScript compile(String script) throws ScriptException;
Compiles the script (source read from Reader) for later execution. Functionality is identical to compile(String) other than the way in which the source is passed.
Params:
  • script – The reader from which the script source is obtained.
Throws:
Returns:An implementation of CompiledScript to be executed later using one of its eval methods of CompiledScript.
/** * Compiles the script (source read from <code>Reader</code>) for * later execution. Functionality is identical to * <code>compile(String)</code> other than the way in which the source is * passed. * * @param script The reader from which the script source is obtained. * * @return An implementation of <code>CompiledScript</code> to be executed * later using one of its <code>eval</code> methods of <code>CompiledScript</code>. * * @throws ScriptException if compilation fails. * @throws NullPointerException if argument is null. */
public CompiledScript compile(Reader script) throws ScriptException; }