Class Javac
- All Implemented Interfaces:
Cloneable
,SelectorContainer
- sourcedir
- destdir
- deprecation
- classpath
- bootclasspath
- extdirs
- optimize
- debug
- encoding
- target
- depend
- verbose
- failonerror
- includeantruntime
- includejavaruntime
- source
- compiler
- release
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
Modifier and TypeClassDescriptionclass
Adds an "compiler" attribute to Commandline$Attribute used to filter command line attributes based on the current implementation. -
Field Summary
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
fileset
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(CompilerAdapter adapter) Set the compiler adapter explicitly.protected void
Check that all required attributes have been set and nothing silly has been entered.protected void
compile()
Perform the compilation.Adds a path to the bootclasspath.Adds a path to the classpath.Adds an implementation specific command-line argument.The classpath to use when loading the compiler implementation if it is not a built-in one.Adds a path to extdirs.Adds a path to the modulepath.Adds a path to modulesourcepath.Adds a path to sourcepath.Adds a path for source compilation.Adds a path to the upgrademodulepath.void
execute()
Executes the task.Gets the bootclasspath that will be used to compile the classes against.Gets the classpath to be used for this compilation.The implementation for this particular task.The implementation for this particular task.String[]
Get the additional implementation specific command line arguments.boolean
getDebug()
Gets the debug flag.Get the value of debugLevel.boolean
Gets the depend flag.boolean
Gets the deprecation flag.Gets the destination directory into which the java source files should be compiled.Gets the java source file encoding name.The value of the executable attribute, if any.Gets the extension directories that will be used during the compilation.boolean
Gets the failonerror flag.File[]
Gets the list of files to be compiled.boolean
Gets whether or not the ant classpath is to be included in the classpath.boolean
Gets whether or not the java runtime should be included in this task's classpath.The name of the javac executable to use in fork-mode.boolean
Get the listfiles flag.Gets the memoryInitialSize flag.Gets the memoryMaximumSize flag.Gets the modulepath to be used for this compilation.Gets the modulesourcepath to be used for this compilation.Gets the destination directory into which the generated native header files should be placed.boolean
Should the -nowarn option be used.boolean
Gets the optimize flag.Gets the version to use for the--release
switch that combinessource
,target
and setting the bootclasspath.Get the value of source.Gets the sourcepath to be used for this compilation.Gets the source dirs to find the source java files.protected String
Gets the target VM that the classes will be compiled for.boolean
Get the result of the javac task (success or failure).Where Ant should place temporary files.Gets the upgrademodulepath to be used for this compilation.boolean
Gets the verbose flag.boolean
Is this a forked invocation of JDK's javac?boolean
Get the value of the includeDestClasses property.protected boolean
isJdkCompiler
(String compilerImpl) Is the compiler implementation a jdk compilerprotected Path
Recreate src.protected void
Clear the list of files to be compiled and copied..protected void
Scans the directory looking for source files to be compiled.void
setBootclasspath
(Path bootclasspath) Sets the bootclasspath that will be used to compile the classes against.void
Adds a reference to a classpath defined elsewhere.void
setClasspath
(Path classpath) Set the classpath to be used for this compilation.void
Adds a reference to a classpath defined elsewhere.void
setCompiler
(String compiler) Choose the implementation for this particular task.void
setCreateMissingPackageInfoClass
(boolean b) Whether package-info.class files will be created by Ant matching package-info.java files that have been compiled but didn't create class files themselves.void
setDebug
(boolean debug) Indicates whether source should be compiled with debug information; defaults to off.void
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
setErrorProperty
(String errorProperty) The property to set on compilation failure.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
setIncludeDestClasses
(boolean includeDestClasses) This property controls whether to include the destination classes directory in the classpath given to the compiler.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
setModulepath
(Path mp) Set the modulepath to be used for this compilation.void
Adds a reference to a modulepath defined elsewhere.void
setModulesourcepath
(Path msp) Set the modulesourcepath to be used for this compilation.void
Adds a reference to a modulesourcepath defined elsewhere.void
setNativeHeaderDir
(File nhDir) Set the destination directory into which the generated native header files should be placed.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
setRelease
(String release) Sets the version to use for the--release
switch that combinessource
,target
and setting the bootclasspath.void
Value of the -source command-line switch; will be ignored by all implementations except modern, jikes and gcj (gcj uses -fsource).void
setSourcepath
(Path sourcepath) Set the sourcepath to be used for this compilation.void
Adds a reference to a source path defined elsewhere.void
Set the source directories to find the source Java files.void
Sets the target VM that the classes will be compiled for.void
setTempdir
(File tmpDir) Where Ant should place temporary files.void
setUpdatedProperty
(String updatedProperty) The property to set on compilation success.void
setUpgrademodulepath
(Path ump) Set the upgrademodulepath to be used for this compilation.void
Adds a reference to the upgrademodulepath defined elsewhere.void
setVerbose
(boolean verbose) If true, asks the compiler for verbose output.Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
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, XsetIgnore, XsetItems
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation
-
Field Details
-
failOnError
protected boolean failOnError -
listFiles
protected boolean listFiles -
compileList
-
-
Constructor Details
-
Javac
public Javac()Javac task for compilation of Java files.
-
-
Method Details
-
getDebugLevel
-
setDebugLevel
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.
-
getSource
-
setSource
Value of the -source command-line switch; will be ignored by all implementations except modern, jikes and gcj (gcj uses -fsource).If you use this attribute together with jikes or gcj, you must make sure that your version of jikes supports the -source switch.
Legal values are 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, and any integral number bigger than 4 - by default, no -source argument will be used at all.
- Parameters:
v
- Value to assign to source.
-
createSrc
-
recreateSrc
-
setSrcdir
Set the source directories to find the source Java files.- Parameters:
srcDir
- the source directories as a path
-
getSrcdir
Gets the source dirs to find the source java files.- Returns:
- the source directories as a path
-
setDestdir
Set the destination directory into which the Java source files should be compiled.- Parameters:
destDir
- the destination director
-
getDestdir
Gets the destination directory into which the java source files should be compiled.- Returns:
- the destination directory
-
setNativeHeaderDir
Set the destination directory into which the generated native header files should be placed.- Parameters:
nhDir
- where to place generated native header files- Since:
- Ant 1.9.8
-
getNativeHeaderDir
Gets the destination directory into which the generated native header files should be placed.- Returns:
- where to place generated native header files
- Since:
- Ant 1.9.8
-
setSourcepath
Set the sourcepath to be used for this compilation.- Parameters:
sourcepath
- the source path
-
getSourcepath
Gets the sourcepath to be used for this compilation.- Returns:
- the source path
-
createSourcepath
-
setSourcepathRef
Adds a reference to a source path defined elsewhere.- Parameters:
r
- a reference to a source path
-
setModulesourcepath
Set the modulesourcepath to be used for this compilation.- Parameters:
msp
- the modulesourcepath- Since:
- 1.9.7
-
getModulesourcepath
Gets the modulesourcepath to be used for this compilation.- Returns:
- the modulesourcepath
- Since:
- 1.9.7
-
createModulesourcepath
Adds a path to modulesourcepath.- Returns:
- a modulesourcepath to be configured
- Since:
- 1.9.7
-
setModulesourcepathRef
Adds a reference to a modulesourcepath defined elsewhere.- Parameters:
r
- a reference to a modulesourcepath- Since:
- 1.9.7
-
setClasspath
Set the classpath to be used for this compilation.- Parameters:
classpath
- an Ant Path object containing the compilation classpath.
-
getClasspath
Gets the classpath to be used for this compilation.- Returns:
- the class path
-
createClasspath
-
setClasspathRef
Adds a reference to a classpath defined elsewhere.- Parameters:
r
- a reference to a classpath
-
setModulepath
Set the modulepath to be used for this compilation.- Parameters:
mp
- an Ant Path object containing the modulepath.- Since:
- 1.9.7
-
getModulepath
Gets the modulepath to be used for this compilation.- Returns:
- the modulepath
- Since:
- 1.9.7
-
createModulepath
Adds a path to the modulepath.- Returns:
- a modulepath to be configured
- Since:
- 1.9.7
-
setModulepathRef
Adds a reference to a modulepath defined elsewhere.- Parameters:
r
- a reference to a modulepath- Since:
- 1.9.7
-
setUpgrademodulepath
Set the upgrademodulepath to be used for this compilation.- Parameters:
ump
- an Ant Path object containing the upgrademodulepath.- Since:
- 1.9.7
-
getUpgrademodulepath
Gets the upgrademodulepath to be used for this compilation.- Returns:
- the upgrademodulepath
- Since:
- 1.9.7
-
createUpgrademodulepath
Adds a path to the upgrademodulepath.- Returns:
- an upgrademodulepath to be configured
- Since:
- 1.9.7
-
setUpgrademodulepathRef
Adds a reference to the upgrademodulepath defined elsewhere.- Parameters:
r
- a reference to an upgrademodulepath- Since:
- 1.9.7
-
setBootclasspath
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)
-
getBootclasspath
Gets the bootclasspath that will be used to compile the classes against.- Returns:
- the boot path
-
createBootclasspath
Adds a path to the bootclasspath.- Returns:
- a path to be configured
-
setBootClasspathRef
Adds a reference to a classpath defined elsewhere.- Parameters:
r
- a reference to a classpath
-
setExtdirs
Sets the extension directories that will be used during the compilation.- Parameters:
extdirs
- a path
-
getExtdirs
Gets the extension directories that will be used during the compilation.- Returns:
- the extension directories as a path
-
createExtdirs
-
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
-
getListfiles
public boolean getListfiles()Get the listfiles flag.- Returns:
- the listfiles flag
-
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
-
setProceed
public void setProceed(boolean proceed) - Parameters:
proceed
- inverse of failoferror
-
getFailonerror
public boolean getFailonerror()Gets the failonerror flag.- Returns:
- the failonerror flag
-
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
-
getDeprecation
public boolean getDeprecation()Gets the deprecation flag.- Returns:
- the deprecation flag
-
setMemoryInitialSize
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
-
getMemoryInitialSize
Gets the memoryInitialSize flag.- Returns:
- the memoryInitialSize flag
-
setMemoryMaximumSize
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
-
getMemoryMaximumSize
Gets the memoryMaximumSize flag.- Returns:
- the memoryMaximumSize flag
-
setEncoding
Set the Java source file encoding name.- Parameters:
encoding
- the source file encoding
-
getEncoding
Gets the java source file encoding name.- Returns:
- the source file encoding name
-
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
-
getDebug
public boolean getDebug()Gets the debug flag.- Returns:
- the debug flag
-
setOptimize
public void setOptimize(boolean optimize) If true, compiles with optimization enabled.- Parameters:
optimize
- if true compile with optimization enabled
-
getOptimize
public boolean getOptimize()Gets the optimize flag.- Returns:
- the optimize flag
-
setDepend
public void setDepend(boolean depend) Enables dependency-tracking for compilers that support this (jikes and classic).- Parameters:
depend
- if true enable dependency-tracking
-
getDepend
public boolean getDepend()Gets the depend flag.- Returns:
- the depend flag
-
setVerbose
public void setVerbose(boolean verbose) If true, asks the compiler for verbose output.- Parameters:
verbose
- if true, asks the compiler for verbose output
-
getVerbose
public boolean getVerbose()Gets the verbose flag.- Returns:
- the verbose flag
-
setTarget
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", "1.5", "1.6", "1.7", "1.8", "1.9" and any integral number bigger than 4- Parameters:
target
- the target VM
-
getTarget
Gets the target VM that the classes will be compiled for.- Returns:
- the target VM
-
setRelease
Sets the version to use for the--release
switch that combinessource
,target
and setting the bootclasspath. Values depend on the compiler, for jdk 9 the valid values are "6", "7", "8", "9".- Parameters:
release
- the value of the release attribute- Since:
- Ant 1.9.8
-
getRelease
Gets the version to use for the--release
switch that combinessource
,target
and setting the bootclasspath.- Returns:
- the value of the release attribute
- Since:
- Ant 1.9.8
-
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
-
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
-
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
-
getIncludejavaruntime
public boolean getIncludejavaruntime()Gets whether or not the java runtime should be included in this task's classpath.- Returns:
- the includejavaruntime attribute
-
setFork
public void setFork(boolean f) If true, forks the javac compiler.- Parameters:
f
- "true|false|on|off|yes|no"
-
setExecutable
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
-
getExecutable
The value of the executable attribute, if any.- Returns:
- the name of the java executable
- Since:
- Ant 1.6
-
isForkedJavac
public boolean isForkedJavac()Is this a forked invocation of JDK's javac?- Returns:
- true if this is a forked invocation
-
getJavacExecutable
The name of the javac executable to use in fork-mode.This is either the name specified with the executable attribute or the full path of the javac compiler of the VM Ant is currently running in - guessed by Ant.
You should not invoke this method if you want to get the value of the executable command - use
getExecutable
for this.- Returns:
- the name of the javac executable
-
setNowarn
public void setNowarn(boolean flag) If true, enables the -nowarn option.- Parameters:
flag
- if true, enable the -nowarn option
-
getNowarn
public boolean getNowarn()Should the -nowarn option be used.- Returns:
- true if the -nowarn option should be used
-
createCompilerArg
Adds an implementation specific command-line argument.- Returns:
- a ImplementationSpecificArgument to be configured
-
getCurrentCompilerArgs
Get the additional implementation specific command line arguments.- Returns:
- array of command line arguments, guaranteed to be non-null.
-
setTempdir
Where Ant should place temporary files.- Parameters:
tmpDir
- the temporary directory- Since:
- Ant 1.6
-
getTempdir
Where Ant should place temporary files.- Returns:
- the temporary directory
- Since:
- Ant 1.6
-
setUpdatedProperty
The property to set on compilation success. This property will not be set if the compilation fails, or if there are no files to compile.- Parameters:
updatedProperty
- the property name to use.- Since:
- Ant 1.7.1.
-
setErrorProperty
The property to set on compilation failure. This property will be set if the compilation fails.- Parameters:
errorProperty
- the property name to use.- Since:
- Ant 1.7.1.
-
setIncludeDestClasses
public void setIncludeDestClasses(boolean includeDestClasses) This property controls whether to include the destination classes directory in the classpath given to the compiler. The default value is "true".- Parameters:
includeDestClasses
- the value to use.
-
isIncludeDestClasses
public boolean isIncludeDestClasses()Get the value of the includeDestClasses property.- Returns:
- the value.
-
getTaskSuccess
public boolean getTaskSuccess()Get the result of the javac task (success or failure).- Returns:
- true if compilation succeeded, or was not necessary, false if the compilation failed.
-
createCompilerClasspath
The classpath to use when loading the compiler implementation if it is not a built-in one.- Returns:
- Path
- Since:
- Ant 1.8.0
-
add
Set the compiler adapter explicitly.- Parameters:
adapter
- CompilerAdapter- Since:
- Ant 1.8.0
-
setCreateMissingPackageInfoClass
public void setCreateMissingPackageInfoClass(boolean b) Whether package-info.class files will be created by Ant matching package-info.java files that have been compiled but didn't create class files themselves.- Parameters:
b
- boolean- Since:
- Ant 1.8.3
-
execute
Executes the task.- Overrides:
execute
in classTask
- Throws:
BuildException
- if an error occurs
-
resetFileLists
protected void resetFileLists()Clear the list of files to be compiled and copied.. -
scanDir
-
getFileList
Gets the list of files to be compiled.- Returns:
- the list of files as an array
-
isJdkCompiler
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", "javac1.5", "javac1.6", "javac1.7", "javac1.8", "javac1.9", "javac9" or "javac10+".
-
getSystemJavac
- Returns:
- the executable name of the java compiler
-
setCompiler
Choose the implementation for this particular task.- Parameters:
compiler
- the name of the compiler- Since:
- Ant 1.5
-
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.
- Returns:
- the compiler.
- Since:
- Ant 1.5
- See Also:
-
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.
- Returns:
- the compiler.
- Since:
- Ant 1.5
- See Also:
-
checkParameters
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
-