org.apache.tools.ant.taskdefs

Class Javac

Implemented Interfaces:
SelectorContainer

public class Javac
extends MatchingTask

Compiles Java source files. This task can take the following arguments: Of these arguments, the sourcedir and destdir are required.

When this task executes, it will recursively scan the sourcedir and destdir looking for Java source files to compile. This task makes its compile decision based on timestamp.

Since:
Ant 1.1

Nested Class Summary

class
Javac.ImplementationSpecificArgument
Adds an "compiler" attribute to Commandline$Attribute used to filter command line attributes based on the current implementation.

Field Summary

protected File[]
compileList
protected boolean
failOnError
protected boolean
listFiles

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

Javac()
Javac task for compilation of Java files.

Method Summary

protected void
checkParameters()
Check that all required attributes have been set and nothing silly has been entered.
protected void
compile()
Perform the compilation.
Path
createBootclasspath()
Adds a path to the bootclasspath.
Path
createClasspath()
Adds a path to the classpath.
Javac.ImplementationSpecificArgument
createCompilerArg()
Adds an implementation specific command-line argument.
Path
createExtdirs()
Adds a path to extdirs.
Path
createSourcepath()
Adds a path to sourcepath.
Path
createSrc()
Adds a path for source compilation.
void
execute()
Executes the task.
Path
getBootclasspath()
Gets the bootclasspath that will be used to compile the classes against.
Path
getClasspath()
Gets the classpath to be used for this compilation.
String
getCompiler()
The implementation for this particular task.
String
getCompilerVersion()
The implementation for this particular task.
String[]
getCurrentCompilerArgs()
Get the additional implementation specific command line arguments.
boolean
getDebug()
Gets the debug flag.
String
getDebugLevel()
Get the value of debugLevel.
boolean
getDepend()
Gets the depend flag.
boolean
getDeprecation()
Gets the deprecation flag.
File
getDestdir()
Gets the destination directory into which the java source files should be compiled.
String
getEncoding()
Gets the java source file encoding name.
String
getExecutable()
The value of the executable attribute, if any.
Path
getExtdirs()
Gets the extension directories that will be used during the compilation.
boolean
getFailonerror()
Gets the failonerror flag.
File[]
getFileList()
Gets the list of files to be compiled.
boolean
getIncludeantruntime()
Gets whether or not the ant classpath is to be included in the classpath.
boolean
getIncludejavaruntime()
Gets whether or not the java runtime should be included in this task's classpath.
String
getJavacExecutable()
The name of the javac executable to use in fork-mode.
boolean
getListfiles()
Get the listfiles flag.
String
getMemoryInitialSize()
Gets the memoryInitialSize flag.
String
getMemoryMaximumSize()
Gets the memoryMaximumSize flag.
boolean
getNowarn()
Should the -nowarn option be used.
boolean
getOptimize()
Gets the optimize flag.
String
getSource()
Get the value of source.
Path
getSourcepath()
Gets the sourcepath to be used for this compilation.
Path
getSrcdir()
Gets the source dirs to find the source java files.
protected String
getSystemJavac()
String
getTarget()
Gets the target VM that the classes will be compiled for.
File
getTempdir()
Where Ant should place temporary files.
boolean
getVerbose()
Gets the verbose flag.
boolean
isForkedJavac()
Is this a forked invocation of JDK's javac?
protected boolean
isJdkCompiler(String compilerImpl)
Is the compiler implementation a jdk compiler
protected Path
recreateSrc()
Recreate src.
protected void
resetFileLists()
Clear the list of files to be compiled and copied..
protected void
scanDir(File srcDir, File destDir, String[] files)
Scans the directory looking for source files to be compiled.
void
setBootClasspathRef(Reference r)
Adds a reference to a classpath defined elsewhere.
void
setBootclasspath(Path bootclasspath)
Sets the bootclasspath that will be used to compile the classes against.
void
setClasspath(Path classpath)
Set the classpath to be used for this compilation.
void
setClasspathRef(Reference r)
Adds a reference to a classpath defined elsewhere.
void
setCompiler(String compiler)
Choose the implementation for this particular task.
void
setDebug(boolean debug)
Indicates whether source should be compiled with debug information; defaults to off.
void
setDebugLevel(String v)
Keyword list to be appended to the -g command-line switch.
void
setDepend(boolean depend)
Enables dependency-tracking for compilers that support this (jikes and classic).
void
setDeprecation(boolean deprecation)
Indicates whether source should be compiled with deprecation information; defaults to off.
void
setDestdir(File destDir)
Set the destination directory into which the Java source files should be compiled.
void
setEncoding(String encoding)
Set the Java source file encoding name.
void
setExecutable(String forkExec)
Sets the name of the javac executable.
void
setExtdirs(Path extdirs)
Sets the extension directories that will be used during the compilation.
void
setFailonerror(boolean fail)
Indicates whether the build will continue even if there are compilation errors; defaults to true.
void
setFork(boolean f)
If true, forks the javac compiler.
void
setIncludeantruntime(boolean include)
If true, includes Ant's own classpath in the classpath.
void
setIncludejavaruntime(boolean include)
If true, includes the Java runtime libraries in the classpath.
void
setListfiles(boolean list)
If true, list the source files being handed off to the compiler.
void
setMemoryInitialSize(String memoryInitialSize)
The initial size of the memory for the underlying VM if javac is run externally; ignored otherwise.
void
setMemoryMaximumSize(String memoryMaximumSize)
The maximum size of the memory for the underlying VM if javac is run externally; ignored otherwise.
void
setNowarn(boolean flag)
If true, enables the -nowarn option.
void
setOptimize(boolean optimize)
If true, compiles with optimization enabled.
void
setProceed(boolean proceed)
void
setSource(String v)
Value of the -source command-line switch; will be ignored by all implementations except modern and jikes.
void
setSourcepath(Path sourcepath)
Set the sourcepath to be used for this compilation.
void
setSourcepathRef(Reference r)
Adds a reference to a source path defined elsewhere.
void
setSrcdir(Path srcDir)
Set the source directories to find the source Java files.
void
setTarget(String target)
Sets the target VM that the classes will be compiled for.
void
setTempdir(File tmpDir)
Where Ant should place temporary files.
void
setVerbose(boolean verbose)
If true, asks the compiler for verbose output.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

