org.codehaus.commons.compiler.jdk
Class ScriptEvaluator

java.lang.Object
  org.codehaus.commons.compiler.Cookable
      org.codehaus.commons.compiler.jdk.SimpleCompiler
          org.codehaus.commons.compiler.jdk.ClassBodyEvaluator
              org.codehaus.commons.compiler.jdk.ScriptEvaluator

All Implemented Interfaces:

IClassBodyEvaluator, ICookable, IScriptEvaluator, ISimpleCompiler

Direct Known Subclasses:

ExpressionEvaluator

public class ScriptEvaluator
extends ClassBodyEvaluator
implements IScriptEvaluator

To set up a ScriptEvaluator object, proceed as described for IScriptEvaluator. Alternatively, a number of "convenience constructors" exist that execute the described steps instantly.

Alternatively, a number of "convenience constructors" exist that execute the steps described above instantly. Their use is discouraged.

Notice that this implementation of IClassBodyEvaluator is prone to "Java injection", i.e. an application could get more than one class body compiled by passing a bogus input document.

Also notice that the parsing of leading IMPORT declarations is heuristic and has certain limitations; see ClassBodyEvaluator.parseImportDeclarations(Reader).

Field Summary

protected boolean[]	optionalOverrideMethod Whether methods override a method declared by a supertype; null means "none".
protected boolean[]	optionalStaticMethod Whether methods are static; null means "all".

Fields inherited from interface org.codehaus.commons.compiler.IClassBodyEvaluator

DEFAULT_CLASS_NAME

Fields inherited from interface org.codehaus.commons.compiler.ICookable

BOOT_CLASS_LOADER, SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR, SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE

Constructor Summary

ScriptEvaluator()

ScriptEvaluator(String script)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.cook(script);

ScriptEvaluator(String script, Class<?> returnType)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.cook(script);

ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.cook(script);

ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.cook(script);

ScriptEvaluator(String optionalFileName, InputStream is, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader optionalParentClassLoader)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(optionalFileName, is);

ScriptEvaluator(String optionalFileName, Reader reader, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader optionalParentClassLoader)
Equivalent to ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(reader);

Method Summary

void	cook(Reader[] readers) Same as ICookable.cook(Reader), but for multiple scripts.
void	cook(String[] strings) Same as ICookable.cook(String), but for multiple scripts.
void	cook(String[] optionalFileNames, Reader[] readers) Same as ICookable.cook(String, Reader), but cooks a set of scripts into one class.
protected void	cook(String[] optionalFileNames, Reader[] readers, String[] imports)
void	cook(String[] optionalFileNames, String[] strings) Same as ICookable.cook(String, String), but for multiple scripts.
void	cook(String optionalFileName, Reader r) Reads, scans, parses and compiles Java tokens from the given Reader.
Object	createFastEvaluator(Reader r, Class interfaceToImplement, String[] parameterNames) If the parameter and return types of the expression are known at compile time, then a "fast" script evaluator can be instantiated through this method.
Object	createFastEvaluator(String script, Class interfaceToImplement, String[] parameterNames)
Object	createInstance(Reader reader) Don't use.
Object	evaluate(int idx, Object[] arguments) Same as IScriptEvaluator.evaluate(Object[]), but for multiple scripts.
Object	evaluate(Object[] arguments) Calls the script with concrete parameter values.
protected Class<?>	getDefaultReturnType() The default return type of a script is void.
Method	getMethod() Returns the loaded Method.
Method	getMethod(int idx) Same as IScriptEvaluator.getMethod(), but for multiple scripts.
void	setMethodName(String methodName) Define the name of the generated method.
void	setMethodNames(String[] methodNames) Same as IScriptEvaluator.setMethodName(String), but for multiple scripts.
void	setOverrideMethod(boolean overrideMethod) Defines whether the generated method overrides a methods declared in a supertype.
void	setOverrideMethod(boolean[] overrideMethod) Same as IScriptEvaluator.setOverrideMethod(boolean), but for multiple scripts.
void	setParameters(String[][] names, Class[][] types) Same as IScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts.
void	setParameters(String[] names, Class[] types) Define the names and types of the parameters of the generated method.
void	setReturnType(Class returnType) Defines the return type of the generated method.
void	setReturnTypes(Class[] returnTypes) Defines the return types of the generated methods.
void	setStaticMethod(boolean staticMethod) Defines whether the generated method should be STATIC or not.
void	setStaticMethod(boolean[] staticMethod) Same as IScriptEvaluator.setStaticMethod(boolean), but for multiple scripts.
void	setThrownExceptions(Class[] thrownExceptions) Define the exceptions that the generated method may throw.
void	setThrownExceptions(Class[][] thrownExceptions) Same as IScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts.

