org.codehaus.janino

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 a SimpleCompiler object, proceed as described for ISimpleCompiler. Alternatively, a number of "convenience constructors" exist that execute the described steps instantly.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debugLines
protected boolean	debugSource
protected boolean	debugVars

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
SimpleCompiler()
SimpleCompiler(Scanner scanner, ClassLoader optionalParentClassLoader) Equivalent to
SimpleCompiler(String fileName) Equivalent to
SimpleCompiler(String optionalFileName, InputStream is) Equivalent to
SimpleCompiler(String optionalFileName, Reader in) Equivalent to

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertNotCooked() Throw an IllegalStateException if this Cookable is already cooked.
protected Java.Type[]	classesToTypes(Location location, Class[] classes) Convert an array of Classes into an array ofJava.Types.
protected Java.Type	classToType(Location location, Class optionalClass) Wrap a reflection Class in a Java.Type object.
protected ClassLoader	compileToClassLoader(Java.CompilationUnit compilationUnit) Compile the given compilation unit.
void	cook(Java.CompilationUnit compilationUnit) Cook this compilation unit directly.
void	cook(Scanner scanner)
void	cook(String optionalFileName, Reader r) Reads, scans, parses and compiles Java tokens from the given Reader.
boolean	equals(Object o) Two SimpleCompilers are regarded equal iff Both are objects of the same class (e.g.
ClassLoader	getClassLoader() Returns a ClassLoader object through which the previously compiled classes can be accessed.
int	hashCode()
static void	main(String[] args)
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) Allow references to the classes loaded through this parent class loader (@see setParentClassLoader(ClassLoader)), plus the extra auxiliaryClasses.
protected void	setUpClassLoaders() Initializes classLoader and iClassLoader from the configured parentClassLoader and optionalAuxiliaryClasses.

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

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

Field Detail

debugSource

protected boolean debugSource

debugLines

protected boolean debugLines

debugVars

protected boolean debugVars

Constructor Detail

SimpleCompiler

public SimpleCompiler(String optionalFileName,
              Reader in)
               throws IOException,
                      CompileException

Equivalent to

 SimpleCompiler 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 to

 SimpleCompiler 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 to

 SimpleCompiler 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 to

 SimpleCompiler sc = new SimpleCompiler();
 sc.setParentClassLoader(optionalParentClassLoader);
 sc.cook(scanner);

Throws:

IOException

CompileException

See Also:

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

SimpleCompiler

public SimpleCompiler()

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

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

public void setParentClassLoader(ClassLoader optionalParentClassLoader,
                        Class[] auxiliaryClasses)

Allow references to the classes loaded through this parent class loader (@see setParentClassLoader(ClassLoader)), plus the extra auxiliaryClasses.

Notice that the auxiliaryClasses must either be loadable through the optionalParentClassLoader (in which case they have no effect), or no class with the same name must be loadable through the optionalParentClassLoader.

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

cook

public final 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

cook

public void cook(Scanner scanner)
          throws CompileException,
                 IOException

Throws:

CompileException

IOException

cook

public void cook(Java.CompilationUnit compilationUnit)
          throws CompileException

Cook this compilation unit directly. See Cookable.cook(java.lang.String, java.io.Reader)

Throws:

CompileException

setUpClassLoaders

protected final void setUpClassLoaders()

Initializes classLoader and iClassLoader from the configured parentClassLoader and optionalAuxiliaryClasses. These are needed by classToType(Location, Class) and friends which are used when creating the AST.

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

equals

public boolean equals(Object o)

Two SimpleCompilers are regarded equal iff

• Both are objects of the same class (e.g. both are ScriptEvaluators)
• Both generated functionally equal classes as seen by ByteArrayClassLoader.equals(Object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

classToType

protected Java.Type classToType(Location location,
                    Class optionalClass)

Wrap a reflection Class in a Java.Type object.

classesToTypes

protected Java.Type[] classesToTypes(Location location,
                         Class[] classes)

Convert an array of Classes into an array ofJava.Types.

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()

Throw an IllegalStateException if this Cookable is already cooked.