org.codehaus.commons.compiler

Class AbstractCompiler

java.lang.Object

org.codehaus.commons.compiler.AbstractCompiler

All Implemented Interfaces:

ICompiler

public abstract class AbstractCompiler
extends Object
implements ICompiler

A base class and wrapper for Compiler that implements all redundant API methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected File[]	bootClassPath This is always non-null for JVMs that support BOOTCLASSPATH (1.0-1.8), and this is always null for JVMs that don't (9+).
protected ResourceCreator	classFileCreator
protected ResourceFinder	classFileFinder
protected File[]	classPath The classpath of the currently executing JRE.
protected ErrorHandler	compileErrorHandler
protected boolean	debugLines
protected boolean	debugSource
protected boolean	debugVars
Charset	encoding
protected File[]	extensionDirectories The list of extension directories of the currently executing JRE.
protected ResourceFinder	sourceFinder
protected WarningHandler	warningHandler

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

Method Summary

Modifier and Type	Method and Description
boolean	compile(File[] sourceFiles) Reads a set of Java compilation units (a.k.a.
void	setBootClassPath(File[] directoriesAndArchives) Equivalent of --boot-class-path.
void	setCharacterEncoding(String characterEncoding) Equivalent with setEncoding(Charset.forName(characterEncoding)).
void	setClassFileCreator(ResourceCreator classFileCreator)
void	setClassFileFinder(ResourceFinder classFileFinder) This ResourceFinder is used to check whether a .class resource already exists and is younger than the .java resource from which it was generated.
void	setClassFileFinder(ResourceFinder destination, boolean rebuild) Equivalent with {@code setClassFileFinder(rebuild ?
void	setClassPath(File[] directoriesAndArchives) Equivalent of --class-path.
void	setCompileErrorHandler(ErrorHandler compileErrorHandler) By default, CompileExceptions are thrown on compile errors, but an application my install its own ErrorHandler.
void	setDebugLines(boolean value) Equivalent of -g:lines.
void	setDebugSource(boolean value) Equivalent of -g:source.
void	setDebugVars(boolean value) Equivalent of -g:vars.
void	setDestinationDirectory(File destinationDirectory, boolean rebuild) Equivalent of -d and -rebuild.
void	setEncoding(Charset encoding) Equivalent of -encoding.
void	setExtensionDirectories(File[] directories) Equivalent of -extdirs.
void	setSourceFinder(ResourceFinder sourceFinder) Finds more .java resources that need to be compiled, i.e. implements the "source path".
void	setSourcePath(File[] directoriesAndArchives) Equivalent of --source-path.
void	setWarningHandler(WarningHandler warningHandler) By default, warnings are discarded, but an application my install a custom WarningHandler.

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

compile, setVerbose

Field Detail

sourceFinder

protected ResourceFinder sourceFinder

classFileFinder

protected ResourceFinder classFileFinder

classFileCreator

protected ResourceCreator classFileCreator

encoding

public Charset encoding

debugSource

protected boolean debugSource

debugLines

protected boolean debugLines

debugVars

protected boolean debugVars

extensionDirectories

protected File[] extensionDirectories

The list of extension directories of the currently executing JRE. Empty for Java 9+, because the system property "java.ext.dirs" is not set in JRE 9+.

classPath

protected File[] classPath

The classpath of the currently executing JRE.

bootClassPath

@Nullable
protected File[] bootClassPath

This is always non-null for JVMs that support BOOTCLASSPATH (1.0-1.8), and this is always null for JVMs that don't (9+).

compileErrorHandler

@Nullable
protected ErrorHandler compileErrorHandler

warningHandler

@Nullable
protected WarningHandler warningHandler

Constructor Detail

AbstractCompiler

public AbstractCompiler()

Method Detail

setSourceFinder

public void setSourceFinder(ResourceFinder sourceFinder)

Description copied from interface: ICompiler

Finds more .java resources that need to be compiled, i.e. implements the "source path".

Specified by:

setSourceFinder in interface ICompiler

setClassFileFinder

public final void setClassFileFinder(ResourceFinder destination,
                                     boolean rebuild)

Description copied from interface: ICompiler

Equivalent with setClassFileFinder(rebuild ? ResourceFinder.EMPTY_RESOURCE_FINDER : destination).

Specified by:

setClassFileFinder in interface ICompiler

setClassFileFinder

public void setClassFileFinder(ResourceFinder classFileFinder)

Description copied from interface: ICompiler

This ResourceFinder is used to check whether a .class resource already exists and is younger than the .java resource from which it was generated.

If it is impossible to check whether an already-compiled class file exists, or if you want to enforce recompilation, pass ResourceFinder.EMPTY_RESOURCE_FINDER as the classFileFinder.

The default is, as for JAVAC, ICompiler.FIND_NEXT_TO_SOURCE_FILE.

Specified by:

setClassFileFinder in interface ICompiler

Parameters:

classFileFinder - Special value ICompiler.FIND_NEXT_TO_SOURCE_FILE means ".class file is next to its source file, not in the destination directory"

See Also:

ICompiler.FIND_NEXT_TO_SOURCE_FILE

setClassFileCreator

public final void setClassFileCreator(ResourceCreator classFileCreator)

Specified by:

setClassFileCreator in interface 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"

compile

public final boolean compile(File[] sourceFiles)
                      throws CompileException,
                             IOException

Description copied from interface: ICompiler

Reads a set of Java compilation units (a.k.a. "source files") from the file system, compiles them into a set of "class files" and stores these in the file system. Additional source files are parsed and compiled on demand through the "source path" set of directories.

For example, if the source path comprises the directories "A/B" and "../C", then the source file for class "com.acme.Main" is searched in

A/B/com/acme/Main.java

../C/com/acme/Main.java

Notice that it does make a difference whether you pass multiple source files to ICompiler.compile(File[]) or if you invoke ICompiler.compile(File[]) multiply: In the former case, the source files may contain arbitrary references among each other (even circular ones). In the latter case, only the source files on the source path may contain circular references, not the sourceFiles.

This method must be called exactly once after object construction.

Compile errors are reported as described at ICompiler.setCompileErrorHandler(ErrorHandler).

Specified by:

compile in interface ICompiler

Parameters:

sourceFiles - Contain the compilation units to compile

Returns:

true for backwards compatibility (return value can safely be ignored)

Throws:

CompileException - Fatal compilation error, or the CompileException thrown be the installed compile error handler

IOException - Occurred when reading from the sourceFiles

setEncoding

public void setEncoding(Charset encoding)

Description copied from interface: ICompiler

Equivalent of -encoding.

Specified by:

setEncoding in interface ICompiler

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 String characterEncoding)

Description copied from interface: ICompiler

Equivalent with setEncoding(Charset.forName(characterEncoding)).

Specified by:

setCharacterEncoding in interface ICompiler

setDebugLines

public void setDebugLines(boolean value)

Description copied from interface: ICompiler

Equivalent of -g:lines.

Specified by:

setDebugLines in interface ICompiler

setDebugVars

public void setDebugVars(boolean value)

Description copied from interface: ICompiler

Equivalent of -g:vars.

Specified by:

setDebugVars in interface ICompiler

setDebugSource

public void setDebugSource(boolean value)

Description copied from interface: ICompiler

Equivalent of -g:source.

Specified by:

setDebugSource in interface ICompiler

setSourcePath

public void setSourcePath(File[] directoriesAndArchives)

Description copied from interface: ICompiler

Equivalent of --source-path.

Equivalent with setSourceFinder(new PathResourceFinder(directoriesAndArchives)).

Specified by:

setSourcePath in interface ICompiler

setBootClassPath

public void setBootClassPath(File[] directoriesAndArchives)

Description copied from interface: ICompiler

Equivalent of --boot-class-path.

Specified by:

setBootClassPath in interface ICompiler

setExtensionDirectories

public void setExtensionDirectories(File[] directories)

Description copied from interface: ICompiler

Equivalent of -extdirs.

Specified by:

setExtensionDirectories in interface ICompiler

setClassPath

public void setClassPath(File[] directoriesAndArchives)

Description copied from interface: ICompiler

Equivalent of --class-path.

Specified by:

setClassPath in interface ICompiler

setDestinationDirectory

public final void setDestinationDirectory(@Nullable
                                          File destinationDirectory,
                                          boolean rebuild)

Description copied from interface: ICompiler

Equivalent of -d and -rebuild.

Overrides any previously configured class file finder and class file creator.

Specified by:

setDestinationDirectory in interface ICompiler

Parameters:

destinationDirectory - ICompiler.NO_DESTINATION_DIRECTORY means "create .class resources in the directory of the .java resource from which they are generated"

See Also:

ICompiler.NO_DESTINATION_DIRECTORY, ICompiler.setClassFileFinder(ResourceFinder), ICompiler.setClassFileCreator(ResourceCreator)

setCompileErrorHandler

public void setCompileErrorHandler(@Nullable
                                   ErrorHandler compileErrorHandler)

Description copied from interface: ICompiler

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 ICompiler

Parameters:

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

setWarningHandler

public void setWarningHandler(@Nullable
                              WarningHandler warningHandler)

Description copied from interface: ICompiler

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

Specified by:

setWarningHandler in interface ICompiler

Parameters:

warningHandler - null to indicate that no warnings be issued