public class ScriptEvaluator extends ClassBodyEvaluator implements IScriptEvaluator
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).
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String[] |
optionalMethodNames |
protected boolean[] |
optionalOverrideMethod
Whether methods override a method declared by a supertype;
null means "none". |
protected java.lang.String[][] |
optionalParameterNames |
protected java.lang.Class<?>[][] |
optionalParameterTypes |
protected java.lang.Class<?>[] |
optionalReturnTypes |
protected boolean[] |
optionalStaticMethod
Whether methods are static;
null means "all". |
protected java.lang.Class<?>[][] |
optionalThrownExceptions |
DEFAULT_CLASS_NAMEBOOT_CLASS_LOADER, SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR, SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE| Constructor and Description |
|---|
ScriptEvaluator() |
ScriptEvaluator(java.lang.String script)
Equivalent to
|
ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType)
Equivalent to
|
ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes)
Equivalent to
|
ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions)
Equivalent to
|
ScriptEvaluator(java.lang.String optionalFileName,
java.io.InputStream is,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions,
java.lang.ClassLoader optionalParentClassLoader)
Equivalent to
|
ScriptEvaluator(java.lang.String optionalFileName,
java.io.Reader reader,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions,
java.lang.ClassLoader optionalParentClassLoader)
Equivalent to
|
| Modifier and Type | Method and Description |
|---|---|
void |
cook(java.io.Reader[] readers)
Same as
ICookable.cook(Reader), but for multiple scripts. |
void |
cook(java.lang.String[] strings)
Same as
ICookable.cook(String), but for multiple scripts. |
void |
cook(java.lang.String[] optionalFileNames,
java.io.Reader[] readers)
Same as
ICookable.cook(String, Reader), but cooks a set of scripts into one class. |
protected void |
cook(java.lang.String[] optionalFileNames,
java.io.Reader[] readers,
java.lang.String[] imports) |
void |
cook(java.lang.String[] optionalFileNames,
java.lang.String[] strings)
Same as
ICookable.cook(String, String), but for multiple scripts. |
void |
cook(java.lang.String optionalFileName,
java.io.Reader r)
Reads, scans, parses and compiles Java tokens from the given
Reader. |
java.lang.Object |
createFastEvaluator(java.io.Reader r,
java.lang.Class interfaceToImplement,
java.lang.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.
|
java.lang.Object |
createFastEvaluator(java.lang.String script,
java.lang.Class interfaceToImplement,
java.lang.String[] parameterNames) |
java.lang.Object |
createInstance(java.io.Reader reader)
Don't use.
|
java.lang.Object |
evaluate(int idx,
java.lang.Object[] arguments)
Same as
IScriptEvaluator.evaluate(Object[]), but for multiple scripts. |
java.lang.Object |
evaluate(java.lang.Object[] arguments)
Calls the script with concrete parameter values.
|
protected java.lang.Class<?> |
getDefaultReturnType() |
java.lang.reflect.Method |
getMethod()
Returns the loaded
Method. |
java.lang.reflect.Method |
getMethod(int idx)
Same as
IScriptEvaluator.getMethod(), but for multiple scripts. |
void |
setMethodName(java.lang.String methodName)
Define the name of the generated method.
|
void |
setMethodNames(java.lang.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(java.lang.String[][] names,
java.lang.Class[][] types)
Same as
IScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts. |
void |
setParameters(java.lang.String[] names,
java.lang.Class[] types)
Define the names and types of the parameters of the generated method.
|
void |
setReturnType(java.lang.Class returnType)
Defines the return type of the generated method.
|
void |
setReturnTypes(java.lang.Class[] returnTypes)
Defines the return types of the generated methods.
|
void |
setStaticMethod(boolean staticMethod)
Define whether the generated method should be STATIC or not.
|
void |
setStaticMethod(boolean[] staticMethod)
Same as
IScriptEvaluator.setStaticMethod(boolean), but for multiple scripts. |
void |
setThrownExceptions(java.lang.Class[] thrownExceptions)
Define the exceptions that the generated method may throw.
|
void |
setThrownExceptions(java.lang.Class[][] thrownExceptions)
Same as
IScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts. |
cook, getClazz, parseImportDeclarations, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypesassertCooked, assertNotCooked, cook, getClassLoader, setDebuggingInformation, setParentClassLoader, setParentClassLoadercook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, readStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetClazz, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypesprotected boolean[] optionalOverrideMethod
null means "none".protected boolean[] optionalStaticMethod
null means "all".protected java.lang.Class<?>[] optionalReturnTypes
protected java.lang.String[] optionalMethodNames
protected java.lang.String[][] optionalParameterNames
protected java.lang.Class<?>[][] optionalParameterTypes
protected java.lang.Class<?>[][] optionalThrownExceptions
public ScriptEvaluator(java.lang.String script)
throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.cook(script);
CompileExceptionScriptEvaluator(),
Cookable.cook(String)public ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType)
throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.cook(script);
CompileExceptionScriptEvaluator(),
setReturnType(Class),
Cookable.cook(String)public ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes)
throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.cook(script);
public ScriptEvaluator(java.lang.String script,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions)
throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.cook(script);
public ScriptEvaluator(java.lang.String optionalFileName,
java.io.InputStream is,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions,
java.lang.ClassLoader optionalParentClassLoader)
throws CompileException,
java.io.IOException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(optionalFileName, is);
CompileExceptionjava.io.IOExceptionScriptEvaluator(),
setReturnType(Class),
setParameters(String[], Class[]),
setThrownExceptions(Class[]),
SimpleCompiler.setParentClassLoader(ClassLoader),
Cookable.cook(String, InputStream)public ScriptEvaluator(java.lang.String optionalFileName,
java.io.Reader reader,
java.lang.Class<?> returnType,
java.lang.String[] parameterNames,
java.lang.Class<?>[] parameterTypes,
java.lang.Class<?>[] thrownExceptions,
java.lang.ClassLoader optionalParentClassLoader)
throws CompileException,
java.io.IOException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(reader);
CompileExceptionjava.io.IOExceptionScriptEvaluator(),
setReturnType(Class),
setParameters(String[], Class[]),
setThrownExceptions(Class[]),
SimpleCompiler.setParentClassLoader(ClassLoader),
Cookable.cook(String, Reader)public ScriptEvaluator()
public void setOverrideMethod(boolean overrideMethod)
IScriptEvaluatorsetOverrideMethod in interface IScriptEvaluatorpublic void setStaticMethod(boolean staticMethod)
IScriptEvaluatortrue.setStaticMethod in interface IScriptEvaluatorpublic void setReturnType(java.lang.Class returnType)
IScriptEvaluatornull value is implementation-dependent.setReturnType in interface IScriptEvaluatorpublic void setMethodName(java.lang.String methodName)
IScriptEvaluatorsetMethodName in interface IScriptEvaluatorpublic void setParameters(java.lang.String[] names,
java.lang.Class[] types)
IScriptEvaluator
names and types must have the same number of elements.
The parameters can be of primitive type, e.g. double.class.
setParameters in interface IScriptEvaluatorpublic void setThrownExceptions(java.lang.Class[] thrownExceptions)
IScriptEvaluatorsetThrownExceptions in interface IScriptEvaluatorpublic void cook(java.lang.String optionalFileName,
java.io.Reader r)
throws CompileException,
java.io.IOException
ICookableReader.cook in interface ICookablecook in class ClassBodyEvaluatoroptionalFileName - Used when reporting errors and warnings.CompileExceptionjava.io.IOExceptionICookable.cook(String, Reader)public java.lang.Object evaluate(java.lang.Object[] arguments)
throws java.lang.reflect.InvocationTargetException
IScriptEvaluator
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.
evaluate in interface IScriptEvaluatorarguments - The actual parameter valuesjava.lang.reflect.InvocationTargetExceptionpublic java.lang.reflect.Method getMethod()
IScriptEvaluatorMethod.
This method must only be called after exactly one of the ICookable.cook(String, Reader)
methods was called.
getMethod in interface IScriptEvaluatorpublic void setOverrideMethod(boolean[] overrideMethod)
IScriptEvaluatorIScriptEvaluator.setOverrideMethod(boolean), but for multiple scripts.setOverrideMethod in interface IScriptEvaluatorpublic void setStaticMethod(boolean[] staticMethod)
IScriptEvaluatorIScriptEvaluator.setStaticMethod(boolean), but for multiple scripts.setStaticMethod in interface IScriptEvaluatorpublic void setReturnTypes(java.lang.Class[] returnTypes)
IScriptEvaluatornull values is
implementation-dependent.setReturnTypes in interface IScriptEvaluatorpublic void setMethodNames(java.lang.String[] methodNames)
IScriptEvaluatorIScriptEvaluator.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[][])).
setMethodNames in interface IScriptEvaluatorpublic void setParameters(java.lang.String[][] names,
java.lang.Class[][] types)
IScriptEvaluatorIScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts.setParameters in interface IScriptEvaluatorpublic void setThrownExceptions(java.lang.Class[][] thrownExceptions)
IScriptEvaluatorIScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts.setThrownExceptions in interface IScriptEvaluatorpublic final void cook(java.io.Reader[] readers)
throws CompileException,
java.io.IOException
IScriptEvaluatorICookable.cook(Reader), but for multiple scripts.cook in interface IScriptEvaluatorCompileExceptionjava.io.IOExceptionpublic void cook(java.lang.String[] optionalFileNames,
java.io.Reader[] readers)
throws CompileException,
java.io.IOException
IScriptEvaluatorICookable.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.
cook in interface IScriptEvaluatorCompileExceptionjava.io.IOExceptionpublic final void cook(java.lang.String[] strings)
throws CompileException
IScriptEvaluatorICookable.cook(String), but for multiple scripts.cook in interface IScriptEvaluatorCompileExceptionpublic void cook(java.lang.String[] optionalFileNames,
java.lang.String[] strings)
throws CompileException
IScriptEvaluatorICookable.cook(String, String), but for multiple scripts.cook in interface IScriptEvaluatorCompileExceptionprotected final void cook(java.lang.String[] optionalFileNames,
java.io.Reader[] readers,
java.lang.String[] imports)
throws CompileException,
java.io.IOException
readers - The scripts to cookCompileExceptionjava.io.IOExceptionprotected java.lang.Class<?> getDefaultReturnType()
public java.lang.Object createFastEvaluator(java.lang.String script,
java.lang.Class interfaceToImplement,
java.lang.String[] parameterNames)
throws CompileException
createFastEvaluator in interface IScriptEvaluatorscript - Contains the sequence of script tokensCompileExceptioncreateFastEvaluator(String, Class, String[])public final java.lang.Object createInstance(java.io.Reader reader)
createInstance in interface IClassBodyEvaluatorcreateInstance in class ClassBodyEvaluatorreader - Source of class body tokensoptionalExtendedType and implements the given
implementedTypespublic java.lang.Object createFastEvaluator(java.io.Reader r,
java.lang.Class interfaceToImplement,
java.lang.String[] parameterNames)
throws CompileException,
java.io.IOException
IScriptEvaluator
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)).createFastEvaluator in interface IScriptEvaluatorr - Produces the stream of script tokensinterfaceToImplement - Must declare exactly one methodparameterNames - The names of the parameters of that methodCompileExceptionjava.io.IOExceptionpublic java.lang.Object evaluate(int idx,
java.lang.Object[] arguments)
throws java.lang.reflect.InvocationTargetException
IScriptEvaluatorIScriptEvaluator.evaluate(Object[]), but for multiple scripts.evaluate in interface IScriptEvaluatorjava.lang.reflect.InvocationTargetExceptionpublic java.lang.reflect.Method getMethod(int idx)
IScriptEvaluatorIScriptEvaluator.getMethod(), but for multiple scripts.getMethod in interface IScriptEvaluator