org.codehaus.janino

Class ClassBodyEvaluator

java.lang.Object

org.codehaus.commons.compiler.Cookable

org.codehaus.janino.SimpleCompiler

org.codehaus.janino.ClassBodyEvaluator

All Implemented Interfaces:

IClassBodyEvaluator, ICookable, ISimpleCompiler

Direct Known Subclasses:

ScriptEvaluator

public class ClassBodyEvaluator
extends SimpleCompiler
implements IClassBodyEvaluator

The optionalClassLoader serves two purposes:

• It is used to look for classes referenced by the class body.
• It is used to load the generated Java class into the JVM; directly if it is a subclass of ByteArrayClassLoader, or by creation of a temporary ByteArrayClassLoader if not.

A number of "convenience constructors" exist that execute the setup steps instantly.

Field Summary

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

Constructors

Constructor and Description
ClassBodyEvaluator()
ClassBodyEvaluator(Scanner scanner, Class<?> optionalExtendedType, Class<?>[] implementedTypes, ClassLoader optionalParentClassLoader) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.setExtendedType(optionalExtendedType); cbe.setImplementedTypes(implementedTypes); cbe.setParentClassLoader(optionalParentClassLoader); cbe.cook(scanner);
ClassBodyEvaluator(Scanner scanner, ClassLoader optionalParentClassLoader) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.setParentClassLoader(optionalParentClassLoader); cbe.cook(scanner);
ClassBodyEvaluator(Scanner scanner, String className, Class<?> optionalExtendedType, Class<?>[] implementedTypes, ClassLoader optionalParentClassLoader) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.setClassName(className); cbe.setExtendedType(optionalExtendedType); cbe.setImplementedTypes(implementedTypes); cbe.setParentClassLoader(optionalParentClassLoader); cbe.cook(scanner);
ClassBodyEvaluator(String classBody) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.cook(classBody);
ClassBodyEvaluator(String optionalFileName, InputStream is) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.cook(optionalFileName, is);
ClassBodyEvaluator(String optionalFileName, Reader reader) Equivalent to ClassBodyEvaluator cbe = new ClassBodyEvaluator(); cbe.cook(optionalFileName, reader);

Method Summary

Modifier and Type	Method and Description
protected Java.PackageMemberClassDeclaration	addPackageMemberClassDeclaration(Location location, Java.CompilationUnit compilationUnit) To the given Java.CompilationUnit, add A class declaration with the configured name, superclass and interfaces A method declaration with the given return type, name, parameter names and values and thrown exceptions
protected Class<?>	compileToClass(Java.CompilationUnit compilationUnit) Compiles the given compilation unit, load all generated classes, and return the class with the given name.
void	cook(Scanner scanner) Scans, parses and compiles a given compilation unit from the given scanner.
static Object	createFastClassBodyEvaluator(Scanner scanner, Class<?> optionalBaseType, ClassLoader optionalParentClassLoader) Use createInstance(Reader) instead: IClassBodyEvaluator cbe = CompilerFactoryFactory.
static Object	createFastClassBodyEvaluator(Scanner scanner, String className, Class<?> optionalExtendedClass, Class<?>[] implementedInterfaces, ClassLoader optionalParentClassLoader) Deprecated. Use createInstance(Reader) instead
Object	createInstance(Reader reader)
Class<?>	getClazz()
protected Java.CompilationUnit	makeCompilationUnit(Parser optionalParser) Creates a Java.CompilationUnit, sets the default imports, and parses the import declarations.
void	setClassName(String className)
void	setDefaultImports(String... optionalDefaultImports)
void	setExtendedClass(Class<?> optionalExtendedType)
void	setExtendedType(Class<?> optionalExtendedClass) Deprecated. Use setExtendedClass(Class) instead
void	setImplementedInterfaces(Class<?>[] implementedTypes)
void	setImplementedTypes(Class<?>[] implementedInterfaces) Deprecated. Use setImplementedInterfaces(Class[]) instead

Methods inherited from class org.codehaus.janino.SimpleCompiler