Methods inherited from class org.codehaus.commons.compiler.jdk.ClassBodyEvaluator

cook, getClazz, parseImportDeclarations, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes

Methods inherited from class org.codehaus.commons.compiler.jdk.SimpleCompiler

assertCooked, assertNotCooked, getClassLoader, setCompileErrorHandler, setDebuggingInformation, setParentClassLoader, setParentClassLoader, setWarningHandler

Methods inherited from class org.codehaus.commons.compiler.Cookable

cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, readString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.commons.compiler.IClassBodyEvaluator

getClazz, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes

Methods inherited from interface org.codehaus.commons.compiler.ICookable

cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, setCompileErrorHandler, setDebuggingInformation, setParentClassLoader, setWarningHandler

Field Detail

optionalOverrideMethod

protected boolean[] optionalOverrideMethod

Whether methods override a method declared by a supertype; null means "none".

optionalStaticMethod

protected boolean[] optionalStaticMethod

Whether methods are static; null means "all".

Constructor Detail

ScriptEvaluator

public ScriptEvaluator(String script)
                throws CompileException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.cook(script);

Throws:

CompileException

See Also:

ScriptEvaluator(), Cookable.cook(String)

ScriptEvaluator

public ScriptEvaluator(String script,
                       Class<?> returnType)
                throws CompileException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.setReturnType(returnType);
 se.cook(script);

Throws:

CompileException

See Also:

ScriptEvaluator(), setReturnType(Class), Cookable.cook(String)

ScriptEvaluator

public ScriptEvaluator(String script,
                       Class<?> returnType,
                       String[] parameterNames,
                       Class<?>[] parameterTypes)
                throws CompileException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.setReturnType(returnType);
 se.setParameters(parameterNames, parameterTypes);
 se.cook(script);

Throws:

CompileException

See Also:

ScriptEvaluator(), setReturnType(Class), setParameters(String[], Class[]), Cookable.cook(String)

ScriptEvaluator

public ScriptEvaluator(String script,
                       Class<?> returnType,
                       String[] parameterNames,
                       Class<?>[] parameterTypes,
                       Class<?>[] thrownExceptions)
                throws CompileException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.setReturnType(returnType);
 se.setParameters(parameterNames, parameterTypes);
 se.setThrownExceptions(thrownExceptions);
 se.cook(script);

Throws:

CompileException

See Also:

ScriptEvaluator(), setReturnType(Class), setParameters(String[], Class[]), setThrownExceptions(Class[]), Cookable.cook(String)

ScriptEvaluator

public ScriptEvaluator(String optionalFileName,
                       InputStream is,
                       Class<?> returnType,
                       String[] parameterNames,
                       Class<?>[] parameterTypes,
                       Class<?>[] thrownExceptions,
                       ClassLoader optionalParentClassLoader)
                throws CompileException,
                       IOException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.setReturnType(returnType);
 se.setParameters(parameterNames, parameterTypes);
 se.setThrownExceptions(thrownExceptions);
 se.setParentClassLoader(optionalParentClassLoader);
 se.cook(optionalFileName, is);

Throws:

CompileException

IOException

See Also:

ScriptEvaluator(), setReturnType(Class), setParameters(String[], Class[]), setThrownExceptions(Class[]), SimpleCompiler.setParentClassLoader(ClassLoader), Cookable.cook(String, InputStream)

ScriptEvaluator

public ScriptEvaluator(String optionalFileName,
                       Reader reader,
                       Class<?> returnType,
                       String[] parameterNames,
                       Class<?>[] parameterTypes,
                       Class<?>[] thrownExceptions,
                       ClassLoader optionalParentClassLoader)
                throws CompileException,
                       IOException

Equivalent to

 ScriptEvaluator se = new ScriptEvaluator();
 se.setReturnType(returnType);
 se.setParameters(parameterNames, parameterTypes);
 se.setThrownExceptions(thrownExceptions);
 se.setParentClassLoader(optionalParentClassLoader);
 se.cook(reader);

Throws:

CompileException

IOException

See Also:

