org.codehaus.commons.compiler.jdk

Class ClassBodyEvaluator

java.lang.Object

org.codehaus.commons.compiler.Cookable

org.codehaus.commons.compiler.jdk.ClassBodyEvaluator

All Implemented Interfaces:

IClassBodyEvaluator, ICookable

public class ClassBodyEvaluator
extends Cookable
implements IClassBodyEvaluator

To set up a ClassBodyEvaluator object, proceed as described for IClassBodyEvaluator. Alternatively, a number of "convenience constructors" exist that execute the described steps instantly.

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 parseImportDeclarations(Reader).

See Also:

IClassBodyEvaluator

Field Summary

Fields inherited from interface org.codehaus.commons.compiler.IClassBodyEvaluator

DEFAULT_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
ClassBodyEvaluator()

Method Summary

Modifier and Type	Method and Description
void	cook(String fileName, Reader r)
protected void	cook(String fileName, String[] imports, Reader r)
Object	createInstance(Reader reader)
Map<String,byte[]>	getBytecodes()
Class<?>	getClazz()
String[]	getDefaultImports()
protected Reader	newFileName(String fileName, Reader reader) Sets the given file name, and the current line number to 1, and the current column number to 1, when the first char is read from the reader.
protected static String[]	parseImportDeclarations(Reader r) Heuristically parses IMPORT declarations at the beginning of the character stream produced by the given Reader.
void	setClassName(String className)
void	setCompileErrorHandler(ErrorHandler compileErrorHandler)
void	setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars)
void	setDefaultImports(String... defaultImports)
void	setExtendedClass(Class<?> extendedType)
void	setExtendedType(Class<?> extendedClass) Deprecated. Use setExtendedClass(Class) instead
void	setImplementedInterfaces(Class<?>[] implementedTypes)
void	setImplementedTypes(Class<?>[] implementedInterfaces) Deprecated. Use setImplementedInterfaces(Class[]) instead
void	setParentClassLoader(ClassLoader parentClassLoader)
void	setSourceVersion(int version)
void	setTargetVersion(int version)
void	setWarningHandler(WarningHandler warningHandler)

Methods inherited from class org.codehaus.commons.compiler.Cookable

cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile

Constructor Detail

ClassBodyEvaluator

public ClassBodyEvaluator()

Method Detail

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface IClassBodyEvaluator

setDefaultImports

public void setDefaultImports(String... defaultImports)

Specified by:

setDefaultImports in interface IClassBodyEvaluator

getDefaultImports

public String[] getDefaultImports()

Specified by:

getDefaultImports in interface IClassBodyEvaluator

setExtendedClass

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

Specified by:

setExtendedClass in interface IClassBodyEvaluator

setExtendedType

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

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

setParentClassLoader

public void setParentClassLoader(@Nullable
                                 ClassLoader parentClassLoader)

Specified by:

setParentClassLoader in interface IClassBodyEvaluator

setDebuggingInformation

public void setDebuggingInformation(boolean debugSource,
                                    boolean debugLines,
                                    boolean debugVars)

Specified by:

setDebuggingInformation in interface IClassBodyEvaluator

setSourceVersion

public void setSourceVersion(int version)

Specified by:

setSourceVersion in interface ICookable

setTargetVersion

public void setTargetVersion(int version)

Specified by:

setTargetVersion in interface ICookable

setCompileErrorHandler

public void setCompileErrorHandler(@Nullable
                                   ErrorHandler compileErrorHandler)

Specified by:

setCompileErrorHandler in interface IClassBodyEvaluator

setWarningHandler

public void setWarningHandler(@Nullable
                              WarningHandler warningHandler)

Specified by:

setWarningHandler in interface IClassBodyEvaluator

cook

public void cook(@Nullable
                 String fileName,
                 Reader r)
          throws CompileException,
                 IOException

Specified by:

cook in interface ICookable

Specified by:

cook in class Cookable

Throws:

CompileException

IOException

cook

protected void cook(@Nullable
                    String fileName,
                    String[] imports,
                    Reader r)
             throws CompileException,
                    IOException

Parameters:

imports - E.g. "java.io.*" or "static java.util.Arrays.asList"

r - The class body to cook, without leading IMPORT declarations

Throws:

CompileException

IOException

getClazz

public Class<?> getClazz()

Specified by:

getClazz in interface IClassBodyEvaluator

Returns:

The Class created by the preceding call to Cookable.cook(Reader)

getBytecodes

public Map<String,byte[]> getBytecodes()

Specified by:

getBytecodes in interface ICookable

newFileName

protected Reader newFileName(@Nullable
                             String fileName,
                             Reader reader)

Sets the given file name, and the current line number to 1, and the current column number to 1, when the first char is read from the reader.

parseImportDeclarations

protected static String[] parseImportDeclarations(Reader r)
                                           throws IOException

Heuristically parses IMPORT declarations at the beginning of the character stream produced by the given Reader. After this method returns, all characters up to and including that last IMPORT declaration have been read from the Reader.

This method does not handle comments and string literals correctly, i.e. if a pattern that looks like an IMPORT declaration appears within a comment or a string literal, it will be taken as an IMPORT declaration.

Parameters:

r - A Reader that supports MARK, e.g. a BufferedReader

Returns:

The parsed imports, e.g. { "java.util.*", "static java.util.Map.Entry" }

Throws:

IOException

createInstance

public Object createInstance(Reader reader)
                      throws CompileException,
                             IOException

Specified by:

createInstance in interface IClassBodyEvaluator

Throws:

CompileException

IOException