XsetIgnore, XsetItems, add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

compileList

protected File[] compileList

failOnError

protected boolean failOnError

listFiles

protected boolean listFiles

Constructor Details

Javac

public Javac()
Javac task for compilation of Java files.

Method Details

checkParameters

protected void checkParameters()
            throws BuildException
Check that all required attributes have been set and nothing silly has been entered.
Throws:
BuildException - if an error occurs
Since:
Ant 1.5

compile

protected void compile()
Perform the compilation.
Since:
Ant 1.5

createBootclasspath

public Path createBootclasspath()
Adds a path to the bootclasspath.
Returns:
a path to be configured

createClasspath

public Path createClasspath()
Adds a path to the classpath.
Returns:
a class path to be configured

createCompilerArg

public Javac.ImplementationSpecificArgument createCompilerArg()
Adds an implementation specific command-line argument.
Returns:
a ImplementationSpecificArgument to be configured

createExtdirs

public Path createExtdirs()
Adds a path to extdirs.
Returns:
a path to be configured

createSourcepath

public Path createSourcepath()
Adds a path to sourcepath.
Returns:
a sourcepath to be configured

createSrc

public Path createSrc()
Adds a path for source compilation.
Returns:
a nested src element.

execute

public void execute()
            throws BuildException
Executes the task.
Overrides:
execute in interface Task
Throws:
BuildException - if an error occurs

getBootclasspath

public Path getBootclasspath()
Gets the bootclasspath that will be used to compile the classes against.
Returns:
the boot path

getClasspath

public Path getClasspath()
Gets the classpath to be used for this compilation.
Returns:
the class path

getCompiler

public String getCompiler()
The implementation for this particular task.

Defaults to the build.compiler property but can be overridden via the compiler and fork attributes.

If fork has been set to true, the result will be extJavac and not classic or java1.2 - no matter what the compiler attribute looks like.

Since:
Ant 1.5

getCompilerVersion

public String getCompilerVersion()
The implementation for this particular task.

Defaults to the build.compiler property but can be overridden via the compiler attribute.

This method does not take the fork attribute into account.

Since:
Ant 1.5

getCurrentCompilerArgs

public String[] getCurrentCompilerArgs()
Get the additional implementation specific command line arguments.
Returns:
array of command line arguments, guaranteed to be non-null.

getDebug

public boolean getDebug()
Gets the debug flag.
Returns:
the debug flag

getDebugLevel

public String getDebugLevel()
Get the value of debugLevel.
Returns:
value of debugLevel.

getDepend