ScriptEvaluator(), setReturnType(Class), setParameters(String[], Class[]), setThrownExceptions(Class[]), SimpleCompiler.setParentClassLoader(ClassLoader), Cookable.cook(String, Reader)

ScriptEvaluator

public ScriptEvaluator()

Method Detail

setOverrideMethod

public void setOverrideMethod(boolean overrideMethod)

Description copied from interface: IScriptEvaluator

Defines whether the generated method overrides a methods declared in a supertype.

Specified by:

setOverrideMethod in interface IScriptEvaluator

setStaticMethod

public void setStaticMethod(boolean staticMethod)

Description copied from interface: IScriptEvaluator

Defines whether the generated method should be STATIC or not. Defaults to true.

Specified by:

setStaticMethod in interface IScriptEvaluator

setReturnType

public void setReturnType(Class returnType)

Description copied from interface: IScriptEvaluator

Defines the return type of the generated method. The meaning of a null value is implementation-dependent.

Specified by:

setReturnType in interface IScriptEvaluator

setMethodName

public void setMethodName(String methodName)

Description copied from interface: IScriptEvaluator

Define the name of the generated method. Defaults to an unspecified name.

Specified by:

setMethodName in interface IScriptEvaluator

setParameters

public void setParameters(String[] names,
                          Class[] types)

Description copied from interface: IScriptEvaluator

Define the names and types of the parameters of the generated method.

names and types must have the same number of elements.

The parameters can be of primitive type, e.g. double.class.

The default is to have zero parameters.

Specified by:

setParameters in interface IScriptEvaluator

setThrownExceptions

public void setThrownExceptions(Class[] thrownExceptions)

Description copied from interface: IScriptEvaluator

Define the exceptions that the generated method may throw.

Specified by:

setThrownExceptions in interface IScriptEvaluator

cook

public void cook(String optionalFileName,
                 Reader r)
          throws CompileException,
                 IOException

Description copied from interface: ICookable

Reads, scans, parses and compiles Java tokens from the given Reader.

Specified by:

cook in interface ICookable

Overrides:

cook in class ClassBodyEvaluator

Parameters:

optionalFileName - Used when reporting errors and warnings.

Throws:

CompileException

IOException

See Also:

ICookable.cook(String, Reader)

evaluate

public Object evaluate(Object[] arguments)
                throws InvocationTargetException

Description copied from interface: IScriptEvaluator

Calls the script with concrete parameter values.

Each argument must have the same type as specified through the parameterTypes parameter of IScriptEvaluator.setParameters(String[], Class[]).

Arguments of primitive type must passed with their wrapper class objects.

The object returned has the class as specified through IScriptEvaluator.setReturnType(Class).

This method is thread-safe.

Specified by:

evaluate in interface IScriptEvaluator

Parameters:

arguments - The actual parameter values

Throws:

InvocationTargetException

getMethod

public Method getMethod()

Description copied from interface: IScriptEvaluator

Returns the loaded Method.

This method must only be called after exactly one of the ICookable.cook(String, Reader) methods was called.

Specified by:

getMethod in interface IScriptEvaluator

setOverrideMethod

public void setOverrideMethod(boolean[] overrideMethod)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.setOverrideMethod(boolean), but for multiple scripts.

Specified by:

setOverrideMethod in interface IScriptEvaluator

setStaticMethod

public void setStaticMethod(boolean[] staticMethod)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.setStaticMethod(boolean), but for multiple scripts.

Specified by:

setStaticMethod in interface IScriptEvaluator

setReturnTypes

public void setReturnTypes(Class[] returnTypes)

Description copied from interface: IScriptEvaluator

Defines the return types of the generated methods. The meaning of null elements is implementation-dependent.

Specified by:

setReturnTypes in interface IScriptEvaluator

setMethodNames

public void setMethodNames(String[] methodNames)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.setMethodName(String), but for multiple scripts.

Define the names of the generated methods. By default the methods have distinct and implementation-specific names.

If two scripts have the same name, then they must have different parameter types (see IScriptEvaluator.setParameters(String[][], Class[][])).

Specified by:

setMethodNames in interface IScriptEvaluator

setParameters

public void setParameters(String[][] names,
                          Class[][] types)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts.

Specified by:

setParameters in interface IScriptEvaluator

setThrownExceptions

public void setThrownExceptions(Class[][] thrownExceptions)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts.

Specified by:

setThrownExceptions in interface IScriptEvaluator

cook

public final void cook(Reader[] readers)
                throws CompileException,
                       IOException

