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 boolean[] |
optionalOverrideMethod
Whether methods override a method declared by a supertype;
null means "none". |
protected boolean[] |
optionalStaticMethod
Whether methods are static;
null means "all". |
DEFAULT_CLASS_NAME
BOOT_CLASS_LOADER, SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR, SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE
Constructor and Description |
---|
ScriptEvaluator() |
ScriptEvaluator(String script)
Equivalent to
|
ScriptEvaluator(String script,
Class<?> returnType)
Equivalent to
|
ScriptEvaluator(String script,
Class<?> returnType,
String[] parameterNames,
Class<?>[] parameterTypes)
Equivalent to
|
ScriptEvaluator(String script,
Class<?> returnType,
String[] parameterNames,
Class<?>[] parameterTypes,
Class<?>[] thrownExceptions)
Equivalent to
|
ScriptEvaluator(String optionalFileName,
InputStream is,
Class<?> returnType,
String[] parameterNames,
Class<?>[] parameterTypes,
Class<?>[] thrownExceptions,
ClassLoader optionalParentClassLoader)
Equivalent to
|
ScriptEvaluator(String optionalFileName,
Reader reader,
Class<?> returnType,
String[] parameterNames,
Class<?>[] parameterTypes,
Class<?>[] thrownExceptions,
ClassLoader optionalParentClassLoader)
Equivalent to
|
Modifier and Type | Method and Description |
---|---|
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. |
cook, getClazz, parseImportDeclarations, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes
assertCooked, assertNotCooked, getClassLoader, setCompileErrorHandler, setDebuggingInformation, setParentClassLoader, setParentClassLoader, setWarningHandler
cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, readString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getClazz, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes
cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, setCompileErrorHandler, setDebuggingInformation, setParentClassLoader, setWarningHandler
protected boolean[] optionalOverrideMethod
null
means "none".protected boolean[] optionalStaticMethod
null
means "all".public ScriptEvaluator(String script) throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.cook(script);
CompileException
ScriptEvaluator()
,
Cookable.cook(String)
public ScriptEvaluator(String script, Class<?> returnType) throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.cook(script);
CompileException
ScriptEvaluator()
,
setReturnType(Class)
,
Cookable.cook(String)
public ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes) throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.cook(script);
public ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions) throws CompileException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.cook(script);
public ScriptEvaluator(String optionalFileName, InputStream is, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader optionalParentClassLoader) throws CompileException, IOException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(optionalFileName, is);
public ScriptEvaluator(String optionalFileName, Reader reader, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader optionalParentClassLoader) throws CompileException, IOException
ScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(optionalParentClassLoader); se.cook(reader);
public ScriptEvaluator()
public void setOverrideMethod(boolean overrideMethod)
IScriptEvaluator
setOverrideMethod
in interface IScriptEvaluator
public void setStaticMethod(boolean staticMethod)
IScriptEvaluator
true
.setStaticMethod
in interface IScriptEvaluator
public void setReturnType(Class returnType)
IScriptEvaluator
null
value is implementation-dependent.setReturnType
in interface IScriptEvaluator
public void setMethodName(String methodName)
IScriptEvaluator
setMethodName
in interface IScriptEvaluator
public void setParameters(String[] names, Class[] types)
IScriptEvaluator
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.
setParameters
in interface IScriptEvaluator
public void setThrownExceptions(Class[] thrownExceptions)
IScriptEvaluator
setThrownExceptions
in interface IScriptEvaluator
public void cook(String optionalFileName, Reader r) throws CompileException, IOException
ICookable
Reader
.cook
in interface ICookable
cook
in class ClassBodyEvaluator
optionalFileName
- Used when reporting errors and warnings.CompileException
IOException
ICookable.cook(String, Reader)
public Object evaluate(Object[] arguments) throws 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 IScriptEvaluator
arguments
- The actual parameter valuesInvocationTargetException
public Method getMethod()
IScriptEvaluator
Method
.
This method must only be called after exactly one of the ICookable.cook(String, Reader)
methods was called.
getMethod
in interface IScriptEvaluator
public void setOverrideMethod(boolean[] overrideMethod)
IScriptEvaluator
IScriptEvaluator.setOverrideMethod(boolean)
, but for multiple scripts.setOverrideMethod
in interface IScriptEvaluator
public void setStaticMethod(boolean[] staticMethod)
IScriptEvaluator
IScriptEvaluator.setStaticMethod(boolean)
, but for multiple scripts.setStaticMethod
in interface IScriptEvaluator
public void setReturnTypes(Class[] returnTypes)
IScriptEvaluator
null
elements is
implementation-dependent.setReturnTypes
in interface IScriptEvaluator
public void setMethodNames(String[] methodNames)
IScriptEvaluator
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[][])
).
setMethodNames
in interface IScriptEvaluator
public void setParameters(String[][] names, Class[][] types)
IScriptEvaluator
IScriptEvaluator.setParameters(String[], Class[])
, but for multiple scripts.setParameters
in interface IScriptEvaluator
public void setThrownExceptions(Class[][] thrownExceptions)
IScriptEvaluator
IScriptEvaluator.setThrownExceptions(Class[])
, but for multiple scripts.setThrownExceptions
in interface IScriptEvaluator
public final void cook(Reader[] readers) throws CompileException, IOException
IScriptEvaluator
ICookable.cook(Reader)
, but for multiple scripts.cook
in interface IScriptEvaluator
CompileException
IOException
public void cook(String[] optionalFileNames, Reader[] readers) throws CompileException, IOException
IScriptEvaluator
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.
cook
in interface IScriptEvaluator
CompileException
IOException
public final void cook(String[] strings) throws CompileException
IScriptEvaluator
ICookable.cook(String)
, but for multiple scripts.cook
in interface IScriptEvaluator
CompileException
public void cook(String[] optionalFileNames, String[] strings) throws CompileException
IScriptEvaluator
ICookable.cook(String, String)
, but for multiple scripts.cook
in interface IScriptEvaluator
CompileException
protected final void cook(String[] optionalFileNames, Reader[] readers, String[] imports) throws CompileException, IOException
readers
- The scripts to cookCompileException
IOException
protected Class<?> getDefaultReturnType()
void
.public Object createFastEvaluator(String script, Class interfaceToImplement, String[] parameterNames) throws CompileException
createFastEvaluator
in interface IScriptEvaluator
script
- Contains the sequence of script tokensCompileException
createFastEvaluator(String, Class, String[])
public final Object createInstance(Reader reader)
createInstance
in interface IClassBodyEvaluator
createInstance
in class ClassBodyEvaluator
reader
- Source of class body tokensoptionalExtendedType
and implements the given
implementedTypes
public Object createFastEvaluator(Reader r, Class interfaceToImplement, String[] parameterNames) throws CompileException, 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 =All other configuration (implemented type, static method, return type, method name, parameter names and types, thrown exceptions) are predetermined by theCompilerFactoryFactory
.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));
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 IScriptEvaluator
r
- Produces the stream of script tokensinterfaceToImplement
- Must declare exactly one methodparameterNames
- The names of the parameters of that methodCompileException
IOException
public Object evaluate(int idx, Object[] arguments) throws InvocationTargetException
IScriptEvaluator
IScriptEvaluator.evaluate(Object[])
, but for multiple scripts.evaluate
in interface IScriptEvaluator
InvocationTargetException
public Method getMethod(int idx)
IScriptEvaluator
IScriptEvaluator.getMethod()
, but for multiple scripts.getMethod
in interface IScriptEvaluator
Copyright © 2001–2016. All rights reserved.