public boolean getDepend()
Gets the depend flag.
Returns:
the depend flag

getDeprecation

public boolean getDeprecation()
Gets the deprecation flag.
Returns:
the deprecation flag

getDestdir

public File getDestdir()
Gets the destination directory into which the java source files should be compiled.
Returns:
the destination directory

getEncoding

public String getEncoding()
Gets the java source file encoding name.
Returns:
the source file encoding name

getExecutable

public String getExecutable()
The value of the executable attribute, if any.
Returns:
the name of the java executable
Since:
Ant 1.6

getExtdirs

public Path getExtdirs()
Gets the extension directories that will be used during the compilation.
Returns:
the extension directories as a path

getFailonerror

public boolean getFailonerror()
Gets the failonerror flag.
Returns:
the failonerror flag

getFileList

public File[] getFileList()
Gets the list of files to be compiled.
Returns:
the list of files as an array

getIncludeantruntime

public boolean getIncludeantruntime()
Gets whether or not the ant classpath is to be included in the classpath.
Returns:
whether or not the ant classpath is to be included in the classpath

getIncludejavaruntime

public boolean getIncludejavaruntime()
Gets whether or not the java runtime should be included in this task's classpath.
Returns:
the includejavaruntime attribute

getJavacExecutable

public String getJavacExecutable()
Returns:
the name of the javac executable

getListfiles

public boolean getListfiles()
Get the listfiles flag.
Returns:
the listfiles flag

getMemoryInitialSize

public String getMemoryInitialSize()
Gets the memoryInitialSize flag.
Returns:
the memoryInitialSize flag

getMemoryMaximumSize

public String getMemoryMaximumSize()
Gets the memoryMaximumSize flag.
Returns:
the memoryMaximumSize flag

getNowarn

public boolean getNowarn()
Should the -nowarn option be used.
Returns:
true if the -nowarn option should be used

getOptimize

public boolean getOptimize()
Gets the optimize flag.
Returns:
the optimize flag

getSource

public String getSource()
Get the value of source.
Returns:
value of source.

getSourcepath

public Path getSourcepath()
Gets the sourcepath to be used for this compilation.
Returns:
the source path

getSrcdir

public Path getSrcdir()
Gets the source dirs to find the source java files.
Returns:
the source directories as a path

getSystemJavac

protected String getSystemJavac()
Returns:
the executable name of the java compiler

getTarget

public String getTarget()
Gets the target VM that the classes will be compiled for.
Returns:
the target VM

getTempdir

public File getTempdir()
Where Ant should place temporary files.
Returns:
the temporary directory
Since:
Ant 1.6

getVerbose

public boolean getVerbose()
Gets the verbose flag.
Returns:
the verbose flag

isForkedJavac

public boolean isForkedJavac()
Is this a forked invocation of JDK's javac?
Returns:
true if this is a forked invocation

isJdkCompiler

protected boolean isJdkCompiler(String compilerImpl)
Is the compiler implementation a jdk compiler
Parameters:
compilerImpl - the name of the compiler implementation
Returns:
true if compilerImpl is "modern", "classic", "javac1.1", "javac1.2", "javac1.3", "javac1.4" or "javac1.5".

recreateSrc

protected Path recreateSrc()
Recreate src.
Returns:
a nested src element.

resetFileLists

protected void resetFileLists()
Clear the list of files to be compiled and copied..

scanDir

protected void scanDir(File srcDir,
                       File destDir,
                       String[] files)
Scans the directory looking for source files to be compiled. The results are returned in the class variable compileList
Parameters:
srcDir - The source directory
destDir - The destination directory
files - An array of filenames

setBootClasspathRef

public void setBootClasspathRef(Reference r)
Adds a reference to a classpath defined elsewhere.
Parameters:
r - a reference to a classpath

setBootclasspath

public void setBootclasspath(Path bootclasspath)
Sets the bootclasspath that will be used to compile the classes against.
Parameters:
bootclasspath - a path to use as a boot class path (may be more than one)

setClasspath

public void setClasspath(Path classpath)
Set the classpath to be used for this compilation.
Parameters:
classpath - an Ant Path object containing the compilation classpath.

setClasspathRef

public void setClasspathRef(Reference r)
Adds a reference to a classpath defined elsewhere.
Parameters:
r - a reference to a classpath

setCompiler

public void setCompiler(String compiler)
Choose the implementation for this particular task.
Parameters:
compiler - the name of the compiler
Since:
Ant 1.5

