Class SimpleCompiler
- java.lang.Object
-
- org.codehaus.commons.compiler.Cookable
-
- org.codehaus.janino.SimpleCompiler
-
- All Implemented Interfaces:
ICookable
,ISimpleCompiler
- Direct Known Subclasses:
ClassBodyEvaluator
public class SimpleCompiler extends Cookable implements ISimpleCompiler
To set up aSimpleCompiler
object, proceed as described forISimpleCompiler
. Alternatively, a number of "convenience constructors" exist that execute the described steps instantly.
-
-
Field Summary
-
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 Description SimpleCompiler()
SimpleCompiler(String fileName)
Equivalent toSimpleCompiler(String optionalFileName, InputStream is)
Equivalent toSimpleCompiler(String optionalFileName, Reader in)
Equivalent toSimpleCompiler(Scanner scanner, ClassLoader optionalParentClassLoader)
Equivalent to
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
assertNotCooked()
protected Java.Type[]
classesToTypes(Location location, Class[] classes)
protected Java.Type
classToType(Location location, Class clazz)
protected ClassLoader
compileToClassLoader(Java.CompilationUnit compilationUnit)
Compile the given compilation unit.void
cook(String optionalFileName, Reader r)
Scans, parses and compiles a given compilation unit from the givenReader
.void
cook(Java.CompilationUnit compilationUnit)
Cooks this compilation unit directly.void
cook(Scanner scanner)
Scans, parses and ompiles a given compilation unit from the given scanner.boolean
equals(Object o)
TwoSimpleCompiler
s are regarded equal iff Both are objects of the same class (e.g.ClassLoader
getClassLoader()
Returns aClassLoader
object through which the previously compiled classes can be accessed.int
hashCode()
static void
main(String[] args)
void
setCompileErrorHandler(ErrorHandler optionalCompileErrorHandler)
By default,CompileException
s are thrown on compile errors, but an application my install its ownErrorHandler
.void
setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars)
Determines what kind of debugging information is included in the generates classes.void
setParentClassLoader(ClassLoader optionalParentClassLoader)
The "parent class loader" is used to load referenced classes.void
setWarningHandler(WarningHandler optionalWarningHandler)
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, readString
-
-
-
-
Constructor Detail
-
SimpleCompiler
public SimpleCompiler(String optionalFileName, Reader in) throws IOException, CompileException
Equivalent toSimpleCompiler sc = new SimpleCompiler(); sc.cook(optionalFileName, in);
- Throws:
IOException
CompileException
- See Also:
SimpleCompiler()
,Cookable.cook(String, Reader)
-
SimpleCompiler
public SimpleCompiler(String optionalFileName, InputStream is) throws IOException, CompileException
Equivalent toSimpleCompiler sc = new SimpleCompiler(); sc.cook(optionalFileName, is);
- Throws:
IOException
CompileException
- See Also:
SimpleCompiler()
,Cookable.cook(String, InputStream)
-
SimpleCompiler
public SimpleCompiler(String fileName) throws IOException, CompileException
Equivalent toSimpleCompiler sc = new SimpleCompiler(); sc.cook(fileName);
- Throws:
IOException
CompileException
- See Also:
SimpleCompiler()
,Cookable.cookFile(String)
-
SimpleCompiler
public SimpleCompiler(Scanner scanner, ClassLoader optionalParentClassLoader) throws IOException, CompileException
Equivalent toSimpleCompiler sc = new SimpleCompiler(); sc.setParentClassLoader(optionalParentClassLoader); sc.cook(scanner);
-
SimpleCompiler
public SimpleCompiler()
-
-
Method Detail
-
setParentClassLoader
public void setParentClassLoader(ClassLoader optionalParentClassLoader)
Description copied from interface:ICookable
The "parent class loader" is used to load referenced classes. Useful values are:
The parent class loader defaults to the current thread's context class loader.System.getSystemClassLoader()
The running JVM's class path Thread.currentThread().getContextClassLoader()
ornull
The class loader effective for the invoking thread ICookable.BOOT_CLASS_LOADER
The running JVM's boot class path - Specified by:
setParentClassLoader
in interfaceICookable
-
setDebuggingInformation
public void setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars)
Description copied from interface:ICookable
Determines what kind of debugging information is included in the generates classes. The default is typically '-g:none', and '-g:all' if the system property 'org.codehaus.janino.source_debugging.enable' is set to 'true'.- Specified by:
setDebuggingInformation
in interfaceICookable
-
cook
public final void cook(String optionalFileName, Reader r) throws CompileException, IOException
Scans, parses and compiles a given compilation unit from the givenReader
. After completion,getClassLoader()
returns aClassLoader
that allows for access to the compiled classes.- Specified by:
cook
in interfaceICookable
- Specified by:
cook
in classCookable
- Parameters:
optionalFileName
- Used when reporting errors and warnings.- Throws:
CompileException
IOException
- See Also:
ICookable.cook(String, Reader)
-
cook
public void cook(Scanner scanner) throws CompileException, IOException
Scans, parses and ompiles a given compilation unit from the given scanner. After completion,getClassLoader()
returns aClassLoader
that allows for access to the compiled classes.- Throws:
CompileException
IOException
-
cook
public void cook(Java.CompilationUnit compilationUnit) throws CompileException
Cooks this compilation unit directly.- Throws:
CompileException
- See Also:
Cookable.cook(Reader)
-
getClassLoader
public ClassLoader getClassLoader()
Description copied from interface:ISimpleCompiler
Returns aClassLoader
object through which the previously compiled classes can be accessed. ThisClassLoader
can be used for subsequentISimpleCompiler
s in order to compile compilation units that use types (e.g. declare derived types) declared in the previous one.This method must only be called after exactly on of the
ICookable.cook(String, java.io.Reader)
methods was called.- Specified by:
getClassLoader
in interfaceISimpleCompiler
-
equals
public boolean equals(Object o)
TwoSimpleCompiler
s are regarded equal iff- Both are objects of the same class (e.g. both are
ScriptEvaluator
s) - Both generated functionally equal classes as seen by
Object.equals(Object)
- Both are objects of the same class (e.g. both are
-
setCompileErrorHandler
public void setCompileErrorHandler(ErrorHandler optionalCompileErrorHandler)
Description copied from interface:ICookable
By default,CompileException
s are thrown on compile errors, but an application my install its ownErrorHandler
.Be aware that a single problem during compilation often causes a bunch of compile errors, so a good
ErrorHandler
counts errors and throws aCompileException
when a limit is reached.If the given
ErrorHandler
throwsCompileException
s, then the compilation is terminated and the exception is propagated.If the given
ErrorHandler
does not throwCompileException
s, then the compiler may or may not continue compilation, but must eventually throw aCompileException
.In other words: The
ErrorHandler
may throw aCompileException
or not, but the compiler must definitely throw aCompileException
if one or more compile errors have occurred.- Specified by:
setCompileErrorHandler
in interfaceICookable
- Parameters:
optionalCompileErrorHandler
-null
to restore the default behavior (throwing aCompileException
-
setWarningHandler
public void setWarningHandler(WarningHandler optionalWarningHandler)
Description copied from interface:ICookable
By default, warnings are discarded, but an application my install a customWarningHandler
.- Specified by:
setWarningHandler
in interfaceICookable
- Parameters:
optionalWarningHandler
-null
to indicate that no warnings be issued
-
compileToClassLoader
protected final ClassLoader compileToClassLoader(Java.CompilationUnit compilationUnit) throws CompileException
Compile the given compilation unit. (A "compilation unit" is typically the contents of a Java™ source file.)- Parameters:
compilationUnit
- The parsed compilation unit- Returns:
- The
ClassLoader
into which the compiled classes were defined - Throws:
CompileException
-
assertNotCooked
protected void assertNotCooked()
- Throws:
IllegalStateException
- ThisCookable
is already cooked
-
-