Class ClassBodyEvaluator
- All Implemented Interfaces:
IClassBodyEvaluator
,ICookable
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String[]
private Class<?>
private Class<?>[]
private static final Pattern
private Class<?>
private final SimpleCompiler
Fields inherited from interface org.codehaus.commons.compiler.IClassBodyEvaluator
DEFAULT_CLASS_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Reads, scans, parses and compiles Java tokens from the givenReader
.protected void
createInstance
(Reader reader) Scans, parses and compiles a class body from the tokens delivered by the the givenReader
, then creates and returns an instance of that class.Class<?>
getClazz()
String[]
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 firstchar
is read from the reader.protected static String[]
Heuristically parses IMPORT declarations at the beginning of the character stream produced by the givenReader
.void
setClassName
(String className) Sets the name of the generated class.void
setCompileErrorHandler
(ErrorHandler compileErrorHandler) Installs anErrorHandler
which is invoked during compilation on each error.void
setDebuggingInformation
(boolean debugSource, boolean debugLines, boolean debugVars) Determines what kind of debugging information is included in the generates classes.void
setDefaultImports
(String... defaultImports) "Default imports" add to the system import "java.lang", i.e.void
setExtendedClass
(Class<?> extendedType) Sets a particular superclass that the generated class will extend.void
setExtendedType
(Class<?> extendedClass) Deprecated.void
setImplementedInterfaces
(Class<?>[] implementedTypes) Sets a particular set of interfaces that the generated class will implement.void
setImplementedTypes
(Class<?>[] implementedInterfaces) Deprecated.UsesetImplementedInterfaces(Class[])
insteadvoid
setParentClassLoader
(ClassLoader parentClassLoader) The "parent class loader" is used to load referenced classes.void
setSourceVersion
(int version) Specifies the version of source code accepted, in analogy with JAVAC's-source
command line option.void
setTargetVersion
(int version) Generates class files that target a specified release of the virtual machine, in analogy with JAVAC's-target
command line option.void
setWarningHandler
(WarningHandler warningHandler) By default, warnings are discarded, but an application my install a customWarningHandler
.Methods inherited from class org.codehaus.commons.compiler.Cookable
cook, cook, cook, cook, cook, cook, cook, cookFile, cookFile, cookFile, cookFile
-
Field Details
-
sc
-
defaultImports
-
className
-
extendedType
-
implementedTypes
-
result
-
IMPORT_STATEMENT_PATTERN
-
-
Constructor Details
-
ClassBodyEvaluator
public ClassBodyEvaluator()
-
-
Method Details
-
setClassName
Description copied from interface:IClassBodyEvaluator
Sets the name of the generated class. Defaults toIClassBodyEvaluator.DEFAULT_CLASS_NAME
. In most cases, there is no need to set this name, because the generated class is loaded into its ownClassLoader
where its name cannot collide with classes generated by other evaluators.One reason to use this function is to have a class name in a non-default package, which can be relevant when types and members with DEFAULT accessibility are accessed.
- Specified by:
setClassName
in interfaceIClassBodyEvaluator
-
setDefaultImports
Description copied from interface:IClassBodyEvaluator
"Default imports" add to the system import "java.lang", i.e. the evaluator may refer to classes imported by default imports without having to explicitly declare IMPORT statements.Notice that JDK 5 "static imports" are also supported, as shown here:
sc.setDefaultImports( "java.util.Map", // Single type import "java.io.*", // Type-import-on-demand "static java.util.Collections.EMPTY_MAP", // Single static import "static java.util.Collections.*", // Static-import-on-demand );
- Specified by:
setDefaultImports
in interfaceIClassBodyEvaluator
-
getDefaultImports
- Specified by:
getDefaultImports
in interfaceIClassBodyEvaluator
- Returns:
- The default imports that were previously configured with
IClassBodyEvaluator.setDefaultImports(String...)
-
setExtendedClass
Description copied from interface:IClassBodyEvaluator
Sets a particular superclass that the generated class will extend. If extendedClass isnull
, the generated class will extendObject
.The usual reason to set a base class for an evaluator is that the generated class can directly access the superclass's (non-private) members.
- Specified by:
setExtendedClass
in interfaceIClassBodyEvaluator
-
setExtendedType
Deprecated.UsesetExtendedClass(Class)
instead- Specified by:
setExtendedType
in interfaceIClassBodyEvaluator
-
setImplementedInterfaces
Description copied from interface:IClassBodyEvaluator
Sets a particular set of interfaces that the generated class will implement.- Specified by:
setImplementedInterfaces
in interfaceIClassBodyEvaluator
-
setImplementedTypes
Deprecated.UsesetImplementedInterfaces(Class[])
instead- Specified by:
setImplementedTypes
in interfaceIClassBodyEvaluator
-
setParentClassLoader
Description copied from interface:IClassBodyEvaluator
The "parent class loader" is used to load referenced classes. Useful values are:System.getSystemClassLoader()
The running JVM's class path Thread.currentThread().getContextClassLoader()
ornull
The class loader effective for the invoking thread ClassLoaders.BOOTCLASSPATH_CLASS_LOADER
The running JVM's boot class path The parent class loader defaults to the current thread's context class loader.
- Specified by:
setParentClassLoader
in interfaceIClassBodyEvaluator
-
setDebuggingInformation
public void setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars) Description copied from interface:IClassBodyEvaluator
Determines what kind of debugging information is included in the generates classes. The default is typically "-g:none
".- Specified by:
setDebuggingInformation
in interfaceIClassBodyEvaluator
-
setSourceVersion
public void setSourceVersion(int version) Description copied from interface:ICookable
Specifies the version of source code accepted, in analogy with JAVAC's-source
command line option. May be ignored by an implementation (e.g. thejanino
implementation always accepts the language features as described on the home page). Allowed values, and the default value, depend on the implementation.-1
means to use a default version.- Specified by:
setSourceVersion
in interfaceICookable
-
setTargetVersion
public void setTargetVersion(int version) Description copied from interface:ICookable
Generates class files that target a specified release of the virtual machine, in analogy with JAVAC's-target
command 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.-1
means to use a default version.- Specified by:
setTargetVersion
in interfaceICookable
-
setCompileErrorHandler
Description copied from interface:IClassBodyEvaluator
Installs anErrorHandler
which is invoked during compilation on each error. (By default, the compilation throws aCompileException
on the first error and terminates.)If the given
ErrorHandler
throws aCompileException
, then the compilation terminates and the exception is propagated.If the given
ErrorHandler
does not throw aCompileException
but 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 aCompileException
indicating the number of errors.In other words: The
ErrorHandler
may throw aCompileException
or not, but the compilation will definitely throw aCompileException
if one or more compile errors have occurred.- Specified by:
setCompileErrorHandler
in interfaceIClassBodyEvaluator
- Parameters:
compileErrorHandler
-null
to restore the default behavior (throwing aCompileException
)
-
setWarningHandler
Description copied from interface:IClassBodyEvaluator
By default, warnings are discarded, but an application my install a customWarningHandler
.- Specified by:
setWarningHandler
in interfaceIClassBodyEvaluator
- Parameters:
warningHandler
-null
to indicate that no warnings be issued
-
cook
Description copied from interface:ICookable
Reads, scans, parses and compiles Java tokens from the givenReader
.- Specified by:
cook
in interfaceICookable
- Specified by:
cook
in classCookable
- Parameters:
fileName
- Used when reporting errors and warnings- 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
- Specified by:
getClazz
in interfaceIClassBodyEvaluator
- Returns:
- The
Class
created by the preceding call toCookable.cook(Reader)
-
getBytecodes
- Specified by:
getBytecodes
in interfaceICookable
- Returns:
- The generated Java bytecode; maps class name to bytes
-
newFileName
Sets the given file name, and the current line number to 1, and the current column number to 1, when the firstchar
is read from the reader. -
parseImportDeclarations
Heuristically parses IMPORT declarations at the beginning of the character stream produced by the givenReader
. After this method returns, all characters up to and including that last IMPORT declaration have been read from theReader
.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
- AReader
that supports MARK, e.g. aBufferedReader
- Returns:
- The parsed imports, e.g.
{ "java.util.*", "static java.util.Map.Entry" }
- Throws:
IOException
-
createInstance
Description copied from interface:IClassBodyEvaluator
Scans, parses and compiles a class body from the tokens delivered by the the givenReader
, then creates and returns an instance of that class.- Specified by:
createInstance
in interfaceIClassBodyEvaluator
- Parameters:
reader
- Source of class body tokens- Returns:
- An object that extends the
extendedType
and implements the givenimplementedTypes
- Throws:
CompileException
IOException
-
setExtendedClass(Class)
instead