org.codehaus.commons.compiler.jdk
Class SimpleCompiler

java.lang.Object
  org.codehaus.commons.compiler.Cookable
      org.codehaus.commons.compiler.jdk.SimpleCompiler

All Implemented Interfaces:

ICookable, ISimpleCompiler

Direct Known Subclasses:

ClassBodyEvaluator

public class SimpleCompiler
extends Cookable
implements ISimpleCompiler

The JDK-based implementation of ISimpleCompiler.

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

SimpleCompiler()

Method Summary

protected void	assertCooked() Throw an IllegalStateException if this Cookable is not yet cooked.
protected void	assertNotCooked() Throw an IllegalStateException if this Cookable is already cooked.
void	cook(String optionalFileName, Reader r) Reads, scans, parses and compiles Java tokens from the given Reader.
ClassLoader	getClassLoader() Returns a ClassLoader object through which the previously compiled classes can be accessed.
void	setCompileErrorHandler(ErrorHandler optionalCompileErrorHandler) By default, CompileExceptions are thrown on compile errors, but an application my install its own ErrorHandler.
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	setParentClassLoader(ClassLoader optionalParentClassLoader, Class<?>[] auxiliaryClasses) Deprecated. Auxiliary classes never really worked... don't use them.
void	setWarningHandler(WarningHandler optionalWarningHandler) By default, warnings are discarded, but an application my install a custom WarningHandler.

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, 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

SimpleCompiler

public SimpleCompiler()

Method Detail

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: ISimpleCompiler

Returns a ClassLoader object through which the previously compiled classes can be accessed. This ClassLoader can be used for subsequent ISimpleCompilers 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 interface ISimpleCompiler

cook

public void cook(String optionalFileName,
                 Reader r)
          throws CompileException,
                 IOException

Description copied from interface: ICookable

Reads, scans, parses and compiles Java tokens from the given Reader.

Specified by:

cook in interface ICookable

Specified by:

cook in class Cookable

Parameters:

optionalFileName - Used when reporting errors and warnings.

Throws:

CompileException

IOException

See Also:

ICookable.cook(String, Reader)

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 interface ICookable

setParentClassLoader

public void setParentClassLoader(ClassLoader optionalParentClassLoader)

Description copied from interface: ICookable

The "parent class loader" is used to load referenced classes. Useful values are:

System.getSystemClassLoader()	The running JVM's class path
Thread.currentThread().getContextClassLoader() or null	The class loader effective for the invoking thread
ICookable.BOOT_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 interface ICookable

setParentClassLoader

@Deprecated
public void setParentClassLoader(ClassLoader optionalParentClassLoader,
                                            Class<?>[] auxiliaryClasses)

Deprecated. Auxiliary classes never really worked... don't use them.

setCompileErrorHandler

public void setCompileErrorHandler(ErrorHandler optionalCompileErrorHandler)

Description copied from interface: ICookable

By default, CompileExceptions are thrown on compile errors, but an application my install its own ErrorHandler.

Be aware that a single problem during compilation often causes a bunch of compile errors, so a good ErrorHandler counts errors and throws a CompileException when a limit is reached.

If the given ErrorHandler throws CompileExceptions, then the compilation is terminated and the exception is propagated.

If the given ErrorHandler does not throw CompileExceptions, then the compiler may or may not continue compilation, but must eventually throw a CompileException.

In other words: The ErrorHandler may throw a CompileException or not, but the compiler must definitely throw a CompileException if one or more compile errors have occurred.

Specified by:

setCompileErrorHandler in interface ICookable

Parameters:

optionalCompileErrorHandler - null to restore the default behavior (throwing a CompileException

setWarningHandler

public void setWarningHandler(WarningHandler optionalWarningHandler)

Description copied from interface: ICookable

By default, warnings are discarded, but an application my install a custom WarningHandler.

Specified by:

setWarningHandler in interface ICookable

Parameters:

optionalWarningHandler - null to indicate that no warnings be issued

assertCooked

protected void assertCooked()

Throw an IllegalStateException if this Cookable is not yet cooked.

assertNotCooked

protected void assertNotCooked()

Throw an IllegalStateException if this Cookable is already cooked.