classesToTypes, classToType, compileToClassLoader, cook, cook, cook, cook, equals, getClassLoader, hashCode, main, optionalClassToType, options, options, setCompileErrorHandler, setDebuggingInformation, setNoPermissions, setParentClassLoader, setPermissions, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getClassLoader, setNoPermissions, setPermissions

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

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

Constructor Detail

ClassBodyEvaluator

public ClassBodyEvaluator(String classBody)
                   throws CompileException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.cook(classBody);
 

Throws:

CompileException

See Also:

ClassBodyEvaluator(), Cookable.cook(String)

ClassBodyEvaluator

public ClassBodyEvaluator(@Nullable
                          String optionalFileName,
                          InputStream is)
                   throws CompileException,
                          IOException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.cook(optionalFileName, is);
 

Throws:

CompileException

IOException

See Also:

ClassBodyEvaluator(), Cookable.cook(String, InputStream)

ClassBodyEvaluator

public ClassBodyEvaluator(@Nullable
                          String optionalFileName,
                          Reader reader)
                   throws CompileException,
                          IOException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.cook(optionalFileName, reader);
 

Throws:

CompileException

IOException

See Also:

ClassBodyEvaluator(), ICookable.cook(String, Reader)

ClassBodyEvaluator

public ClassBodyEvaluator(Scanner scanner,
                          @Nullable
                          ClassLoader optionalParentClassLoader)
                   throws CompileException,
                          IOException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.setParentClassLoader(optionalParentClassLoader);
     cbe.cook(scanner);
 

Throws:

CompileException

IOException

See Also:

ClassBodyEvaluator(), SimpleCompiler.setParentClassLoader(ClassLoader), Cookable.cook(Reader)

ClassBodyEvaluator

public ClassBodyEvaluator(Scanner scanner,
                          @Nullable
                          Class<?> optionalExtendedType,
                          Class<?>[] implementedTypes,
                          @Nullable
                          ClassLoader optionalParentClassLoader)
                   throws CompileException,
                          IOException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.setExtendedType(optionalExtendedType);
     cbe.setImplementedTypes(implementedTypes);
     cbe.setParentClassLoader(optionalParentClassLoader);
     cbe.cook(scanner);
 

Throws:

CompileException

IOException

See Also:

ClassBodyEvaluator(), setExtendedClass(Class), setImplementedInterfaces(Class[]), SimpleCompiler.setParentClassLoader(ClassLoader), Cookable.cook(Reader)

ClassBodyEvaluator

public ClassBodyEvaluator(Scanner scanner,
                          String className,
                          @Nullable
                          Class<?> optionalExtendedType,
                          Class<?>[] implementedTypes,
                          @Nullable
                          ClassLoader optionalParentClassLoader)
                   throws CompileException,
                          IOException

Equivalent to

     ClassBodyEvaluator cbe = new ClassBodyEvaluator();
     cbe.setClassName(className);
     cbe.setExtendedType(optionalExtendedType);
     cbe.setImplementedTypes(implementedTypes);
     cbe.setParentClassLoader(optionalParentClassLoader);
     cbe.cook(scanner);

Throws:

CompileException

IOException

See Also:

ClassBodyEvaluator(), setClassName(String), setExtendedClass(Class), setImplementedInterfaces(Class[]), SimpleCompiler.setParentClassLoader(ClassLoader), Cookable.cook(Reader)

ClassBodyEvaluator

public ClassBodyEvaluator()

Method Detail

setDefaultImports

public void setDefaultImports(@Nullable
                              String... optionalDefaultImports)

Specified by:

setDefaultImports in interface IClassBodyEvaluator

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface IClassBodyEvaluator

setExtendedClass

public void setExtendedClass(@Nullable
                             Class<?> optionalExtendedType)

Specified by:

setExtendedClass in interface IClassBodyEvaluator

setExtendedType

@Deprecated
public void setExtendedType(@Nullable
                                         Class<?> optionalExtendedClass)

Deprecated. Use setExtendedClass(Class) instead

Specified by:

setExtendedType in interface IClassBodyEvaluator

setImplementedInterfaces

