Class ExpressionEvaluator
- java.lang.Object
-
- org.codehaus.commons.compiler.Cookable
-
- org.codehaus.janino.SimpleCompiler
-
- org.codehaus.janino.ClassBodyEvaluator
-
- org.codehaus.janino.ScriptEvaluator
-
- org.codehaus.janino.ExpressionEvaluator
-
- All Implemented Interfaces:
IClassBodyEvaluator,ICookable,IExpressionEvaluator,IScriptEvaluator,ISimpleCompiler
public class ExpressionEvaluator extends ScriptEvaluator implements IExpressionEvaluator
ThisIExpressionEvaluatoris implemented by creating and compiling a temporary compilation unit defining one class with one static method with one RETURN statement.A number of "convenience constructors" exist that execute the set-up steps described for
IExpressionEvaluatorinstantly.If the parameter and return types of the expression are known at compile time, then a "fast" expression evaluator can be instantiated through
createFastExpressionEvaluator(String, Class, String[], ClassLoader). Expression evaluation is faster than throughScriptEvaluator.evaluate(Object[]), because it is not done through reflection but through direct method invocation.Example:
public interface Foo { int bar(int a, int b); } ... Foo f = (Foo) ExpressionEvaluator.createFastExpressionEvaluator( "a + b", // expression to evaluate Foo.class, // interface that describes the expression's signature new String[] { "a", "b" }, // the parameters' names (ClassLoader) null // Use current thread's context class loader ); System.out.println("1 + 2 = " + f.bar(1, 2)); // Evaluate the expressionNotice: TheinterfaceToImplementmust either be declaredpublic, or with package scope in the root package (i.e. "no" package).On my system (Intel P4, 2 GHz, MS Windows XP, JDK 1.4.1), expression "x + 1" evaluates as follows:
(How can it be that interface method invocation is slower than reflection for the server JVM?)Server JVM Client JVM Normal EE 23.7 ns 64.0 ns Fast EE 31.2 ns 42.2 ns
-
-
Field Summary
-
Fields inherited from class org.codehaus.janino.ScriptEvaluator
optionalMethodNames, optionalOverrideMethod, optionalParameterNames, optionalParameterTypes, optionalReturnTypes, optionalStaticMethod, optionalThrownExceptions
-
Fields inherited from class org.codehaus.janino.ClassBodyEvaluator
className, ZERO_CLASSES
-
Fields inherited from class org.codehaus.janino.SimpleCompiler
debugLines, debugSource, debugVars
-
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
-
Fields inherited from interface org.codehaus.commons.compiler.IExpressionEvaluator
ANY_TYPE
-
-
Constructor Summary
Constructors Constructor Description ExpressionEvaluator()ExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes)Equivalent toExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.ClassLoader optionalParentClassLoader)Equivalent toExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.Class optionalExtendedType, java.lang.Class[] implementedTypes, java.lang.ClassLoader optionalParentClassLoader)Equivalent toExpressionEvaluator(Scanner scanner, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class[] implementedTypes, boolean staticMethod, java.lang.Class expressionType, java.lang.String methodName, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.ClassLoader optionalParentClassLoader)Equivalent to
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.lang.ObjectcreateFastExpressionEvaluator(java.lang.String expression, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader)Deprecated.static java.lang.ObjectcreateFastExpressionEvaluator(Scanner scanner, java.lang.String[] optionalDefaultImports, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader)Deprecated.static java.lang.ObjectcreateFastExpressionEvaluator(Scanner scanner, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader)Deprecated.protected java.lang.ClassgetDefaultReturnType()static java.lang.String[]guessParameterNames(Scanner scanner)Guess the names of the parameters used in the given expression.protected java.util.ListmakeStatements(int idx, Parser parser)Fill the givenblockby parsing statements until EOF and adding them to the block.voidsetExpressionType(java.lang.Class expressionType)Define the type of the expression.voidsetExpressionTypes(java.lang.Class[] expressionTypes)Same asIExpressionEvaluator.setExpressionType(Class), but for multiple expressions.voidsetReturnType(java.lang.Class returnType)Deprecated.voidsetReturnTypes(java.lang.Class[] returnTypes)Deprecated.-
Methods inherited from class org.codehaus.janino.ScriptEvaluator
compileToMethods, cook, cook, cook, cook, cook, cook, cook, createFastEvaluator, createFastEvaluator, createFastEvaluator, createFastScriptEvaluator, createFastScriptEvaluator, createFastScriptEvaluator, createFastScriptEvaluator, createInstance, evaluate, evaluate, getMethod, getMethod, makeMethodDeclaration, setMethodName, setMethodNames, setOverrideMethod, setOverrideMethod, setParameters, setParameters, setStaticMethod, setStaticMethod, setThrownExceptions, setThrownExceptions
-
Methods inherited from class org.codehaus.janino.ClassBodyEvaluator
addPackageMemberClassDeclaration, compileToClass, createFastClassBodyEvaluator, createFastClassBodyEvaluator, getClazz, makeCompilationUnit, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes
-
Methods inherited from class org.codehaus.janino.SimpleCompiler
assertNotCooked, classesToTypes, classToType, compileToClassLoader, cook, cook, equals, getClassLoader, hashCode, main, setDebuggingInformation, setParentClassLoader
-
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.codehaus.commons.compiler.IClassBodyEvaluator
createInstance, getClazz, setClassName, setDefaultImports, setExtendedClass, setExtendedType, setImplementedInterfaces, setImplementedTypes
-
Methods inherited from interface org.codehaus.commons.compiler.ICookable
cook, cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile, setDebuggingInformation, setParentClassLoader
-
Methods inherited from interface org.codehaus.commons.compiler.IExpressionEvaluator
createFastEvaluator, createFastEvaluator, evaluate
-
Methods inherited from interface org.codehaus.commons.compiler.IScriptEvaluator
cook, cook, cook, cook, evaluate, getMethod, getMethod, setMethodName, setMethodNames, setOverrideMethod, setOverrideMethod, setParameters, setParameters, setStaticMethod, setStaticMethod, setThrownExceptions, setThrownExceptions
-
-
-
-
Constructor Detail
-
ExpressionEvaluator
public ExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes) throws CompileExceptionEquivalent toExpressionEvaluator ee = new ExpressionEvaluator(); ee.setExpressionType(expressionType); ee.setParameters(parameterNames, parameterTypes); ee.cook(expression);
-
ExpressionEvaluator
public ExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.ClassLoader optionalParentClassLoader) throws CompileExceptionEquivalent toExpressionEvaluator ee = new ExpressionEvaluator(); ee.setExpressionType(expressionType); ee.setParameters(parameterNames, parameterTypes); ee.setThrownExceptions(thrownExceptions); ee.setParentClassLoader(optionalParentClassLoader); ee.cook(expression);
-
ExpressionEvaluator
public ExpressionEvaluator(java.lang.String expression, java.lang.Class expressionType, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.Class optionalExtendedType, java.lang.Class[] implementedTypes, java.lang.ClassLoader optionalParentClassLoader) throws CompileExceptionEquivalent toExpressionEvaluator ee = new ExpressionEvaluator(); ee.setExpressionType(expressionType); ee.setParameters(parameterNames, parameterTypes); ee.setThrownExceptions(thrownExceptions); ee.setExtendedType(optionalExtendedType); ee.setImplementedTypes(implementedTypes); ee.setParentClassLoader(optionalParentClassLoader); ee.cook(expression);
- Throws:
CompileException- See Also:
ExpressionEvaluator(),setExpressionType(Class),ScriptEvaluator.setParameters(String[], Class[]),ScriptEvaluator.setThrownExceptions(Class[]),ClassBodyEvaluator.setExtendedClass(Class),ClassBodyEvaluator.setImplementedInterfaces(Class[]),SimpleCompiler.setParentClassLoader(ClassLoader),Cookable.cook(String)
-
ExpressionEvaluator
public ExpressionEvaluator(Scanner scanner, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class[] implementedTypes, boolean staticMethod, java.lang.Class expressionType, java.lang.String methodName, java.lang.String[] parameterNames, java.lang.Class[] parameterTypes, java.lang.Class[] thrownExceptions, java.lang.ClassLoader optionalParentClassLoader) throws CompileException, java.io.IOException
Equivalent toExpressionEvaluator ee = new ExpressionEvaluator(); ee.setClassName(className); ee.setExtendedType(optionalExtendedType); ee.setImplementedTypes(implementedTypes); ee.setStaticMethod(staticMethod); ee.setExpressionType(expressionType); ee.setMethodName(methodName); ee.setParameters(parameterNames, parameterTypes); ee.setThrownExceptions(thrownExceptions); ee.setParentClassLoader(optionalParentClassLoader); ee.cook(scanner);
- Throws:
CompileExceptionjava.io.IOException- See Also:
IExpressionEvaluator,IClassBodyEvaluator.setClassName(String),IClassBodyEvaluator.setExtendedClass(Class),IClassBodyEvaluator.setImplementedInterfaces(Class[]),IScriptEvaluator.setStaticMethod(boolean),IExpressionEvaluator.setExpressionType(Class),IScriptEvaluator.setMethodName(String),IScriptEvaluator.setParameters(String[], Class[]),IScriptEvaluator.setThrownExceptions(Class[]),ICookable.setParentClassLoader(ClassLoader),ICookable.cook(Reader)
-
ExpressionEvaluator
public ExpressionEvaluator()
-
-
Method Detail
-
setExpressionType
public void setExpressionType(java.lang.Class expressionType)
Description copied from interface:IExpressionEvaluatorDefine the type of the expression. The special typeIExpressionEvaluator.ANY_TYPEallows the expression to return any type (primitive or reference).If
expressionTypeisVoid.TYPE, then the expression must be an invocation of avoidmethod.Defaults to
IExpressionEvaluator.ANY_TYPE.- Specified by:
setExpressionTypein interfaceIExpressionEvaluator
-
setExpressionTypes
public void setExpressionTypes(java.lang.Class[] expressionTypes)
Description copied from interface:IExpressionEvaluatorSame asIExpressionEvaluator.setExpressionType(Class), but for multiple expressions.- Specified by:
setExpressionTypesin interfaceIExpressionEvaluator
-
setReturnType
@Deprecated public final void setReturnType(java.lang.Class returnType)
Deprecated.Description copied from interface:IScriptEvaluatorDefines the return type of the generated method. The meaning of anullvalue is implementation-dependent.- Specified by:
setReturnTypein interfaceIExpressionEvaluator- Specified by:
setReturnTypein interfaceIScriptEvaluator- Overrides:
setReturnTypein classScriptEvaluator
-
setReturnTypes
@Deprecated public final void setReturnTypes(java.lang.Class[] returnTypes)
Deprecated.Description copied from class:ScriptEvaluatorDefines the return types of the generated methods.- Specified by:
setReturnTypesin interfaceIExpressionEvaluator- Specified by:
setReturnTypesin interfaceIScriptEvaluator- Overrides:
setReturnTypesin classScriptEvaluator- Parameters:
returnTypes- The methods' return types;nullvalues mean the "default return type", which is the type returned byScriptEvaluator.getDefaultReturnType()(void.classforScriptEvaluatorandObject.classforExpressionEvaluator)- See Also:
ScriptEvaluator.getDefaultReturnType(),getDefaultReturnType()
-
getDefaultReturnType
protected java.lang.Class getDefaultReturnType()
- Overrides:
getDefaultReturnTypein classScriptEvaluator- Returns:
void.class- See Also:
ScriptEvaluator.setReturnTypes(Class[])
-
makeStatements
protected java.util.List makeStatements(int idx, Parser parser) throws CompileException, java.io.IOExceptionDescription copied from class:ScriptEvaluatorFill the givenblockby parsing statements until EOF and adding them to the block.- Overrides:
makeStatementsin classScriptEvaluator- Throws:
CompileExceptionjava.io.IOException
-
createFastExpressionEvaluator
@Deprecated public static java.lang.Object createFastExpressionEvaluator(java.lang.String expression, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader) throws CompileExceptionDeprecated.IExpressionEvaluatoree =CompilerFactoryFactory.getDefaultCompilerFactory().newExpressionEvaluator(); ee.setParentClassLoader(optionalParentClassLoader); return ee.createFastEvaluator(expression, interfaceToImplement, parameterNames);- Throws:
CompileException
-
createFastExpressionEvaluator
@Deprecated public static java.lang.Object createFastExpressionEvaluator(Scanner scanner, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader) throws CompileException, java.io.IOException
Deprecated.Notice: This method is not declared inIExpressionEvaluator, and is hence only available in this implementation oforg.codehaus.commons.compiler. To be independent from this particular implementation, try to switch toScriptEvaluator.createFastEvaluator(Reader, Class, String[]).- Throws:
CompileExceptionjava.io.IOException
-
createFastExpressionEvaluator
@Deprecated public static java.lang.Object createFastExpressionEvaluator(Scanner scanner, java.lang.String[] optionalDefaultImports, java.lang.String className, java.lang.Class optionalExtendedType, java.lang.Class interfaceToImplement, java.lang.String[] parameterNames, java.lang.ClassLoader optionalParentClassLoader) throws CompileException, java.io.IOException
Deprecated.Notice: This method is not declared inIExpressionEvaluator, and is hence only available in this implementation oforg.codehaus.commons.compiler. To be independent from this particular implementation, try to switch toScriptEvaluator.createFastEvaluator(Reader, Class, String[]).- Throws:
CompileExceptionjava.io.IOException
-
guessParameterNames
public static java.lang.String[] guessParameterNames(Scanner scanner) throws CompileException, java.io.IOException
Guess the names of the parameters used in the given expression. The strategy is to look at all "ambiguous names" in the expression (e.g. in "a.b.c.d()", the ambiguous name is "a.b.c"), and then at the first components of the ambiguous name.- If any component starts with an upper-case letter, then ambiguous name is assumed to be a type name.
- Otherwise, it is assumed to be a parameter name.
- Throws:
CompileExceptionjava.io.IOException- See Also:
Scanner(String, Reader)
-
-