org.codehaus.janino

Class Compiler

java.lang.Object

org.codehaus.commons.compiler.AbstractCompiler

org.codehaus.janino.Compiler

All Implemented Interfaces:

ICompiler

public class Compiler
extends AbstractCompiler

JANINO implementation of ICompiler.

Field Summary

Fields

Modifier and Type	Field and Description
static StringPattern[]	DEFAULT_WARNING_HANDLE_PATTERNS The default value for the warningHandlerPatterns parameter of Compiler(File[], File[], File[], File[], File, String, boolean, boolean, boolean, boolean, StringPattern[], boolean).

Fields inherited from class org.codehaus.commons.compiler.AbstractCompiler

bootClassPath, classFileCreator, classFileFinder, classPath, debugLines, debugSource, debugVars, encoding, extensionDirectories, sourceFinder

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

CREATE_NEXT_TO_SOURCE_FILE, FIND_NEXT_TO_SOURCE_FILE, NO_DESTINATION_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
Compiler() Initializes a new compiler.
Compiler(File[] sourcePath, File[] classPath, File[] extDirs, File[] bootClassPath, File destinationDirectory, String characterEncoding, boolean verbose, boolean debugSource, boolean debugLines, boolean debugVars, StringPattern[] warningHandlePatterns, boolean rebuild) Deprecated. Use Compiler() and the various configuration setters instead
Compiler(ResourceFinder sourceFinder, IClassLoader parentIClassLoader) Deprecated. Use Compiler() and the various configuration setters instead

Method Summary

Modifier and Type	Method and Description
void	compile(Resource[] sourceResources)
static File	getClassFile(String className, File sourceFile, File destinationDirectory) Constructs the name of a file that could store the byte code of the class with the given name.
EnumSet<JaninoOption>	options()
Compiler	options(EnumSet<JaninoOption> options) Sets the options for all future compilations.
void	setBootClassPath(File[] directoriesAndArchives)
void	setClassPath(File[] directoriesAndArchives)
void	setCompileErrorHandler(ErrorHandler compileErrorHandler) Installs a custom ErrorHandler.
void	setExtensionDirectories(File[] directories)
void	setIClassLoader(IClassLoader iClassLoader) Loads "auxiliary classes", typically from BOOTCLASSPATH + EXTDIR + CLASSPATH (but not from the "destination directory"!).
void	setVerbose(boolean verbose)
void	setWarningHandler(WarningHandler warningHandler) By default, warnings are discarded, but an application my install a custom WarningHandler.
void	storeClassFile(ClassFile classFile, File sourceFile) Stores the byte code of this ClassFile in the file system.

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

compile, setCharacterEncoding, setClassFileCreator, setClassFileFinder, setClassFileFinder, setDebugLines, setDebugSource, setDebugVars, setDestinationDirectory, setEncoding, setSourceFinder, setSourcePath

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WARNING_HANDLE_PATTERNS

public static final StringPattern[] DEFAULT_WARNING_HANDLE_PATTERNS

The default value for the warningHandlerPatterns parameter of Compiler(File[], File[], File[], File[], File, String, boolean, boolean, boolean, boolean, StringPattern[], boolean).

Constructor Detail

Compiler

public Compiler()

Initializes a new compiler.

Compiler

@Deprecated
public Compiler(ResourceFinder sourceFinder,
                             IClassLoader parentIClassLoader)

Deprecated. Use Compiler() and the various configuration setters instead

Compiler

@Deprecated
public Compiler(File[] sourcePath,
                             File[] classPath,
                             @Nullable
                             File[] extDirs,
                             @Nullable
                             File[] bootClassPath,
                             @Nullable
                             File destinationDirectory,
                             @Nullable
                             String characterEncoding,
                             boolean verbose,
                             boolean debugSource,
                             boolean debugLines,
                             boolean debugVars,
                             StringPattern[] warningHandlePatterns,
                             boolean rebuild)

Deprecated. Use Compiler() and the various configuration setters instead

Method Detail

setCompileErrorHandler

public void setCompileErrorHandler(@Nullable
                                   ErrorHandler compileErrorHandler)

Installs a custom ErrorHandler. The default ErrorHandler prints the first 20 compile errors to System.err and then throws a CompileException.

Passing null restores the default ErrorHandler.

Notice that scan and parse errors are not redirected to this ErrorHandler, instead, they cause a CompileException to be thrown. Also, the Compiler may choose to throw CompileExceptions in certain, fatal compile error situations, even if an ErrorHandler is installed.

In other words: In situations where compilation can reasonably continue after a compile error, the ErrorHandler is called; all other error conditions cause a CompileException to be thrown.

Specified by:

setCompileErrorHandler in interface ICompiler

Overrides:

setCompileErrorHandler in class AbstractCompiler

setWarningHandler

public void setWarningHandler(@Nullable
                              WarningHandler warningHandler)

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

Specified by:

setWarningHandler in interface ICompiler

Overrides:

setWarningHandler in class AbstractCompiler

Parameters:

warningHandler - null to indicate that no warnings be issued

options

public EnumSet<JaninoOption> options()

Returns:

A reference to the currently effective compilation options; changes to it take effect immediately

options

public Compiler options(EnumSet<JaninoOption> options)

Sets the options for all future compilations.

compile

public void compile(Resource[] sourceResources)
             throws CompileException,
                    IOException

Throws:

CompileException

IOException

getClassFile

public static File getClassFile(String className,
                                File sourceFile,
                                @Nullable
                                File destinationDirectory)

Constructs the name of a file that could store the byte code of the class with the given name.

If destinationDirectory is non-null, the returned path is the destinationDirectory plus the package of the class (with dots replaced with file separators) plus the class name plus ".class". Example: "destdir/pkg1/pkg2/Outer$Inner.class"

If destinationDirectory is null, the returned path is the directory of the sourceFile plus the class name plus ".class". Example: "srcdir/Outer$Inner.class"

Parameters:

className - E.g. "pkg1.pkg2.Outer$Inner"

sourceFile - E.g. "srcdir/Outer.java"

destinationDirectory - E.g. "destdir"

storeClassFile

public void storeClassFile(ClassFile classFile,
                           File sourceFile)
                    throws IOException

Stores the byte code of this ClassFile in the file system. Directories are created as necessary.

Parameters:

classFile -

sourceFile - Required to compute class file path if no destination directory given

Throws:

IOException

setIClassLoader

public void setIClassLoader(IClassLoader iClassLoader)

Loads "auxiliary classes", typically from BOOTCLASSPATH + EXTDIR + CLASSPATH (but not from the "destination directory"!).

setVerbose

public void setVerbose(boolean verbose)

setBootClassPath

public void setBootClassPath(File[] directoriesAndArchives)

Specified by:

setBootClassPath in interface ICompiler

Overrides:

setBootClassPath in class AbstractCompiler

setExtensionDirectories

public void setExtensionDirectories(File[] directories)

Specified by:

setExtensionDirectories in interface ICompiler

Overrides:

setExtensionDirectories in class AbstractCompiler

setClassPath

public void setClassPath(File[] directoriesAndArchives)

Specified by:

setClassPath in interface ICompiler

Overrides:

setClassPath in class AbstractCompiler