org.codehaus.janino

Class Compiler

java.lang.Object

org.codehaus.commons.compiler.ICompiler

org.codehaus.janino.AbstractCompiler

org.codehaus.janino.Compiler

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.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	setCharacterEncoding(String characterEncoding)
void	setClassFileCreator(ResourceCreator classFileCreator)
void	setClassFileFinder(ResourceFinder classFileFinder)
void	setCompileErrorHandler(ErrorHandler compileErrorHandler) Installs a custom ErrorHandler.
void	setDebugLines(boolean value)
void	setDebugSource(boolean value)
void	setDebugVars(boolean value)
void	setEncoding(Charset encoding)
void	setIClassLoader(IClassLoader iClassLoader) Loads "auxiliary classes", typically from BOOTCLASSPATH + EXTDIR + CLASSPATH (but not from the "destination directory"!).
void	setSourceFinder(ResourceFinder sourceFinder)
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.janino.AbstractCompiler

setBootClassPath, setClassPath, setExtensionDirectories, setSourcePath

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

compile, setDestinationDirectory, setRebuild

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.

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.

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

Specified by:

compile in class ICompiler

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)

Description copied from class: AbstractCompiler

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

Specified by:

setIClassLoader in class AbstractCompiler

setClassFileFinder

public void setClassFileFinder(@Nullable
                               ResourceFinder classFileFinder)

Specified by:

setClassFileFinder in class ICompiler

setClassFileCreator

public void setClassFileCreator(@Nullable
                                ResourceCreator classFileCreator)

Specified by:

setClassFileCreator in class ICompiler

Parameters:

classFileCreator - Stores the generated class files (a.k.a. "-d"); special value ICompiler.CREATE_NEXT_TO_SOURCE_FILE means "create each .class file in the same directory as its source file"

setEncoding

public void setEncoding(@Nullable
                        Charset encoding)

Specified by:

setEncoding in class ICompiler

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 String characterEncoding)

Overrides:

setCharacterEncoding in class ICompiler

setDebugLines

public void setDebugLines(boolean value)

Specified by:

setDebugLines in class ICompiler

setDebugVars

public void setDebugVars(boolean value)

Specified by:

setDebugVars in class ICompiler

setDebugSource

public void setDebugSource(boolean value)

Specified by:

setDebugSource in class ICompiler

setVerbose

public void setVerbose(boolean verbose)

Specified by:

setVerbose in class ICompiler

setSourceFinder

public void setSourceFinder(ResourceFinder sourceFinder)

Specified by:

setSourceFinder in class ICompiler