Class ScriptEvaluator
- All Implemented Interfaces:
ICookable, IMultiCookable, 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).
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescription(package private) final ClassBodyEvaluatorprivate Class<?> private Method[]null=uncookedprivate ScriptEvaluator.Script[]The scripts to compile.Fields inherited from interface IScriptEvaluator
DEFAULT_METHOD_NAME, DEFAULT_RETURN_TYPE -
Constructor Summary
ConstructorsConstructorDescriptionScriptEvaluator(String script) Equivalent toScriptEvaluator(String fileName, InputStream is, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader parentClassLoader) Equivalent toScriptEvaluator(String fileName, Reader reader, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, ClassLoader parentClassLoader) Equivalent toScriptEvaluator(String script, Class<?> returnType) Equivalent toScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes) Equivalent toScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions) Equivalent to -
Method Summary
Modifier and TypeMethodDescriptionvoidSame asCookable.cook(String, Reader), but cooks a set of documents into one class.protected final voidvoidReads, scans, parses and compiles Java tokens from the givenReader.<T> TcreateFastEvaluator(Reader r, Class<T> 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.<T> TcreateFastEvaluator(String script, Class<T> interfaceToImplement, String[] parameterNames) evaluate()Shorthand forevaluate(new Object[0]).Same asIScriptEvaluator.evaluate(Object[]), but for multiple scripts.Calls the script with concrete parameter values.Class<?> getClazz()String[]Class<?> getMethod(int idx) Same asIScriptEvaluator.getMethod(), but for multiple scripts.private StringgetMethodName(int idx) protected Method[]Method[]protected final Class<?> getReturnType(int i) private ScriptEvaluator.ScriptgetScript(int index) voidsetClassName(String className) voidsetCompileErrorHandler(ErrorHandler compileErrorHandler) Installs anErrorHandlerwhich is invoked during compilation on each error.voidsetDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars) Determines what kind of debugging information is included in the generates classes.voidsetDefaultImports(String... defaultImports) voidsetDefaultReturnType(Class<?> defaultReturnType) When thisIScriptEvaluatoris coooked, then the defaultReturnType applies to all scripts for which no explicit return type was configured.voidsetExtendedClass(Class<?> extendedClass) voidsetImplementedInterfaces(Class<?>[] implementedInterfaces) voidsetMethodName(String methodName) Defines the name of the generated method.voidsetMethodNames(String[] methodNames) Same asIScriptEvaluator.setMethodName(String), but for multiple scripts.voidsetOverrideMethod(boolean overrideMethod) Defines whether the generated method overrides a methods declared in a supertype.voidsetOverrideMethod(boolean[] overrideMethod) Same asIScriptEvaluator.setOverrideMethod(boolean), but for multiple scripts.voidsetParameters(String[][] parameterNames, Class<?>[][] parameterTypes) Same asIScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts.voidsetParameters(String[] names, Class<?>[] types) Defines the names and types of the parameters of the generated method.voidsetParentClassLoader(ClassLoader parentClassLoader) The "parent class loader" is used to load referenced classes.voidsetReturnType(Class<?> returnType) Defines the return type of the generated method.voidsetReturnTypes(Class<?>[] returnTypes) Configures the return types of the generated methods.voidsetScriptCount(int count) voidsetSourceVersion(int version) Specifies the version of source code accepted, in analogy with JAVAC's-sourcecommand line option.voidsetStaticMethod(boolean staticMethod) Defines whether the generated method should be STATIC or not.voidsetStaticMethod(boolean[] staticMethod) Same asIScriptEvaluator.setStaticMethod(boolean), but for multiple scripts.voidsetTargetVersion(int version) Generates class files that target a specified release of the virtual machine, in analogy with JAVAC's-targetcommand line option.voidsetThrownExceptions(Class<?>[] thrownExceptions) Defines the exceptions that the generated method may throw.voidsetThrownExceptions(Class<?>[][] thrownExceptions) Same asIScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts.voidsetWarningHandler(WarningHandler warningHandler) By default, warnings are discarded, but an application my install a customWarningHandler.Methods inherited from class MultiCookable
cook, cook, cook, cook, cook, cook, cook, cookFiles, cookFiles, cookFiles, cookFilesMethods inherited from class Cookable
cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFileMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ICookable
cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFileMethods inherited from interface IMultiCookable
cook, cook, cook, cook, cookFiles, cookFiles, cookFiles, cookFilesMethods inherited from interface IScriptEvaluator
cook, cook, cook
-
Field Details
-
cbe
-
scripts
The scripts to compile. Is initialized on the first call tosetStaticMethod(boolean[])or one of its friends. -
defaultReturnType
-
result
-
-
Constructor Details
-
ScriptEvaluator
Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.cook(script);- Throws:
CompileException- See Also:
-
ScriptEvaluator
Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.cook(script);- Throws:
CompileException- See Also:
-
ScriptEvaluator
public ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes) throws CompileException Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.cook(script);- Throws:
CompileException- See Also:
-
ScriptEvaluator
public ScriptEvaluator(String script, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions) throws CompileException Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.cook(script);- Throws:
CompileException- See Also:
-
ScriptEvaluator
public ScriptEvaluator(@Nullable String fileName, InputStream is, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, @Nullable ClassLoader parentClassLoader) throws CompileException, IOException Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(parentClassLoader); se.cook(fileName, is);- Parameters:
parentClassLoader-nullmeans use current thread's context class loader- Throws:
CompileExceptionIOException- See Also:
-
ScriptEvaluator
public ScriptEvaluator(@Nullable String fileName, Reader reader, Class<?> returnType, String[] parameterNames, Class<?>[] parameterTypes, Class<?>[] thrownExceptions, @Nullable ClassLoader parentClassLoader) throws CompileException, IOException Equivalent toScriptEvaluator se = new ScriptEvaluator(); se.setReturnType(returnType); se.setParameters(parameterNames, parameterTypes); se.setThrownExceptions(thrownExceptions); se.setParentClassLoader(parentClassLoader); se.cook(reader);- Parameters:
parentClassLoader-nullmeans use current thread's context class loader- Throws:
CompileExceptionIOException- See Also:
-
ScriptEvaluator
public ScriptEvaluator()
-
-
Method Details
-
setParentClassLoader
Description copied from interface:IScriptEvaluatorThe "parent class loader" is used to load referenced classes. Useful values are:System.getSystemClassLoader()The running JVM's class path Thread.currentThread().getContextClassLoader()ornullThe class loader effective for the invoking thread ClassLoaders.BOOTCLASSPATH_CLASS_LOADERThe running JVM's boot class path The parent class loader defaults to the current thread's context class loader.
- Specified by:
setParentClassLoaderin interfaceIScriptEvaluator
-
setDebuggingInformation
public void setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars) Description copied from interface:IScriptEvaluatorDetermines what kind of debugging information is included in the generates classes. The default is typically "-g:none".- Specified by:
setDebuggingInformationin interfaceIScriptEvaluator
-
setSourceVersion
public void setSourceVersion(int version) Description copied from interface:ICookableSpecifies the version of source code accepted, in analogy with JAVAC's-sourcecommand line option. May be ignored by an implementation (e.g. thejaninoimplementation always accepts the language features as described on the home page). Allowed values, and the default value, depend on the implementation.-1means to use a default version.- Specified by:
setSourceVersionin interfaceICookable
-
setTargetVersion
public void setTargetVersion(int version) Description copied from interface:ICookableGenerates class files that target a specified release of the virtual machine, in analogy with JAVAC's-targetcommand line option. Allowed values depend on the implementation. The default value also depends on the implementation. The only invariant is that the generated class files are suitable for the currently executing JVM.-1means to use a default version.- Specified by:
setTargetVersionin interfaceICookable
-
setCompileErrorHandler
Description copied from interface:IScriptEvaluatorInstalls anErrorHandlerwhich is invoked during compilation on each error. (By default, the compilation throws aCompileExceptionon the first error and terminates.)If the given
ErrorHandlerthrows aCompileException, then the compilation terminates and the exception is propagated.If the given
ErrorHandlerdoes not throw aCompileExceptionbut completes normally, then the compilation may or may not continue, depending on the error. Iff the compilation completes normally but errors were reported, then it will throw aCompileExceptionindicating the number of errors.In other words: The
ErrorHandlermay throw aCompileExceptionor not, but the compilation will definitely throw aCompileExceptionif one or more compile errors have occurred.- Specified by:
setCompileErrorHandlerin interfaceIScriptEvaluator- Parameters:
compileErrorHandler-nullto restore the default behavior (throwing aCompileException)
-
setWarningHandler
Description copied from interface:IScriptEvaluatorBy default, warnings are discarded, but an application my install a customWarningHandler.- Specified by:
setWarningHandlerin interfaceIScriptEvaluator- Parameters:
warningHandler-nullto indicate that no warnings be issued
-
setScriptCount
public void setScriptCount(int count) - Throws:
IllegalArgumentException- count is different from previous invocations of this method
-
getScript
-
setClassName
- Specified by:
setClassNamein interfaceIScriptEvaluator- See Also:
-
setImplementedInterfaces
- Specified by:
setImplementedInterfacesin interfaceIScriptEvaluator- See Also:
-
setExtendedClass
- Specified by:
setExtendedClassin interfaceIScriptEvaluator- See Also:
-
setDefaultReturnType
Description copied from interface:IScriptEvaluatorWhen thisIScriptEvaluatoris coooked, then the defaultReturnType applies to all scripts for which no explicit return type was configured.The initial default return type (if you want, the "default-default" return type) is
void.class.- Specified by:
setDefaultReturnTypein interfaceIScriptEvaluator- See Also:
-
getDefaultReturnType
- Specified by:
getDefaultReturnTypein interfaceIScriptEvaluator- Returns:
- The default return type that was previously configured with
IScriptEvaluator.setDefaultReturnType(Class), orIScriptEvaluator.DEFAULT_RETURN_TYPE
-
setDefaultImports
- Specified by:
setDefaultImportsin interfaceIScriptEvaluator- See Also:
-
getDefaultImports
- Specified by:
getDefaultImportsin interfaceIScriptEvaluator- See Also:
-
setOverrideMethod
public void setOverrideMethod(boolean overrideMethod) Description copied from interface:IScriptEvaluatorDefines whether the generated method overrides a methods declared in a supertype.- Specified by:
setOverrideMethodin interfaceIScriptEvaluator
-
setStaticMethod
public void setStaticMethod(boolean staticMethod) Description copied from interface:IScriptEvaluatorDefines whether the generated method should be STATIC or not. Defaults totrue.- Specified by:
setStaticMethodin interfaceIScriptEvaluator
-
setReturnType
Description copied from interface:IScriptEvaluatorDefines the return type of the generated method. Valuenullmeans "use the default return type".- Specified by:
setReturnTypein interfaceIScriptEvaluator- See Also:
-
setMethodName
Description copied from interface:IScriptEvaluatorDefines the name of the generated method. Initially, the method name is "eval*".- Specified by:
setMethodNamein interfaceIScriptEvaluator- Parameters:
methodName-nullmeans reset to default name- See Also:
-
setParameters
Description copied from interface:IScriptEvaluatorDefines the names and types of the parameters of the generated method.names
.lengthand types.lengthmust be equal. This invariant may be checked immediately, or later when the script is cooked.The parameters can be of primitive type, e.g.
double.class.The default is to have zero parameters.
- Specified by:
setParametersin interfaceIScriptEvaluator
-
setThrownExceptions
Description copied from interface:IScriptEvaluatorDefines the exceptions that the generated method may throw.- Specified by:
setThrownExceptionsin interfaceIScriptEvaluator
-
evaluate
Description copied from interface:IScriptEvaluatorShorthand forevaluate(new Object[0]).- Specified by:
evaluatein interfaceIScriptEvaluator- Throws:
InvocationTargetException
-
evaluate
Description copied from interface:IScriptEvaluatorCalls the script with concrete parameter values.Each argument must have the same type as specified through the
parameterTypesparameter ofIScriptEvaluator.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.
Notice: In version 3.1.8, the arguments parameter was changed from
Object[]toObject..., which turned out to be a really bad decision because it caused a very ugly invocation ambiguity withIScriptEvaluator.evaluate(int, Object[]). Thus, with version 3.1.10, the parameter was changed back toObject[].- Specified by:
evaluatein interfaceIScriptEvaluator- Parameters:
arguments- The actual parameter values- Throws:
InvocationTargetException
-
getMethod
- Specified by:
getMethodin interfaceIScriptEvaluator- Returns:
- The generated and loaded
Method
-
setOverrideMethod
public void setOverrideMethod(boolean[] overrideMethod) Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.setOverrideMethod(boolean), but for multiple scripts.- Specified by:
setOverrideMethodin interfaceIScriptEvaluator
-
setStaticMethod
public void setStaticMethod(boolean[] staticMethod) Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.setStaticMethod(boolean), but for multiple scripts.- Specified by:
setStaticMethodin interfaceIScriptEvaluator
-
setReturnTypes
Description copied from interface:IScriptEvaluatorConfigures the return types of the generated methods. If an element of the array isnull, then use the "default return type" for that script.- Specified by:
setReturnTypesin interfaceIScriptEvaluator- Parameters:
returnTypes- The methods' return types;nullelements mean "use the default return type"- See Also:
-
setMethodNames
Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.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:
setMethodNamesin interfaceIScriptEvaluator
-
setParameters
Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.setParameters(String[], Class[]), but for multiple scripts.- Specified by:
setParametersin interfaceIScriptEvaluator
-
setThrownExceptions
Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.setThrownExceptions(Class[]), but for multiple scripts.- Specified by:
setThrownExceptionsin interfaceIScriptEvaluator
-
cook
Description copied from interface:ICookableReads, scans, parses and compiles Java tokens from the givenReader.- Specified by:
cookin interfaceICookable- Specified by:
cookin classCookable- Parameters:
fileName- Used when reporting errors and warnings- Throws:
CompileExceptionIOException
-
cook
Description copied from interface:IMultiCookableSame asCookable.cook(String, Reader), but cooks a set of documents into one class. Notice that if any of the documents causes trouble, the entire compilation will fail. If you need to report which of the documents causes the exception, you may want to use thefileNamesparameter to distinguish between the individual token sources.- Specified by:
cookin interfaceIMultiCookable- Specified by:
cookin interfaceIScriptEvaluator- Specified by:
cookin classMultiCookable- Throws:
CompileExceptionIOException
-
cook
protected final void cook(String[] fileNames, Reader[] readers, String[] imports) throws CompileException, IOException - Parameters:
readers- The scripts to cook- Throws:
CompileExceptionIOException
-
getMethodName
-
getReturnType
- Returns:
- The return type of the ith script
-
createFastEvaluator
public <T> T createFastEvaluator(String script, Class<T> interfaceToImplement, String[] parameterNames) throws CompileException - Specified by:
createFastEvaluatorin interfaceIScriptEvaluator- Parameters:
script- Contains the sequence of script tokens- Throws:
CompileException- See Also:
-
createFastEvaluator
public <T> T createFastEvaluator(Reader r, Class<T> interfaceToImplement, String[] parameterNames) throws CompileException, IOException Description copied from interface:IScriptEvaluatorIf 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
sinterfaceToImplementmust either be declaredpublic, or with package scope in the same package as the generated class (seeIScriptEvaluator.setClassName(String)).- Specified by:
createFastEvaluatorin interfaceIScriptEvaluator- Parameters:
r- Produces the stream of script tokensinterfaceToImplement- Must declare exactly one methodparameterNames- The names of the parameters of that method- Returns:
- An object that implements the given interface
- Throws:
CompileExceptionIOException
-
evaluate
@Nullable public Object evaluate(int idx, @Nullable Object[] arguments) throws InvocationTargetException Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.evaluate(Object[]), but for multiple scripts.- Specified by:
evaluatein interfaceIScriptEvaluator- Throws:
InvocationTargetException
-
getResult
- Specified by:
getResultin interfaceIScriptEvaluator- Returns:
- The generated and loaded methods that implement the cooked scripts
-
getMethod
Description copied from interface:IScriptEvaluatorSame asIScriptEvaluator.getMethod(), but for multiple scripts.- Specified by:
getMethodin interfaceIScriptEvaluator
-
getMethods
- Throws:
IllegalStateException- ThisScriptEvaluatorhas not yet beencook()ed
-
getClazz
- Specified by:
getClazzin interfaceIScriptEvaluator- See Also:
-
getBytecodes
- Specified by:
getBytecodesin interfaceICookable- Returns:
- The generated Java bytecode; maps class name to bytes
-