Description copied from interface: IScriptEvaluator

Same as ICookable.cook(Reader), but for multiple scripts.

Specified by:

cook in interface IScriptEvaluator

Throws:

CompileException

IOException

cook

public void cook(String[] optionalFileNames,
                 Reader[] readers)
          throws CompileException,
                 IOException

Description copied from interface: IScriptEvaluator

Same as ICookable.cook(String, Reader), but cooks a set of scripts into one class. Notice that if any of the scripts causes trouble, the entire compilation will fail. If you need to report which of the scripts causes the exception, you may want to use the optionalFileNames parameter to distinguish between the individual token sources.

If and only if the number of scanners is one, then that single script may contain leading IMPORT directives.

Specified by:

cook in interface IScriptEvaluator

Throws:

CompileException

IOException

cook

public final void cook(String[] strings)
                throws CompileException

Description copied from interface: IScriptEvaluator

Same as ICookable.cook(String), but for multiple scripts.

Specified by:

cook in interface IScriptEvaluator

Throws:

CompileException

cook

public void cook(String[] optionalFileNames,
                 String[] strings)
          throws CompileException

Description copied from interface: IScriptEvaluator

Same as ICookable.cook(String, String), but for multiple scripts.

Specified by:

cook in interface IScriptEvaluator

Throws:

CompileException

cook

protected final void cook(String[] optionalFileNames,
                          Reader[] readers,
                          String[] imports)
                   throws CompileException,
                          IOException

Parameters:

readers - The scripts to cook

Throws:

CompileException

IOException

getDefaultReturnType

protected Class<?> getDefaultReturnType()

The default return type of a script is void.

createFastEvaluator

public Object createFastEvaluator(String script,
                                  Class interfaceToImplement,
                                  String[] parameterNames)
                           throws CompileException

Specified by:

createFastEvaluator in interface IScriptEvaluator

Parameters:

script - Contains the sequence of script tokens

Throws:

CompileException

See Also:

createFastEvaluator(String, Class, String[])

createInstance

public final Object createInstance(Reader reader)

Don't use.

Specified by:

createInstance in interface IClassBodyEvaluator

Overrides:

createInstance in class ClassBodyEvaluator

Parameters:

reader - Source of class body tokens

Returns:

An object that extends the optionalExtendedType and implements the given implementedTypes

createFastEvaluator

public Object createFastEvaluator(Reader r,
                                  Class interfaceToImplement,
                                  String[] parameterNames)
                           throws CompileException,
                                  IOException

Description copied from interface: IScriptEvaluator

If the parameter and return types of the expression are known at compile time, then a "fast" script evaluator can be instantiated through this method.

Script evaluation is faster than through IScriptEvaluator.evaluate(Object[]), because it is not done through reflection but through direct method invocation.

Example:

 public interface Foo {
     int bar(int a, int b);
 }
 ...
 IScriptEvaluator se = CompilerFactoryFactory.getDefaultCompilerFactory().newScriptEvaluator();

 // Optionally configure the SE her:
 se.setClassName("Bar");
 se.setDefaultImports(new String[] { "java.util.*" });
 se.setExtendedClass(SomeOtherClass.class);
 se.setParentClassLoader(someClassLoader);

 Foo f = (Foo) se.createFastScriptEvaluator(
     "return a - b;",
     Foo.class,
     new String[] { "a", "b" }
 );
 System.out.println("1 - 2 = " + f.bar(1, 2));
 

All other configuration (implemented type, static method, return type, method name, parameter names and types, thrown exceptions) are predetermined by the interfaceToImplement. Notice: The interfaceToImplement must either be declared public, or with package scope in the same package as the generated class (see IClassBodyEvaluator.setClassName(String)).

Specified by:

createFastEvaluator in interface IScriptEvaluator

Parameters:

r - Produces the stream of script tokens

interfaceToImplement - Must declare exactly one method

parameterNames - The names of the parameters of that method

Returns:

An object that implements the given interface

Throws:

CompileException

IOException

evaluate

public Object evaluate(int idx,
                       Object[] arguments)
                throws InvocationTargetException

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.evaluate(Object[]), but for multiple scripts.

Specified by:

evaluate in interface IScriptEvaluator

Throws:

InvocationTargetException

getMethod

public Method getMethod(int idx)

Description copied from interface: IScriptEvaluator

Same as IScriptEvaluator.getMethod(), but for multiple scripts.

Specified by:

getMethod in interface IScriptEvaluator