ICompiler (commons-compiler 3.0.16 API)

java.lang.Object
- org.codehaus.commons.compiler.ICompiler

public abstract class ICompiler
extends Object

A simplified substitute for the javac tool.

Field Summary

Fields
Modifier and Type	Field and Description
`static ResourceCreator`	`CREATE_NEXT_TO_SOURCE_FILE` Special value for `setClassFileCreator(ResourceCreator)`: Indicates that .class resources are to be created in the directory of the .java resource from which they are generated.
`static ResourceFinder`	`FIND_NEXT_TO_SOURCE_FILE` Special value for `setClassFileFinder(ResourceFinder)`.
`static File`	`NO_DESTINATION_DIRECTORY` Special value for `setDestinationDirectory(File)`'s parameter: Indicates that .class files are to be created in the directory of the .java file from which they are generated.

Constructor Summary

Constructors
Constructor and Description

ICompiler()

Constructors
Constructor and Description
`ICompiler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compile(File[] sourceFiles)` Reads a set of Java compilation units (a.k.a.
`abstract void`	`compile(Resource[] sourceResources)` See `compile(File[])`.
`abstract void`	`setBootClassPath(File[] directoriesAndArchives)` Equivalent of `--boot-class-path`.
`void`	`setCharacterEncoding(String characterEncoding)`
`abstract void`	`setClassFileCreator(ResourceCreator classFileCreator)`
`abstract void`	`setClassFileFinder(ResourceFinder resourceFinder)` This `ResourceFinder` is used to check whether a .class resource already exists and is younger than the .java resource from which it was generated.
`abstract void`	`setClassPath(File[] directoriesAndArchives)` Equivalent of --class-path.
`abstract void`	`setCompileErrorHandler(ErrorHandler errorHandler)` By default, `CompileException`s are thrown on compile errors, but an application my install its own `ErrorHandler`.
`abstract void`	`setDebugLines(boolean value)` Equivalent of `-g:lines`.
`abstract void`	`setDebugSource(boolean value)` Equivalent of `-g:source`.
`abstract void`	`setDebugVars(boolean value)` Equivalent of `-g:vars`.
`void`	`setDestinationDirectory(File destinationDirectory)` Equivalent of -d.
`abstract void`	`setEncoding(Charset encoding)` Equivalent of -encoding.
`abstract void`	`setExtensionDirectories(File[] directories)` Equivalent of `-extdirs`.
`void`	`setRebuild(boolean value)` Equivalent of `-rebuild`.
`abstract void`	`setSourceFinder(ResourceFinder sourceFinder)` Finds more .java resources that need to be compiled, i.e. implements the "source path".
`abstract void`	`setSourcePath(File[] directoriesAndArchives)` Equivalent of `--source-path`.
`abstract void`	`setVerbose(boolean verbose)` Equivalent of `-verbose`.
`abstract 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

- Field Detail
  - NO_DESTINATION_DIRECTORY
```
@Nullable
public static final File NO_DESTINATION_DIRECTORY
```
    Special value for setDestinationDirectory(File)'s parameter: Indicates that .class files are to be created in the directory of the .java file from which they are generated.
  - FIND_NEXT_TO_SOURCE_FILE
```
@Nullable
public static final ResourceFinder FIND_NEXT_TO_SOURCE_FILE
```
    Special value for setClassFileFinder(ResourceFinder).
    
    See Also:
    
    setClassFileFinder(ResourceFinder)
  - CREATE_NEXT_TO_SOURCE_FILE
```
@Nullable
public static final ResourceCreator CREATE_NEXT_TO_SOURCE_FILE
```
    Special value for setClassFileCreator(ResourceCreator): Indicates that .class resources are to be created in the directory of the .java resource from which they are generated.
- Constructor Detail
  - ICompiler
```
public ICompiler()
```
- Method Detail
  - setEncoding
```
public abstract void setEncoding(@Nullable
                                 Charset encoding)
```
    Equivalent of -encoding.
  - setDebugLines
```
public abstract void setDebugLines(boolean value)
```
    Equivalent of -g:lines.
  - setDebugVars
```
public abstract void setDebugVars(boolean value)
```
    Equivalent of -g:vars.
  - setDebugSource
```
public abstract void setDebugSource(boolean value)
```
    Equivalent of -g:source.
  - setSourcePath
```
public abstract void setSourcePath(File[] directoriesAndArchives)
```
    Equivalent of --source-path.
  - setBootClassPath
```
public abstract void setBootClassPath(File[] directoriesAndArchives)
```
    Equivalent of --boot-class-path.
  - setExtensionDirectories
```
public abstract void setExtensionDirectories(File[] directories)
```
    Equivalent of -extdirs.
  - setClassPath
```
public abstract void setClassPath(File[] directoriesAndArchives)
```
    Equivalent of --class-path.
  - setDestinationDirectory
```
public final void setDestinationDirectory(@Nullable
                                          File destinationDirectory)
```
    Equivalent of -d.
    
    Parameters:
    
    destinationDirectory - NO_DESTINATION_DIRECTORY means "create .class resources in the directory of the .java resource from which they are generated"
    
    See Also:
    
    NO_DESTINATION_DIRECTORY
  - setVerbose
```
public abstract void setVerbose(boolean verbose)
```
    Equivalent of -verbose.
  - setRebuild
```
public final void setRebuild(boolean value)
```
    Equivalent of -rebuild.
  - setSourceFinder
```
public abstract void setSourceFinder(ResourceFinder sourceFinder)
```
    Finds more .java resources that need to be compiled, i.e. implements the "source path".
    
    Parameters:
    
    sourceFinder -
  - setClassFileCreator
```
public abstract void setClassFileCreator(@Nullable
                                         ResourceCreator classFileCreator)
```
    Parameters:
    
    classFileCreator - Sess CREATE_NEXT_TO_SOURCE_FILE
  - compile
```
public final boolean compile(File[] sourceFiles)
                      throws CompileException,
                             IOException
```
    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 compile(File[]) or if you invoke 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 setCompileErrorHandler(ErrorHandler).
    
    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
  - setClassFileFinder
```
public abstract void setClassFileFinder(@Nullable
                                        ResourceFinder resourceFinder)
```
    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.
    
    Parameters:
    
    resourceFinder - Special value FIND_NEXT_TO_SOURCE_FILE means ".class file is next to its source file, not in the destination directory"
    
    See Also:
    
    FIND_NEXT_TO_SOURCE_FILE
  - setCharacterEncoding
```
public void setCharacterEncoding(@Nullable
                                 String characterEncoding)
```
  - compile
```
public abstract void compile(Resource[] sourceResources)
                      throws CompileException,
                             IOException
```
    See compile(File[]).
    
    Parameters:
    
    sourceResources - Contain the compilation units to compile
    
    Throws:
    
    CompileException
    
    IOException
  - setCompileErrorHandler
```
public abstract void setCompileErrorHandler(@Nullable
                                            ErrorHandler errorHandler)
```
    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.
    
    Parameters:
    
    errorHandler - null to restore the default behavior (throwing a CompileException
  - setWarningHandler
```
public abstract void setWarningHandler(WarningHandler warningHandler)
```
    By default, warnings are discarded, but an application my install a custom WarningHandler.
    
    Parameters:
    
    warningHandler - null to indicate that no warnings be issued

Class ICompiler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_DESTINATION_DIRECTORY

FIND_NEXT_TO_SOURCE_FILE

CREATE_NEXT_TO_SOURCE_FILE

Constructor Detail

ICompiler

Method Detail

setEncoding

setDebugLines

setDebugVars

setDebugSource

setSourcePath

setBootClassPath

setExtensionDirectories

setClassPath

setDestinationDirectory

setVerbose

setRebuild

setSourceFinder

setClassFileCreator

compile

setClassFileFinder

setCharacterEncoding

compile

setCompileErrorHandler

setWarningHandler