setDebug

public void setDebug(boolean debug)
Indicates whether source should be compiled with debug information; defaults to off.
Parameters:
debug - if true compile with debug information

setDebugLevel

public void setDebugLevel(String v)
Keyword list to be appended to the -g command-line switch. This will be ignored by all implementations except modern and classic(ver >= 1.2). Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. If debuglevel is not specified, by default, :none will be appended to -g. If debug is not turned on, this attribute will be ignored.
Parameters:
v - Value to assign to debugLevel.

setDepend

public void setDepend(boolean depend)
Enables dependency-tracking for compilers that support this (jikes and classic).
Parameters:
depend - if true enable dependency-tracking

setDeprecation

public void setDeprecation(boolean deprecation)
Indicates whether source should be compiled with deprecation information; defaults to off.
Parameters:
deprecation - if true turn on deprecation information

setDestdir

public void setDestdir(File destDir)
Set the destination directory into which the Java source files should be compiled.
Parameters:
destDir - the destination director

setEncoding

public void setEncoding(String encoding)
Set the Java source file encoding name.
Parameters:
encoding - the source file encoding

setExecutable

public void setExecutable(String forkExec)
Sets the name of the javac executable.

Ignored unless fork is true or extJavac has been specified as the compiler.

Parameters:
forkExec - the name of the executable

setExtdirs

public void setExtdirs(Path extdirs)
Sets the extension directories that will be used during the compilation.
Parameters:
extdirs - a path

setFailonerror

public void setFailonerror(boolean fail)
Indicates whether the build will continue even if there are compilation errors; defaults to true.
Parameters:
fail - if true halt the build on failure

setFork

public void setFork(boolean f)
If true, forks the javac compiler.
Parameters:
f - "true|false|on|off|yes|no"

setIncludeantruntime

public void setIncludeantruntime(boolean include)
If true, includes Ant's own classpath in the classpath.
Parameters:
include - if true, includes Ant's own classpath in the classpath

setIncludejavaruntime

public void setIncludejavaruntime(boolean include)
If true, includes the Java runtime libraries in the classpath.
Parameters:
include - if true, includes the Java runtime libraries in the classpath

setListfiles

public void setListfiles(boolean list)
If true, list the source files being handed off to the compiler.
Parameters:
list - if true list the source files

setMemoryInitialSize

public void setMemoryInitialSize(String memoryInitialSize)
The initial size of the memory for the underlying VM if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
Parameters:
memoryInitialSize - string to pass to VM

setMemoryMaximumSize

public void setMemoryMaximumSize(String memoryMaximumSize)
The maximum size of the memory for the underlying VM if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
Parameters:
memoryMaximumSize - string to pass to VM

setNowarn

public void setNowarn(boolean flag)
If true, enables the -nowarn option.
Parameters:
flag - if true, enable the -nowarn option

setOptimize

public void setOptimize(boolean optimize)
If true, compiles with optimization enabled.
Parameters:
optimize - if true compile with optimization enabled

setProceed

public void setProceed(boolean proceed)
Parameters:
proceed - inverse of failoferror

setSource

public void setSource(String v)
Value of the -source command-line switch; will be ignored by all implementations except modern and jikes. If you use this attribute together with jikes, you must make sure that your version of jikes supports the -source switch. Legal values are 1.3, 1.4 and 1.5 - by default, no -source argument will be used at all.
Parameters:
v - Value to assign to source.

setSourcepath

public void setSourcepath(Path sourcepath)
Set the sourcepath to be used for this compilation.
Parameters:
sourcepath - the source path

setSourcepathRef

public void setSourcepathRef(Reference r)
Adds a reference to a source path defined elsewhere.
Parameters:
r - a reference to a source path

setSrcdir

public void setSrcdir(Path srcDir)
Set the source directories to find the source Java files.
Parameters:
srcDir - the source directories as a path

setTarget

public void setTarget(String target)
Sets the target VM that the classes will be compiled for. Valid values depend on the compiler, for jdk 1.4 the valid values are "1.1", "1.2", "1.3", "1.4" and "1.5".
Parameters:
target - the target VM

setTempdir

public void setTempdir(File tmpDir)
Where Ant should place temporary files.
Parameters:
tmpDir - the temporary directory
Since:
Ant 1.6

setVerbose

public void setVerbose(boolean verbose)
If true, asks the compiler for verbose output.
Parameters:
verbose - if true, asks the compiler for verbose output

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.