public void setImplementedInterfaces(Class<?>[] implementedTypes)

Specified by:

setImplementedInterfaces in interface IClassBodyEvaluator

setImplementedTypes

@Deprecated
public void setImplementedTypes(Class<?>[] implementedInterfaces)

Deprecated. Use setImplementedInterfaces(Class[]) instead

Specified by:

setImplementedTypes in interface IClassBodyEvaluator

cook

public void cook(Scanner scanner)
          throws CompileException,
                 IOException

Description copied from class: SimpleCompiler

Scans, parses and compiles a given compilation unit from the given scanner. After completion, SimpleCompiler.getClassLoader() returns a ClassLoader that allows for access to the compiled classes.

Overrides:

cook in class SimpleCompiler

Throws:

CompileException

IOException

makeCompilationUnit

protected final Java.CompilationUnit makeCompilationUnit(@Nullable
                                                         Parser optionalParser)
                                                  throws CompileException,
                                                         IOException

Creates a Java.CompilationUnit, sets the default imports, and parses the import declarations.

If the optionalParser is given, a sequence of IMPORT directives is parsed from it and added to the compilation unit.

Throws:

CompileException

IOException

addPackageMemberClassDeclaration

protected Java.PackageMemberClassDeclaration addPackageMemberClassDeclaration(Location location,
                                                                              Java.CompilationUnit compilationUnit)
                                                                       throws CompileException

To the given Java.CompilationUnit, add

• A class declaration with the configured name, superclass and interfaces
• A method declaration with the given return type, name, parameter names and values and thrown exceptions

Returns:

The created Java.AbstractClassDeclaration object

Throws:

CompileException

compileToClass

protected final Class<?> compileToClass(Java.CompilationUnit compilationUnit)
                                 throws CompileException

Compiles the given compilation unit, load all generated classes, and return the class with the given name.

Parameters:

compilationUnit -

Returns:

The loaded class

Throws:

CompileException

getClazz

public Class<?> getClazz()

Specified by:

getClazz in interface IClassBodyEvaluator

createInstance

public Object createInstance(Reader reader)
                      throws CompileException,
                             IOException

Specified by:

createInstance in interface IClassBodyEvaluator

Throws:

CompileException

IOException

createFastClassBodyEvaluator

public static Object createFastClassBodyEvaluator(Scanner scanner,
                                                  @Nullable
                                                  Class<?> optionalBaseType,
                                                  @Nullable
                                                  ClassLoader optionalParentClassLoader)
                                           throws CompileException,
                                                  IOException

Use createInstance(Reader) instead:

     IClassBodyEvaluator cbe = CompilerFactoryFactory.getDefaultCompilerFactory().newClassBodyEvaluator();
     if (optionalBaseType != null) {
         if (optionalBaseType.isInterface()) {
             cbe.setImplementedInterfaces(new Class[] { optionalBaseType });
         } else {
             cbe.setExtendedClass(optionalBaseType);
         }
     }
     cbe.setParentClassLoader(optionalParentClassLoader);
     cbe.createInstance(reader);
 

Throws:

CompileException

IOException

See Also:

createInstance(Reader)

createFastClassBodyEvaluator

@Deprecated
public static Object createFastClassBodyEvaluator(Scanner scanner,
                                                               String className,
                                                               @Nullable
                                                               Class<?> optionalExtendedClass,
                                                               Class<?>[] implementedInterfaces,
                                                               @Nullable
                                                               ClassLoader optionalParentClassLoader)
                                                        throws CompileException,
                                                               IOException

Deprecated. Use createInstance(Reader) instead

Use createInstance(Reader) instead:

     IClassBodyEvaluator cbe = CompilerFactoryFactory.getDefaultCompilerFactory().newClassBodyEvaluator();
     cbe.setExtendedClass(optionalExtendedClass);
     cbe.setImplementedInterfaces(implementedInterfaces);
     cbe.setParentClassLoader(optionalParentClassLoader);
     cbe.createInstance(reader);
 

Throws:

CompileException

IOException

See Also:

createInstance(Reader)