Liking cljdoc? Tell your friends :D
Clojure only.

clj-ant.tasks

Auto-generated Ant task and type wrappers.

Each function returns a clj-ant element (plain data); pass the result to clj-ant.core/ant (or execute!) to run.

Generated by clj -X:gen from org.apache.tools.ant version 1.10.17.

Auto-generated Ant task and type wrappers.

Each function returns a clj-ant element (plain data); pass
the result to `clj-ant.core/ant` (or `execute!`) to run.

Generated by `clj -X:gen` from
org.apache.tools.ant version 1.10.17.
raw docstring

addclj

(add & args)

Ant nested add. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:charsetString
:fileFile
:keyString
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$ReleaseInfoEntry

Ant nested add. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:charset` | `String` |  |  |
| `:file` | `File` |  |  |
| `:key` | `String` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$ReleaseInfoEntry`
sourceraw docstring

addfilesclj

(addfiles & args)

Ant nested addfiles. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested addfiles. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

additionalconfigclj

(additionalconfig & args)

Ant nested additionalconfig. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:keyString
:pathPath
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Environment$Variable

Ant nested additionalconfig. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:key` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Environment$Variable`
sourceraw docstring

allbutfirstclj

(allbutfirst & args)

Ant type allbutfirst. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:countint
:refidReference

Reference

https://ant.apache.org/manual/Types/allbutfirst.html

Defined by

org.apache.tools.ant.types.resources.AllButFirst

Ant type allbutfirst. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:count` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/allbutfirst.html

**Defined by**

`org.apache.tools.ant.types.resources.AllButFirst`
sourceraw docstring

allbutlastclj

(allbutlast & args)

Ant type allbutlast. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:countint
:refidReference

Reference

https://ant.apache.org/manual/Types/allbutlast.html

Defined by

org.apache.tools.ant.types.resources.AllButLast

Ant type allbutlast. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:count` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/allbutlast.html

**Defined by**

`org.apache.tools.ant.types.resources.AllButLast`
sourceraw docstring

andclj

(and & args)

Ant nested and. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.condition.And

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.AndSelector

Ant nested and. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.condition.And`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.AndSelector`
sourceraw docstring

antclj

(ant & args)

Runs Apache Ant on a supplied buildfile. This can be used to build subprojects. This task must not be used outside of a target if it invokes the same build file it is part of. When the antfile attribute is omitted, the file build.xml in the supplied directory (dir attribute) is used. If no target attribute is supplied, the default target of the new project is used. By default, all of the properties of the current project will be available in the new project. Alternatively, you can set the inheritAll attribute to false and only "user" properties (i.e., those passed on the command-line) will be passed to the new project. In either case, the set of properties passed to the new project will override the properties that are set in the new project (See also the property task). You can also set properties in the new project from the old project by using nested property tags. These properties are always passed to the new project and any project created in that project regardless of the setting of inheritAll. This allows you to parameterize your subprojects. When more than one nested <property> element would set a property of the same name, the one declared last will win. This is for backwards compatibility reasons even though it is different from the way <property> tasks in build files behave. Properties defined on the command line cannot be overridden by nested <property> elements. Since Ant 1.8.0, the same is true for nested structures of <ant> tasks: if a build file A invokes B via an <ant> task setting a property with a nested <property> element and B contains an <ant> tasks invoking C, C will see the value set in A, even if B used a nested <property> element as well. References to data types can also be passed to the new project, but by default they are not. If you set the inheritrefs attribute to true, all references will be copied, but they will not override references defined in the new project. Nested <reference> elements can also be used to copy references from the calling project to the new project, optionally under a different id. References taken from nested elements will override existing references that have been defined outside of targets in the new project-but not those defined inside of targets.

Attributes

AttributeTypeDescriptionRequired
:antfileStringthe buildfile to use. This file is expected to be a filename relative to the dir attribute given.No; defaults to build.xml
:dirFilethe directory to use as a basedir for the new Ant project (unless useNativeBasedir is set to true). This will override the basedir setting of the called project. Also serves as the directory to resolve the antfile and output attribute's values (if any).No; defaults to the current project's basedir, unless inheritall has been set to false, in which case it doesn't have a default value
:inheritallbooleanIf true, pass all properties to the new Ant project.No; defaults to true
:inheritrefsbooleanIf true, pass all references to the new Ant project.No; defaults to false
:outputStringFilename to write the Ant output to. This is relative to the value of the dir attribute if it has been set or to the basedir of the current project otherwise.No
:targetStringthe target of the new Ant project that should be executed.No; defaults to the new project's default target
:usenativebasedirbooleanIf set to true, the child build will use the same basedir as it would have used when run from the command line (i.e. the basedir one would expect when looking at the child build's buildfile). Since Ant 1.8.0No; defaults to false

Nested elements

  • :property (Property)
  • :propertyset (PropertySet)
  • :reference (Reference)
  • :target (TargetElement)

Reference

https://ant.apache.org/manual/Tasks/ant.html

Defined by

org.apache.tools.ant.taskdefs.Ant

Runs Apache Ant on a supplied buildfile. This can be used to build subprojects. This
task must not be used outside of a target if it invokes the same build file it is part
of. When the antfile attribute is omitted, the file build.xml in the supplied directory
(dir attribute) is used. If no target attribute is supplied, the default target of the
new project is used. By default, all of the properties of the current project will be
available in the new project. Alternatively, you can set the inheritAll attribute to
false and only "user" properties (i.e., those passed on the command-line) will be passed
to the new project. In either case, the set of properties passed to the new project will
override the properties that are set in the new project (See also the property task).
You can also set properties in the new project from the old project by using nested
property tags. These properties are always passed to the new project and any project
created in that project regardless of the setting of inheritAll. This allows you to
parameterize your subprojects. When more than one nested <property> element would set a
property of the same name, the one declared last will win. This is for backwards
compatibility reasons even though it is different from the way <property> tasks in build
files behave. Properties defined on the command line cannot be overridden by nested
<property> elements. Since Ant 1.8.0, the same is true for nested structures of <ant>
tasks: if a build file A invokes B via an <ant> task setting a property with a nested
<property> element and B contains an <ant> tasks invoking C, C will see the value set in
A, even if B used a nested <property> element as well. References to data types can also
be passed to the new project, but by default they are not. If you set the inheritrefs
attribute to true, all references will be copied, but they will not override references
defined in the new project. Nested <reference> elements can also be used to copy
references from the calling project to the new project, optionally under a different id.
References taken from nested elements will override existing references that have been
defined outside of targets in the new project-but not those defined inside of targets.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:antfile` | `String` | the buildfile to use. This file is expected to be a filename relative to the dir attribute given. | No; defaults to build.xml |
| `:dir` | `File` | the directory to use as a basedir for the new Ant project (unless useNativeBasedir is set to true). This will override the basedir setting of the called project. Also serves as the directory to resolve the antfile and output attribute's values (if any). | No; defaults to the current project's basedir, unless inheritall has been set to false, in which case it doesn't have a default value |
| `:inheritall` | `boolean` | If true, pass all properties to the new Ant project. | No; defaults to true |
| `:inheritrefs` | `boolean` | If true, pass all references to the new Ant project. | No; defaults to false |
| `:output` | `String` | Filename to write the Ant output to. This is relative to the value of the dir attribute if it has been set or to the basedir of the current project otherwise. | No |
| `:target` | `String` | the target of the new Ant project that should be executed. | No; defaults to the new project's default target |
| `:usenativebasedir` | `boolean` | If set to true, the child build will use the same basedir as it would have used when run from the command line (i.e. the basedir one would expect when looking at the child build's buildfile). Since Ant 1.8.0 | No; defaults to false |

**Nested elements**

- `:property` (`Property`)
- `:propertyset` (`PropertySet`)
- `:reference` (`Reference`)
- `:target` (`TargetElement`)

**Reference**

https://ant.apache.org/manual/Tasks/ant.html

**Defined by**

`org.apache.tools.ant.taskdefs.Ant`
sourceraw docstring

antcallclj

(antcall & args)

Call another target within the same buildfile optionally specifying some properties (params in this context). This task must not be used outside of a target. By default, all of the properties of the current project will be available in the new project. Alternatively, you can set the inheritAll attribute to false and only "user" properties (i.e., those passed on the command-line) will be passed to the new project. In either case, the set of properties passed to the new project will override the properties that are set in the new project (see also the property task). You can also set properties in the new project from the old project by using nested <param> tags. These properties are always passed to the new project and any project created in that project regardless of the setting of inheritAll. This allows you to parameterize your subprojects. Properties defined on the command line can not be overridden by nested <param> elements. When more than one nested <param> element would set a property of the same name, the one declared last will win. This is for backwards compatibility reasons even so it is different from the way <property> tasks in build files behave. Nested <reference> elements can be used to copy references from the calling project to the new project, optionally under a different id. References taken from nested elements will override existing references that have been defined outside of targets in the new project-but not those defined inside of targets. When a target is invoked by antcall, all of its dependent targets will also be called within the context of any new parameters. For example. if the target doSomethingElse; depended on the target init, then the antcall of doSomethingElse will call init during the call. Of course, any properties defined in the antcall task or inherited from the calling target will be fixed and not overridable in the init target-or indeed in the doSomethingElse target. The called target(s) are run in a new project; be aware that this means properties, references, etc. set by called targets will not persist back to the calling project. If the build file changes after you've started the build, the behavior of this task is undefined.

Attributes

AttributeTypeDescriptionRequired
:inheritallbooleanIf true, pass all properties to the new Apache Ant project.No; defaults to true
:inheritrefsbooleanIf true, pass all references to the new Ant project.No; defaults to false
:targetStringThe target to execute.Yes

Nested elements

  • :param (Property)
  • :propertyset (PropertySet)
  • :reference (Reference)
  • :target (TargetElement)

Reference

https://ant.apache.org/manual/Tasks/antcall.html

Defined by

org.apache.tools.ant.taskdefs.CallTarget

Call another target within the same buildfile optionally specifying some properties
(params in this context). This task must not be used outside of a target. By default,
all of the properties of the current project will be available in the new project.
Alternatively, you can set the inheritAll attribute to false and only "user" properties
(i.e., those passed on the command-line) will be passed to the new project. In either
case, the set of properties passed to the new project will override the properties that
are set in the new project (see also the property task). You can also set properties in
the new project from the old project by using nested <param> tags. These properties are
always passed to the new project and any project created in that project regardless of
the setting of inheritAll. This allows you to parameterize your subprojects. Properties
defined on the command line can not be overridden by nested <param> elements. When more
than one nested <param> element would set a property of the same name, the one declared
last will win. This is for backwards compatibility reasons even so it is different from
the way <property> tasks in build files behave. Nested <reference> elements can be used
to copy references from the calling project to the new project, optionally under a
different id. References taken from nested elements will override existing references
that have been defined outside of targets in the new project-but not those defined
inside of targets. When a target is invoked by antcall, all of its dependent targets
will also be called within the context of any new parameters. For example. if the target
doSomethingElse; depended on the target init, then the antcall of doSomethingElse will
call init during the call. Of course, any properties defined in the antcall task or
inherited from the calling target will be fixed and not overridable in the init
target-or indeed in the doSomethingElse target. The called target(s) are run in a new
project; be aware that this means properties, references, etc. set by called targets
will not persist back to the calling project. If the build file changes after you've
started the build, the behavior of this task is undefined.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:inheritall` | `boolean` | If true, pass all properties to the new Apache Ant project. | No; defaults to true |
| `:inheritrefs` | `boolean` | If true, pass all references to the new Ant project. | No; defaults to false |
| `:target` | `String` | The target to execute. | Yes |

**Nested elements**

- `:param` (`Property`)
- `:propertyset` (`PropertySet`)
- `:reference` (`Reference`)
- `:target` (`TargetElement`)

**Reference**

https://ant.apache.org/manual/Tasks/antcall.html

**Defined by**

`org.apache.tools.ant.taskdefs.CallTarget`
sourceraw docstring

antstructureclj

(antstructure & args)

Generates an DTD for Apache Ant buildfiles which contains information about all tasks currently known to Ant. Actually the DTD will not be a real DTD for buildfiles since Ant's usage of XML cannot be captured with a DTD. Several elements in Ant can have different attribute lists depending on the element that contains them. <fail> for example can be a task or a nested child element of the <sound> task. Don't consider the generated DTD something to rely upon. Also note that the DTD generated by this task is incomplete, you can always add XML entities using <taskdef> or <typedef>. See here for a way to get around this problem. This task doesn't know about required attributes, all will be listed as #IMPLIED. Since Ant 1.7 custom structure printers can be used instead of the one that emits a DTD. In order to plug in your own structure, you have to implement the interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter and <typedef> your class and use the new type as a nested element of this task-see the example below.

Attributes

AttributeTypeDescriptionRequired
:outputFilefile to write the DTD to.Yes

Reference

https://ant.apache.org/manual/Tasks/antstructure.html

Defined by

org.apache.tools.ant.taskdefs.AntStructure

Generates an DTD for Apache Ant buildfiles which contains information about all tasks
currently known to Ant. Actually the DTD will not be a real DTD for buildfiles since
Ant's usage of XML cannot be captured with a DTD. Several elements in Ant can have
different attribute lists depending on the element that contains them. <fail> for
example can be a task or a nested child element of the <sound> task. Don't consider the
generated DTD something to rely upon. Also note that the DTD generated by this task is
incomplete, you can always add XML entities using <taskdef> or <typedef>. See here for a
way to get around this problem. This task doesn't know about required attributes, all
will be listed as #IMPLIED. Since Ant 1.7 custom structure printers can be used instead
of the one that emits a DTD. In order to plug in your own structure, you have to
implement the interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter and
<typedef> your class and use the new type as a nested element of this task-see the
example below.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:output` | `File` | file to write the DTD to. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/antstructure.html

**Defined by**

`org.apache.tools.ant.taskdefs.AntStructure`
sourceraw docstring

antversionclj

(antversion & args)

Stores the Apache Ant version (when used as task) or checks for a specific Ant version (when used as condition). Attribute Description Required Task Condition atleast The version that this Ant is of at least. The format is major.minor.point. No Exactly one of these exactly The version that this Ant is of exactly. The format is major.minor.point. No property The name of the property to set. Yes Ignored

Attributes

AttributeTypeDescriptionRequired
:atleastStringThe version that this Ant is of at least. The format is major.minor.point.No
:exactlyStringThe version that this Ant is of exactly. The format is major.minor.point.No
:propertyStringThe name of the property to set.Yes

Reference

https://ant.apache.org/manual/Tasks/antversion.html

Defined by

org.apache.tools.ant.taskdefs.condition.AntVersion

Stores the Apache Ant version (when used as task) or checks for a specific Ant version
(when used as condition). Attribute Description Required Task Condition atleast The
version that this Ant is of at least. The format is major.minor.point. No Exactly one of
these exactly The version that this Ant is of exactly. The format is major.minor.point.
No property The name of the property to set. Yes Ignored

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:atleast` | `String` | The version that this Ant is of at least. The format is major.minor.point. | No |
| `:exactly` | `String` | The version that this Ant is of exactly. The format is major.minor.point. | No |
| `:property` | `String` | The name of the property to set. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/antversion.html

**Defined by**

`org.apache.tools.ant.taskdefs.condition.AntVersion`
sourceraw docstring

applyclj

(apply & args)

Executes a system command. When the os attribute is specified, then the command is only executed when Apache Ant is run on one of the specified operating systems. The files and/or directories of a number of Resource Collections -- including but not restricted to FileSets, DirSets (since Ant 1.6) or FileLists (since Ant 1.6) -- are passed as arguments to the system command. If you specify a nested mapper, the timestamp of each source file is compared to the timestamp of a target file which is defined by the nested mapper element and searched for in the given dest, if specified. At least one fileset or filelist is required, and you must not specify more than one mapper. Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes. Running Ant as a background process on Unix(-like) systems If you run Ant as a background process (like ant &) and use the <apply> task with spawn set to false, you must provide explicit input to the forked process or Ant will be suspended because it tries to read from the standard input.

Attributes

AttributeTypeDescriptionRequired
:addsourcefilebooleanWhether source file names should be added to the command automatically. Since Ant 1.6.No; default is true
:appendbooleanwhether output should be appended to or overwrite an existing file. If you set parallel to false, you will probably want to set this one to true.No; default is false
:commandCommandline
:destFilethe directory where the command is expected to place target files when it is executed.No; ignored unless a nested mapper is specified; by default, the target filenames returned by the mapper will be interpreted as absolute paths
:dirFilethe directory in which the command should be executed.No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir
:discarderrorbooleanWhether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10No; defaults to false
:discardoutputbooleanWhether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10No; defaults to false
:errorFileThe file to which the standard error of the command should be redirected. since Ant 1.6No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored. since Ant 1.6No
:executableStringthe command to execute without any command line arguments.Yes
:failifexecutionfailsbooleanStop the build if we can't start the program.No; defaults to true
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No; defaults to false
:forcebooleanWhether to bypass timestamp comparisons for target files. Since Ant 1.6.3.No; default is false
:forwardslashbooleanwhether the file names should be passed with forward slashes even if the operating system requires other file separator. The option is ignored if the system file separator is a forward slash.No; default is false
:ignoremissingbooleanWhether to ignore nonexistent files specified via filelists. Since Ant 1.6.2.No; default is true
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6No
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6No
:logerrorbooleanThis attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6No
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6.No, unlimited by default
:newenvironmentbooleanDo not propagate old environment when new environment variables are specified.No; default is false
:osStringlist of Operating Systems on which the command may be executed.No
:osfamilyStringOS family as used in the <os> condition. since Ant 1.7No
:outputFilethe file to which the output of the command should be redirected. If the error stream is not also redirected to a file or property, it will appear in this output.No
:outputpropertyStringthe name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output.No
:parallelbooleanRun the command only once, appending all files as arguments. If false, command will be executed once for every file.No; default is false
:relativebooleanwhether the filenames should be passed on the command line as relative pathnames (relative to the base directory of the corresponding fileset/list for source files or the dest attribute for target files).No; default is false
:resolveexecutablebooleanWhen this attribute is true, the name of the executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6No; default is false
:resultpropertyStringthe name of a property in which the return code of the command should be stored. Only of interest if failonerror is false. If you set parallel to false, only the result of the first execution will be stored.No
:searchpathboolean
:skipemptyfilesetsbooleanDon't run the command, if no source files have been found or are newer than their corresponding target files. Despite its name, this attribute applies to filelists as well.No; default is false
:spawnbooleanwhether or not you want the commands to be spawned. If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6No; default is false
:timeoutIntegerStop the command if it doesn't finish within the specified time (given in milliseconds).No
:typeFileDirBothOne of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only the names of directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not. Since Ant 1.6.No; default is false
:vmlauncherbooleanRun command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well.No; default is true

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/apply.html

Defined by

org.apache.tools.ant.taskdefs.Transform

Executes a system command. When the os attribute is specified, then the command is only
executed when Apache Ant is run on one of the specified operating systems. The files
and/or directories of a number of Resource Collections -- including but not restricted
to FileSets, DirSets (since Ant 1.6) or FileLists (since Ant 1.6) -- are passed as
arguments to the system command. If you specify a nested mapper, the timestamp of each
source file is compared to the timestamp of a target file which is defined by the nested
mapper element and searched for in the given dest, if specified. At least one fileset or
filelist is required, and you must not specify more than one mapper. Note that you
cannot interact with the forked program, the only way to send input to it is via the
input and inputstring attributes. Running Ant as a background process on Unix(-like)
systems If you run Ant as a background process (like ant &) and use the <apply> task
with spawn set to false, you must provide explicit input to the forked process or Ant
will be suspended because it tries to read from the standard input.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` | Whether source file names should be added to the command automatically. Since Ant 1.6. | No; default is true |
| `:append` | `boolean` | whether output should be appended to or overwrite an existing file. If you set parallel to false, you will probably want to set this one to true. | No; default is false |
| `:command` | `Commandline` |  |  |
| `:dest` | `File` | the directory where the command is expected to place target files when it is executed. | No; ignored unless a nested mapper is specified; by default, the target filenames returned by the mapper will be interpreted as absolute paths |
| `:dir` | `File` | the directory in which the command should be executed. | No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir |
| `:discarderror` | `boolean` | Whether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10 | No; defaults to false |
| `:discardoutput` | `boolean` | Whether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10 | No; defaults to false |
| `:error` | `File` | The file to which the standard error of the command should be redirected. since Ant 1.6 | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. since Ant 1.6 | No |
| `:executable` | `String` | the command to execute without any command line arguments. | Yes |
| `:failifexecutionfails` | `boolean` | Stop the build if we can't start the program. | No; defaults to true |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No; defaults to false |
| `:force` | `boolean` | Whether to bypass timestamp comparisons for target files. Since Ant 1.6.3. | No; default is false |
| `:forwardslash` | `boolean` | whether the file names should be passed with forward slashes even if the operating system requires other file separator. The option is ignored if the system file separator is a forward slash. | No; default is false |
| `:ignoremissing` | `boolean` | Whether to ignore nonexistent files specified via filelists. Since Ant 1.6.2. | No; default is true |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6 | No |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6 | No |
| `:logerror` | `boolean` | This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6 | No |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6. | No, unlimited by default |
| `:newenvironment` | `boolean` | Do not propagate old environment when new environment variables are specified. | No; default is false |
| `:os` | `String` | list of Operating Systems on which the command may be executed. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. since Ant 1.7 | No |
| `:output` | `File` | the file to which the output of the command should be redirected. If the error stream is not also redirected to a file or property, it will appear in this output. | No |
| `:outputproperty` | `String` | the name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. | No |
| `:parallel` | `boolean` | Run the command only once, appending all files as arguments. If false, command will be executed once for every file. | No; default is false |
| `:relative` | `boolean` | whether the filenames should be passed on the command line as relative pathnames (relative to the base directory of the corresponding fileset/list for source files or the dest attribute for target files). | No; default is false |
| `:resolveexecutable` | `boolean` | When this attribute is true, the name of the executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6 | No; default is false |
| `:resultproperty` | `String` | the name of a property in which the return code of the command should be stored. Only of interest if failonerror is false. If you set parallel to false, only the result of the first execution will be stored. | No |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` | Don't run the command, if no source files have been found or are newer than their corresponding target files. Despite its name, this attribute applies to filelists as well. | No; default is false |
| `:spawn` | `boolean` | whether or not you want the commands to be spawned. If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6 | No; default is false |
| `:timeout` | `Integer` | Stop the command if it doesn't finish within the specified time (given in milliseconds). | No |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only the names of directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. Since Ant 1.6. | No; default is false |
| `:vmlauncher` | `boolean` | Run command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well. | No; default is true |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/apply.html

**Defined by**

`org.apache.tools.ant.taskdefs.Transform`
sourceraw docstring

archivesclj

(archives & args)

Ant type archives. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :tars (Union)
  • :zips (Union)

Reference

https://ant.apache.org/manual/Types/archives.html

Defined by

org.apache.tools.ant.types.resources.Archives

Ant type archives. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:tars` (`Union`)
- `:zips` (`Union`)

**Reference**

https://ant.apache.org/manual/Types/archives.html

**Defined by**

`org.apache.tools.ant.types.resources.Archives`
sourceraw docstring

argclj

(arg & args)

Ant nested arg. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:lineString
:pathPath
:pathrefReference
:prefixString
:suffixString
:valueString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.util.facade.ImplementationSpecificArgument

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Argument

Ant nested arg. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:line` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:value` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.util.facade.ImplementationSpecificArgument`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Argument`
sourceraw docstring

argumentclj

(argument & args)

Ant nested argument. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:lineString
:pathPath
:pathrefReference
:prefixString
:suffixString
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Argument

Ant nested argument. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:line` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Argument`
sourceraw docstring

assertionsclj

(assertions & args)

The assertions type enables or disables the Java 1.4 assertions feature, on a whole Java program, or components of a program. It can be used in <java> and <junit> to add extra validation to code. Assertions are covered in the Java SE documentation, and the Java Language Specification. The key points to note are that a java.lang.AssertionError is thrown when an assertion fails, and that the facility is only available on Java 1.4 and later. To enable assertions one must set source=1.4 (or later) in <javac> when the source is being compiled, and that the code must contain assert statements to be tested. The result of such an action is code that neither compiles or runs on earlier versions of Java. For this reason Apache Ant itself currently contains no assertions. When assertions are enabled (or disabled) in a task through nested assertions elements, the class loader or command line is modified with the appropriate options. This means that the JVM executed must be of version 1.4 or later, even if there are no assertions in the code. Attempting to enable assertions on earlier JVMs will result in an "Unrecognized option" error and the JVM will not start. Attributes

Attributes

AttributeTypeDescriptionRequired
:enablesystemassertionsBooleanFlag to turn system assertions on or off.No; default is unspecified
:refidReference

Nested elements

  • :disable (DisabledAssertion)
  • :enable (EnabledAssertion)

Reference

https://ant.apache.org/manual/Types/assertions.html

Defined by

org.apache.tools.ant.types.Assertions

The assertions type enables or disables the Java 1.4 assertions feature, on a whole Java
program, or components of a program. It can be used in <java> and <junit> to add extra
validation to code. Assertions are covered in the Java SE documentation, and the Java
Language Specification. The key points to note are that a java.lang.AssertionError is
thrown when an assertion fails, and that the facility is only available on Java 1.4 and
later. To enable assertions one must set source=1.4 (or later) in <javac> when the
source is being compiled, and that the code must contain assert statements to be tested.
The result of such an action is code that neither compiles or runs on earlier versions
of Java. For this reason Apache Ant itself currently contains no assertions. When
assertions are enabled (or disabled) in a task through nested assertions elements, the
class loader or command line is modified with the appropriate options. This means that
the JVM executed must be of version 1.4 or later, even if there are no assertions in the
code. Attempting to enable assertions on earlier JVMs will result in an "Unrecognized
option" error and the JVM will not start. Attributes

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:enablesystemassertions` | `Boolean` | Flag to turn system assertions on or off. | No; default is unspecified |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:disable` (`DisabledAssertion`)
- `:enable` (`EnabledAssertion`)

**Reference**

https://ant.apache.org/manual/Types/assertions.html

**Defined by**

`org.apache.tools.ant.types.Assertions`
sourceraw docstring

attachmentsclj

(attachments & args)

Ant nested attachments. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested attachments. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

attribclj

(attrib & args)

Changes the attributes of a file or all files inside specified directories. Right now it has effect only under Windows. Each of the 4 possible permissions has its own attribute, matching the arguments for the attrib command. FileSets, DirSets or FileLists can be specified using nested <fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this task supports arbitrary resource collections as nested elements. By default this task won't do anything unless it detects it is running on a Windows system. If you know for sure that you have a attrib executable on your PATH that is command line compatible with the Windows command, you can use the task's os attribute and set its value to your current OS. See the setpermissions task for a platform independent alternative.

Attributes

AttributeTypeDescriptionRequired
:addsourcefileboolean
:appendboolean
:archivebooleanthe archive permission.At least one of the four
:commandCommandline
:destFile
:dirFile
:discarderrorboolean
:discardoutputboolean
:errorFile
:errorpropertyString
:executableString
:failifexecutionfailsboolean
:failonerrorboolean
:fileFilethe file or directory of which the permissions must be changed.Yes, or nested <fileset/list> elements
:forceboolean
:forwardslashboolean
:hiddenbooleanthe hidden permission.At least one of the four
:ignoremissingboolean
:inputFile
:inputstringString
:logerrorboolean
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6.No, defaults to unlimited
:newenvironmentboolean
:osString
:osfamilyStringOS family as used in the <os> condition.No; defaults to windows
:outputFile
:outputpropertyString
:parallelboolean
:readonlybooleanthe readonly permission.At least one of the four
:relativeboolean
:resolveexecutableboolean
:resultpropertyString
:searchpathboolean
:skipemptyfilesetsboolean
:spawnboolean
:systembooleanthe system permission.At least one of the four
:timeoutInteger
:typeFileDirBothOne of file, dir or both. If set to file, only the permissions of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not.No; defaults to false
:vmlauncherboolean

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/attrib.html

Defined by

org.apache.tools.ant.taskdefs.optional.windows.Attrib

Changes the attributes of a file or all files inside specified directories. Right now it
has effect only under Windows. Each of the 4 possible permissions has its own attribute,
matching the arguments for the attrib command. FileSets, DirSets or FileLists can be
specified using nested <fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this
task supports arbitrary resource collections as nested elements. By default this task
won't do anything unless it detects it is running on a Windows system. If you know for
sure that you have a attrib executable on your PATH that is command line compatible with
the Windows command, you can use the task's os attribute and set its value to your
current OS. See the setpermissions task for a platform independent alternative.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` |  |  |
| `:append` | `boolean` |  |  |
| `:archive` | `boolean` | the archive permission. | At least one of the four |
| `:command` | `Commandline` |  |  |
| `:dest` | `File` |  |  |
| `:dir` | `File` |  |  |
| `:discarderror` | `boolean` |  |  |
| `:discardoutput` | `boolean` |  |  |
| `:error` | `File` |  |  |
| `:errorproperty` | `String` |  |  |
| `:executable` | `String` |  |  |
| `:failifexecutionfails` | `boolean` |  |  |
| `:failonerror` | `boolean` |  |  |
| `:file` | `File` | the file or directory of which the permissions must be changed. | Yes, or nested <fileset/list> elements |
| `:force` | `boolean` |  |  |
| `:forwardslash` | `boolean` |  |  |
| `:hidden` | `boolean` | the hidden permission. | At least one of the four |
| `:ignoremissing` | `boolean` |  |  |
| `:input` | `File` |  |  |
| `:inputstring` | `String` |  |  |
| `:logerror` | `boolean` |  |  |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6. | No, defaults to unlimited |
| `:newenvironment` | `boolean` |  |  |
| `:os` | `String` |  |  |
| `:osfamily` | `String` | OS family as used in the <os> condition. | No; defaults to windows |
| `:output` | `File` |  |  |
| `:outputproperty` | `String` |  |  |
| `:parallel` | `boolean` |  |  |
| `:readonly` | `boolean` | the readonly permission. | At least one of the four |
| `:relative` | `boolean` |  |  |
| `:resolveexecutable` | `boolean` |  |  |
| `:resultproperty` | `String` |  |  |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` |  |  |
| `:spawn` | `boolean` |  |  |
| `:system` | `boolean` | the system permission. | At least one of the four |
| `:timeout` | `Integer` |  |  |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the permissions of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. | No; defaults to false |
| `:vmlauncher` | `boolean` |  |  |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/attrib.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.windows.Attrib`
sourceraw docstring

attributeclj

(attribute & args)

Ant nested attribute. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:valueString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute
  • org.apache.tools.ant.taskdefs.MacroDef$Attribute
  • org.apache.tools.ant.taskdefs.optional.XMLValidateTask$Attribute
  • org.apache.tools.ant.taskdefs.optional.script.ScriptDef$Attribute
  • org.apache.tools.ant.taskdefs.XSLTProcess$Factory$Attribute

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Manifest$Attribute

Ant nested attribute. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:value` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute`
- `org.apache.tools.ant.taskdefs.MacroDef$Attribute`
- `org.apache.tools.ant.taskdefs.optional.XMLValidateTask$Attribute`
- `org.apache.tools.ant.taskdefs.optional.script.ScriptDef$Attribute`
- `org.apache.tools.ant.taskdefs.XSLTProcess$Factory$Attribute`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Manifest$Attribute`
sourceraw docstring

attributenamespacedefclj

(attributenamespacedef & args)

Ant task attributenamespacedef. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:uriString

Reference

https://ant.apache.org/manual/Tasks/attributenamespacedef.html

Defined by

org.apache.tools.ant.taskdefs.AttributeNamespaceDef

Ant task attributenamespacedef. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:uri` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/attributenamespacedef.html

**Defined by**

`org.apache.tools.ant.taskdefs.AttributeNamespaceDef`
sourceraw docstring

augmentclj

(augment & args)

Modify an existing reference by adding nested elements or (re-)assigning properties mapped as XML attributes. This is an unusual task that makes use of Ant's internal processing mechanisms to reload a previously declared reference by means of the id attribute, then treats the declared augment element as though it were the original element.

Attributes

AttributeTypeDescriptionRequired
:proxyObject

Reference

https://ant.apache.org/manual/Tasks/augment.html

Defined by

org.apache.tools.ant.taskdefs.AugmentReference

Modify an existing reference by adding nested elements or (re-)assigning properties
mapped as XML attributes. This is an unusual task that makes use of Ant's internal
processing mechanisms to reload a previously declared reference by means of the id
attribute, then treats the declared augment element as though it were the original
element.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:proxy` | `Object` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/augment.html

**Defined by**

`org.apache.tools.ant.taskdefs.AugmentReference`
sourceraw docstring

availableclj

(available & args)

Sets a property if a resource is available at run time. This resource can be a file, a directory, a class in the classpath, or a JVM system resource. Note: a class is available in the classpath when it can be loaded; i.e., all classes it depends on must be in the classpath, too. If the resource is present, the property value is set to true by default; otherwise, the property is not set. You can set the value to something other than the default by specifying the value attribute. Normally, this task is used to set properties that are useful to avoid target execution depending on system parameters.

Attributes

AttributeTypeDescriptionRequired
:classnameStringThe class to look for in the classpath.Exactly one of the three
:classpathPathThe classpath to use when looking up classname or resource.No
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere.No
:fileFileThe file to look for.Exactly one of the three
:filepathPathThe path to use when looking up file.No
:ignoresystemclassesbooleanIgnore Ant's runtime classes, using only the specified classpath. Only affects the classname attribute.No; defaults to false
:propertyStringThe name of the property to set.Yes
:resourceStringThe resource to look for in the JVM.Exactly one of the three
:searchparentsbooleanThis contains the behaviour of the file type. If true, the task will, when searching for a file, search not only the directories specified but will also search the parent directories of those specified. If false, only the directories specified will be searched. Since Ant 1.7No; defaults to false
:typeFileDirThe type of file to look for, either a directory (type=dir) or a file (type=file). If not set, the property will be set if the name specified in the file attribute exists as either a file or a directory.No
:valueObjectThe value to set the property to.No; defaults to true

Nested elements

  • :classpath (Path)
  • :filepath (Path)

Reference

https://ant.apache.org/manual/Tasks/available.html

Defined by

org.apache.tools.ant.taskdefs.Available

Sets a property if a resource is available at run time. This resource can be a file, a
directory, a class in the classpath, or a JVM system resource. Note: a class is
available in the classpath when it can be loaded; i.e., all classes it depends on must
be in the classpath, too. If the resource is present, the property value is set to true
by default; otherwise, the property is not set. You can set the value to something other
than the default by specifying the value attribute. Normally, this task is used to set
properties that are useful to avoid target execution depending on system parameters.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` | The class to look for in the classpath. | Exactly one of the three |
| `:classpath` | `Path` | The classpath to use when looking up classname or resource. | No |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. | No |
| `:file` | `File` | The file to look for. | Exactly one of the three |
| `:filepath` | `Path` | The path to use when looking up file. | No |
| `:ignoresystemclasses` | `boolean` | Ignore Ant's runtime classes, using only the specified classpath. Only affects the classname attribute. | No; defaults to false |
| `:property` | `String` | The name of the property to set. | Yes |
| `:resource` | `String` | The resource to look for in the JVM. | Exactly one of the three |
| `:searchparents` | `boolean` | This contains the behaviour of the file type. If true, the task will, when searching for a file, search not only the directories specified but will also search the parent directories of those specified. If false, only the directories specified will be searched. Since Ant 1.7 | No; defaults to false |
| `:type` | `FileDir` | The type of file to look for, either a directory (type=dir) or a file (type=file). If not set, the property will be set if the name specified in the file attribute exists as either a file or a directory. | No |
| `:value` | `Object` | The value to set the property to. | No; defaults to true |

**Nested elements**

- `:classpath` (`Path`)
- `:filepath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/available.html

**Defined by**

`org.apache.tools.ant.taskdefs.Available`
sourceraw docstring

basedirclj

(basedir & args)

Ant nested basedir. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile
:directoryboolean
:existsboolean
:fileFile
:lastmodifiedlong
:nameString
:refidReference
:sizelong

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.resources.FileResource

Ant nested basedir. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:file` | `File` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.resources.FileResource`
sourceraw docstring

basenameclj

(basename & args)

Task to determine the basename of a specified file, optionally minus a specified suffix. When this task executes, it will set the specified property to the value of the last path element of the specified file. If file is a directory, the basename will be the last directory element. If file is a full-path, relative-path, or simple filename, the basename will be the simple file name, without any directory elements.

Attributes

AttributeTypeDescriptionRequired
:fileFileThe path to take the basename of.Yes
:propertyStringThe name of the property to set.Yes
:suffixStringThe suffix to remove from the resulting basename (specified either with or without the .).No

Reference

https://ant.apache.org/manual/Tasks/basename.html

Defined by

org.apache.tools.ant.taskdefs.Basename

Task to determine the basename of a specified file, optionally minus a specified suffix.
When this task executes, it will set the specified property to the value of the last
path element of the specified file. If file is a directory, the basename will be the
last directory element. If file is a full-path, relative-path, or simple filename, the
basename will be the simple file name, without any directory elements.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | The path to take the basename of. | Yes |
| `:property` | `String` | The name of the property to set. | Yes |
| `:suffix` | `String` | The suffix to remove from the resulting basename (specified either with or without the .). | No |

**Reference**

https://ant.apache.org/manual/Tasks/basename.html

**Defined by**

`org.apache.tools.ant.taskdefs.Basename`
sourceraw docstring

bccclj

(bcc & args)

Ant nested bcc. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:addressString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.EmailAddress

Ant nested bcc. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:address` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailAddress`
sourceraw docstring

bindtargetsclj

(bindtargets & args)

Make some target the extension of some defined extension point. It will make the list of targets dependencies of the extension point. This target is useful when you want to have a target to participate in another build workflow which explicitly exposes an extension point for that kind of insertion. Thus the target to bind and the extension point to bind to are both declared in some imported build files. But directly modifying the target dependency graph of these external build files may have a side effect on some other project which imports them. This task helps to modify the target dependencies but only in your context. Note: this task is quite equivalent to the definition of an intermediate target which will be the bridge between the target to bind and the extension point. For instance: <bindtargets targets="jar, javadoc" extensionPoint="dist"/> is quite equivalent to: <target name="bind-to-dist" depends="jar, javadoc" extensionOf="dist"/> This task basically avoids the creation of a target. The bindtargets task may only be used as a top-level task. This means that it may not be used in a target. This is making the target dependency graph static and predictable as soon as every build file is loaded.

Attributes

AttributeTypeDescriptionRequired
:extensionpointStringthe name of the extension point to bind the targets to.Yes
:onmissingextensionpointStringWhat to do if this target tries to extend a missing extension-point: fail, warn, ignore.No; defaults to fail
:targetsStringa comma separated list of target names to bind.Yes

Reference

https://ant.apache.org/manual/Tasks/bindtargets.html

Defined by

org.apache.tools.ant.taskdefs.BindTargets

Make some target the extension of some defined extension point. It will make the list of
targets dependencies of the extension point. This target is useful when you want to have
a target to participate in another build workflow which explicitly exposes an extension
point for that kind of insertion. Thus the target to bind and the extension point to
bind to are both declared in some imported build files. But directly modifying the
target dependency graph of these external build files may have a side effect on some
other project which imports them. This task helps to modify the target dependencies but
only in your context. Note: this task is quite equivalent to the definition of an
intermediate target which will be the bridge between the target to bind and the
extension point. For instance: <bindtargets targets="jar, javadoc"
extensionPoint="dist"/> is quite equivalent to: <target name="bind-to-dist"
depends="jar, javadoc" extensionOf="dist"/> This task basically avoids the creation of a
target. The bindtargets task may only be used as a top-level task. This means that it
may not be used in a target. This is making the target dependency graph static and
predictable as soon as every build file is loaded.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:extensionpoint` | `String` | the name of the extension point to bind the targets to. | Yes |
| `:onmissingextensionpoint` | `String` | What to do if this target tries to extend a missing extension-point: fail, warn, ignore. | No; defaults to fail |
| `:targets` | `String` | a comma separated list of target names to bind. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/bindtargets.html

**Defined by**

`org.apache.tools.ant.taskdefs.BindTargets`
sourceraw docstring

blgenclientclj

(blgenclient & args)

The BorlandGenerateClient is a task dedicated to Borland Application Server v 4.5. It offers to generate the client jar file corresponding to an EJB jar file.

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:clientjarFileclient jar file name. If missing the client jar file name is build using the ejbjar file name: ejbjar=hellobean-ejb.jar => hellobean-ejbclient.jarno
:debugbooleanIf true, turn on the debug mode for each Borland tool (java2iiop, iastool, ...)no; default false
:ejbjarFileEJB jar fileyes
:modeStringchoose the command launching mode. Two values: java or fork (default). java is not supported for version=5. Possibility to specify a classpath.no
:versionintset the Borland Application Version. 4 means B.A.S (Borland Application Server 4.x) 5 means B.E.S (Borland Application Server 5.x)No; defaults to 4

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/BorlandGenerateClient.html

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient

The BorlandGenerateClient is a task dedicated to Borland Application Server v 4.5. It
offers to generate the client jar file corresponding to an EJB jar file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:clientjar` | `File` | client jar file name. If missing the client jar file name is build using the ejbjar file name: ejbjar=hellobean-ejb.jar => hellobean-ejbclient.jar | no |
| `:debug` | `boolean` | If true, turn on the debug mode for each Borland tool (java2iiop, iastool, ...) | no; default false |
| `:ejbjar` | `File` | EJB jar file | yes |
| `:mode` | `String` | choose the command launching mode. Two values: java or fork (default). java is not supported for version=5. Possibility to specify a classpath. | no |
| `:version` | `int` | set the Borland Application Version. 4 means B.A.S (Borland Application Server 4.x) 5 means B.E.S (Borland Application Server 5.x) | No; defaults to 4 |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/BorlandGenerateClient.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient`
sourceraw docstring

bootclasspathclj

(bootclasspath & args)

Ant nested bootclasspath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested bootclasspath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

borlandclj

(borland & args)

Ant nested borland. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basdtdString
:classpathPath
:debugboolean
:destdirFile
:generateclientboolean
:genericjarsuffixString
:java2iiopparamsString
:suffixString
:verifyboolean
:verifyargsString
:versionint

Nested elements

  • :classpath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool

Ant nested borland. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basdtd` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:debug` | `boolean` |  |  |
| `:destdir` | `File` |  |  |
| `:generateclient` | `boolean` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:java2iiopparams` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:verify` | `boolean` |  |  |
| `:verifyargs` | `String` |  |  |
| `:version` | `int` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool`
sourceraw docstring

bottomclj

(bottom & args)

Ant nested bottom. (No description bundled.)

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$Html

Ant nested bottom. (No description bundled.)

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$Html`
sourceraw docstring

buildnumberclj

(buildnumber & args)

This is a basic task that can be used to track build numbers. It will first attempt to read a build number from a file (by default, build.number in the current directory), then set the property build.number to the value that was read in (or to 0, if no such value). It will then increment the number by one and write it back out to the file. (See the PropertyFile task if you need finer control over things such as the property name or the number format.)

Attributes

AttributeTypeDescriptionRequired
:fileFileThe file to read and write the build number from/to.No; defaults to build.number

Reference

https://ant.apache.org/manual/Tasks/buildnumber.html

Defined by

org.apache.tools.ant.taskdefs.BuildNumber

This is a basic task that can be used to track build numbers. It will first attempt to
read a build number from a file (by default, build.number in the current directory),
then set the property build.number to the value that was read in (or to 0, if no such
value). It will then increment the number by one and write it back out to the file. (See
the PropertyFile task if you need finer control over things such as the property name or
the number format.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | The file to read and write the build number from/to. | No; defaults to build.number |

**Reference**

https://ant.apache.org/manual/Tasks/buildnumber.html

**Defined by**

`org.apache.tools.ant.taskdefs.BuildNumber`
sourceraw docstring

buildpathclj

(buildpath & args)

Ant nested buildpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested buildpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

buildpathelementclj

(buildpathelement & args)

Ant nested buildpathelement. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:pathString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path$PathElement

Ant nested buildpathelement. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:path` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path$PathElement`
sourceraw docstring

bunzip2clj

(bunzip2 & args)

Expands a resource packed using GZip, BZip2 or XZ. If dest is a directory the name of the destination file is the same as src (with the .gz, .bz2 or .xz extension removed if present). If dest is omitted, the parent dir of src is taken. The file is only expanded if the source resource is newer than the destination file, or when the destination file does not exist. XZ compression support has been added since Apache Ant 1.10.1 and depends on external libraries not included in the Ant distribution. See Library Dependencies for more information.

Attributes

AttributeTypeDescriptionRequired
:destFilethe destination file or directory.No
:srcFilethe file to expand.Yes, or a nested resource collection
:srcresourceResource

Reference

https://ant.apache.org/manual/Tasks/unpack.html

Defined by

org.apache.tools.ant.taskdefs.BUnzip2

Expands a resource packed using GZip, BZip2 or XZ. If dest is a directory the name of
the destination file is the same as src (with the .gz, .bz2 or .xz extension removed if
present). If dest is omitted, the parent dir of src is taken. The file is only expanded
if the source resource is newer than the destination file, or when the destination file
does not exist. XZ compression support has been added since Apache Ant 1.10.1 and
depends on external libraries not included in the Ant distribution. See Library
Dependencies for more information.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dest` | `File` | the destination file or directory. | No |
| `:src` | `File` | the file to expand. | Yes, or a nested resource collection |
| `:srcresource` | `Resource` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/unpack.html

**Defined by**

`org.apache.tools.ant.taskdefs.BUnzip2`
sourceraw docstring

bzip2clj

(bzip2 & args)

Packs a resource using the GZip, BZip2 or XZ algorithm. The output file is only generated if it doesn't exist or the source resource is newer. XZ compression support has been added since Apache Ant 1.10.1 and depends on external libraries not included in the Ant distribution. See Library Dependencies for more information.

Attributes

AttributeTypeDescriptionRequired
:destfileFilethe destination file to create.Exactly one of the two
:srcFilethe file to gzip/bzip/xz.Yes, or a nested resource collection
:srcresourceResource
:zipfileFiledeprecated old name of destfile.Exactly one of the two

Reference

https://ant.apache.org/manual/Tasks/pack.html

Defined by

org.apache.tools.ant.taskdefs.BZip2

Packs a resource using the GZip, BZip2 or XZ algorithm. The output file is only
generated if it doesn't exist or the source resource is newer. XZ compression support
has been added since Apache Ant 1.10.1 and depends on external libraries not included in
the Ant distribution. See Library Dependencies for more information.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:destfile` | `File` | the destination file to create. | Exactly one of the two |
| `:src` | `File` | the file to gzip/bzip/xz. | Yes, or a nested resource collection |
| `:srcresource` | `Resource` |  |  |
| `:zipfile` | `File` | deprecated old name of destfile. | Exactly one of the two |

**Reference**

https://ant.apache.org/manual/Tasks/pack.html

**Defined by**

`org.apache.tools.ant.taskdefs.BZip2`
sourceraw docstring

bzip2resourceclj

(bzip2resource & args)

Ant type bzip2resource. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:directoryboolean
:existsboolean
:lastmodifiedlong
:nameString
:refidReference
:sizelong

Reference

https://ant.apache.org/manual/Types/bzip2resource.html

Defined by

org.apache.tools.ant.types.resources.BZip2Resource

Ant type bzip2resource. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

https://ant.apache.org/manual/Types/bzip2resource.html

**Defined by**

`org.apache.tools.ant.types.resources.BZip2Resource`
sourceraw docstring

cabclj

(cab & args)

The cab task creates Microsoft cabinet archive files. It is invoked similar to the jar or zip tasks. This task will work on Windows using the external cabarc tool (provided by Microsoft) which must be located in your executable path. To use this task on other platforms you need to download and compile libcabinet from https://www.freshports.org/archivers/libcabinet/. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements. On non-Unix platforms this task writes the list of files to archive to the temporary directory.

Attributes

AttributeTypeDescriptionRequired
:basedirFilethe directory to start archiving files from.No
:cabfileFilethe name of the cab file to create.Yes
:casesensitiveboolean
:compressbooleanset to no to store files without compressing.No; defaults to yes
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:optionsStringset additional command-line options for the cabarc tool. Should not normally be necessary.No
:verbosebooleanset to yes if you want to see the output from the cabarc tool.No; defaults to no

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/cab.html

Defined by

org.apache.tools.ant.taskdefs.optional.Cab

The cab task creates Microsoft cabinet archive files. It is invoked similar to the jar
or zip tasks. This task will work on Windows using the external cabarc tool (provided by
Microsoft) which must be located in your executable path. To use this task on other
platforms you need to download and compile libcabinet from
https://www.freshports.org/archivers/libcabinet/. See the section on directory based
tasks, on how the inclusion/exclusion of files works, and how to write patterns. This
task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes
basedir) as well as the nested <include>, <exclude> and <patternset> elements. On
non-Unix platforms this task writes the list of files to archive to the temporary
directory.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | the directory to start archiving files from. | No |
| `:cabfile` | `File` | the name of the cab file to create. | Yes |
| `:casesensitive` | `boolean` |  |  |
| `:compress` | `boolean` | set to no to store files without compressing. | No; defaults to yes |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:options` | `String` | set additional command-line options for the cabarc tool. Should not normally be necessary. | No |
| `:verbose` | `boolean` | set to yes if you want to see the output from the cabarc tool. | No; defaults to no |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/cab.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Cab`
sourceraw docstring

catalogpathclj

(catalogpath & args)

Ant nested catalogpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested catalogpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

ccclj

(cc & args)

Ant nested cc. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:addressString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.EmailAddress

Ant nested cc. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:address` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailAddress`
sourceraw docstring

cccheckinclj

(cccheckin & args)

Task to perform a cleartool checkin command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command failsNo; default is true
:identicalbooleanAllows the file to be checked in even if it is identical to the originalNo
:keepcopybooleanKeeps a copy of the file with a .keep extensionNo
:nowarnbooleanSuppress warning messagesNo
:objselectString
:preservetimebooleanPreserve the modification timeNo
:viewpathStringPath to the ClearCase view file or directory that the command will operate onNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#cccheckin

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin

Task to perform a cleartool checkin command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails | No; default is true |
| `:identical` | `boolean` | Allows the file to be checked in even if it is identical to the original | No |
| `:keepcopy` | `boolean` | Keeps a copy of the file with a .keep extension | No |
| `:nowarn` | `boolean` | Suppress warning messages | No |
| `:objselect` | `String` |  |  |
| `:preservetime` | `boolean` | Preserve the modification time | No |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#cccheckin

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin`
sourceraw docstring

cccheckoutclj

(cccheckout & args)

Task to perform a cleartool checkout command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:branchStringSpecify a branch to check out the file toNo
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:nodatabooleanChecks out the file but does not create an editable file containing its dataNo
:notcobooleanFail if it's already checked out to the current view. Set to false to ignore it. Since Ant 1.6.1No; default is true
:nowarnbooleanSuppress warning messagesNo
:objselectString
:outStringCreates a writable file under a different filenameNo
:reservedbooleanSpecifies whether to check out the file as reserved or notYes
:versionbooleanAllows checkout of a version other than /main/LATEST (or whatever is selected by a config spec)No
:viewpathStringPath to the ClearCase view file or directory that the command will operate onNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#cccheckout

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout

Task to perform a cleartool checkout command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:branch` | `String` | Specify a branch to check out the file to | No |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:nodata` | `boolean` | Checks out the file but does not create an editable file containing its data | No |
| `:notco` | `boolean` | Fail if it's already checked out to the current view. Set to false to ignore it. Since Ant 1.6.1 | No; default is true |
| `:nowarn` | `boolean` | Suppress warning messages | No |
| `:objselect` | `String` |  |  |
| `:out` | `String` | Creates a writable file under a different filename | No |
| `:reserved` | `boolean` | Specifies whether to check out the file as reserved or not | Yes |
| `:version` | `boolean` | Allows checkout of a version other than /main/LATEST (or whatever is selected by a config spec) | No |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#cccheckout

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout`
sourceraw docstring

cclockclj

(cclock & args)

Task to perform a cleartool lock command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecifies how to populate comments fieldsNo
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:nusersStringSpecifies user(s) who can still modify the objectNo
:objselStringSpecifies the object(s) to be locked. Since Ant 1.6.1No
:objselectStringObsolete. Use objsel instead.No
:obsoletebooleanSpecifies that the object should be marked obsoleteNo
:pnameStringSpecifies the object pathname to be locked.No
:replacebooleanSpecifies replacing an existing lockNo
:viewpathString

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#cclock

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCLock

Task to perform a cleartool lock command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specifies how to populate comments fields | No |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:nusers` | `String` | Specifies user(s) who can still modify the object | No |
| `:objsel` | `String` | Specifies the object(s) to be locked. Since Ant 1.6.1 | No |
| `:objselect` | `String` | Obsolete. Use objsel instead. | No |
| `:obsolete` | `boolean` | Specifies that the object should be marked obsolete | No |
| `:pname` | `String` | Specifies the object pathname to be locked. | No |
| `:replace` | `boolean` | Specifies replacing an existing lock | No |
| `:viewpath` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#cclock

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCLock`
sourceraw docstring

ccmcheckinclj

(ccmcheckin & args)

Check in a file to Continuus

Attributes

AttributeTypeDescriptionRequired
:ccmactionString
:ccmdirStringpath to the ccm executable file, required if it is not on the PATHNo
:commentStringSpecify a comment.No; default is Checkin plus the date
:fileFilePath to the file that the command will operate onYes
:taskStringSpecify the task number used to check in the file (may use default)No

Nested elements

  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckin

Defined by

org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckin

Check in a file to Continuus

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:ccmaction` | `String` |  |  |
| `:ccmdir` | `String` | path to the ccm executable file, required if it is not on the PATH | No |
| `:comment` | `String` | Specify a comment. | No; default is Checkin plus the date |
| `:file` | `File` | Path to the file that the command will operate on | Yes |
| `:task` | `String` | Specify the task number used to check in the file (may use default) | No |

**Nested elements**

- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckin

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckin`
sourceraw docstring

ccmcheckintaskclj

(ccmcheckintask & args)

Run a Continuus command to checkin default task

Attributes

AttributeTypeDescriptionRequired
:ccmactionString
:ccmdirStringpath to the ccm executable file, required if it is not on the PATHNo
:commentStringSpecify a comment.No
:fileFile
:taskStringSpecify the task number used to check in the file (may use default)No

Nested elements

  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckintask

Defined by

org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault

Run a Continuus command to checkin default task

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:ccmaction` | `String` |  |  |
| `:ccmdir` | `String` | path to the ccm executable file, required if it is not on the PATH | No |
| `:comment` | `String` | Specify a comment. | No |
| `:file` | `File` |  |  |
| `:task` | `String` | Specify the task number used to check in the file (may use default) | No |

**Nested elements**

- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckintask

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault`
sourceraw docstring

ccmcheckoutclj

(ccmcheckout & args)

Run a Continuus checkout command

Attributes

AttributeTypeDescriptionRequired
:ccmactionString
:ccmdirStringpath to the ccm executable file, required if it is not on the PATHNo
:commentStringSpecify a commentNo
:fileFilePath to the file that the command will operate onExactly one of the two
:taskStringSpecify the task number used to checkin the file (may use default)No

Nested elements

  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckout

Defined by

org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckout

Run a Continuus checkout command

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:ccmaction` | `String` |  |  |
| `:ccmdir` | `String` | path to the ccm executable file, required if it is not on the PATH | No |
| `:comment` | `String` | Specify a comment | No |
| `:file` | `File` | Path to the file that the command will operate on | Exactly one of the two |
| `:task` | `String` | Specify the task number used to checkin the file (may use default) | No |

**Nested elements**

- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/ccm.html#ccmcheckout

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckout`
sourceraw docstring

ccmcreatetaskclj

(ccmcreatetask & args)

Create a Continuus task.

Attributes

AttributeTypeDescriptionRequired
:ccmactionString
:ccmdirStringpath to the ccm executable file, required if it is not on the PATHNo
:commentStringSpecify a commentNo
:platformStringSpecify the target platformNo
:releaseStringSpecify the CCM releaseNo
:resolverStringSpecify the resolverNo
:subsystemStringSpecify the subsystemNo
:taskStringSpecify the task number used to checkin the file (may use default)No

Reference

https://ant.apache.org/manual/Tasks/ccm.html#ccmcreatetask

Defined by

org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask

Create a Continuus task.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:ccmaction` | `String` |  |  |
| `:ccmdir` | `String` | path to the ccm executable file, required if it is not on the PATH | No |
| `:comment` | `String` | Specify a comment | No |
| `:platform` | `String` | Specify the target platform | No |
| `:release` | `String` | Specify the CCM release | No |
| `:resolver` | `String` | Specify the resolver | No |
| `:subsystem` | `String` | Specify the subsystem | No |
| `:task` | `String` | Specify the task number used to checkin the file (may use default) | No |

**Reference**

https://ant.apache.org/manual/Tasks/ccm.html#ccmcreatetask

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask`
sourceraw docstring

ccmkattrclj

(ccmkattr & args)

Task to perform a cleartool mkattr command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails.No; default is true
:objselectString
:recursebooleanProcess each subdirectory under viewpathNo
:replacebooleanReplace the value of the attribute if it already existsNo
:typenameStringName of the attribute typeYes
:typevalueStringValue to attach to the attribute typeYes
:versionStringIdentify a specific version to attach the attribute toNo
:viewpathStringPath to the ClearCase view file or directory that the command will operate onYes

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkattr

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr

Task to perform a cleartool mkattr command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. | No; default is true |
| `:objselect` | `String` |  |  |
| `:recurse` | `boolean` | Process each subdirectory under viewpath | No |
| `:replace` | `boolean` | Replace the value of the attribute if it already exists | No |
| `:typename` | `String` | Name of the attribute type | Yes |
| `:typevalue` | `String` | Value to attach to the attribute type | Yes |
| `:version` | `String` | Identify a specific version to attach the attribute to | No |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkattr

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr`
sourceraw docstring

ccmkblclj

(ccmkbl & args)

Task to perform a cleartool mkbl command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:baselinerootnameStringSpecify the name to be associated with the baseline.Yes
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:fullbooleanCreates a full baseline.No
:identicalbooleanAllows the baseline to be created even if it is identical to the previous baseline.No
:nlabelbooleanAllows the baseline to be created without a label.No
:nowarnbooleanSuppress warning messagesNo
:objselectString
:viewpathString

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkbl

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl

Task to perform a cleartool mkbl command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:baselinerootname` | `String` | Specify the name to be associated with the baseline. | Yes |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:full` | `boolean` | Creates a full baseline. | No |
| `:identical` | `boolean` | Allows the baseline to be created even if it is identical to the previous baseline. | No |
| `:nlabel` | `boolean` | Allows the baseline to be created without a label. | No |
| `:nowarn` | `boolean` | Suppress warning messages | No |
| `:objselect` | `String` |  |  |
| `:viewpath` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkbl

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl`
sourceraw docstring

ccmkdirclj

(ccmkdir & args)

Task to perform a cleartool mkdir command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails.No; default is true
:nocheckoutbooleanDo not checkout after element creationNo
:objselectString
:viewpathStringPath to the ClearCase view directory that the command will operate onYes

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkdir

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir

Task to perform a cleartool mkdir command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. | No; default is true |
| `:nocheckout` | `boolean` | Do not checkout after element creation | No |
| `:objselect` | `String` |  |  |
| `:viewpath` | `String` | Path to the ClearCase view directory that the command will operate on | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkdir

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir`
sourceraw docstring

ccmkelemclj

(ccmkelem & args)

Task to perform a cleartool mkelem command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:checkinbooleanCheckin element after creationNo
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:eltypeStringElement type to use during element creationNo
:failonerrbooleanThrow an exception if the command fails.No; default is true
:masterbooleanAssign mastership of the main branch to the current siteNo
:nocheckoutbooleanDo not checkout after element creationNo
:nowarnbooleanSuppress warning messagesNo
:objselectString
:preservetimebooleanPreserve the modification time (for checkin)No
:viewpathStringPath to the ClearCase view file or directory that the command will operate onYes

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkelem

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem

Task to perform a cleartool mkelem command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:checkin` | `boolean` | Checkin element after creation | No |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:eltype` | `String` | Element type to use during element creation | No |
| `:failonerr` | `boolean` | Throw an exception if the command fails. | No; default is true |
| `:master` | `boolean` | Assign mastership of the main branch to the current site | No |
| `:nocheckout` | `boolean` | Do not checkout after element creation | No |
| `:nowarn` | `boolean` | Suppress warning messages | No |
| `:objselect` | `String` |  |  |
| `:preservetime` | `boolean` | Preserve the modification time (for checkin) | No |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmkelem

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem`
sourceraw docstring

ccmklabelclj

(ccmklabel & args)

Task to perform a cleartool mklabel command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:objselectString
:recursebooleanProcess each subdirectory under viewpathNo
:replacebooleanReplace a label of the same type on the same branchNo
:typenameStringName of the label typeYes
:versionStringIdentify a specific version to attach the label toNo
:viewpathStringPath to the ClearCase view file or directory that the command will operate onNo
:vobStringName of the VOBNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmklabel

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel

Task to perform a cleartool mklabel command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:objselect` | `String` |  |  |
| `:recurse` | `boolean` | Process each subdirectory under viewpath | No |
| `:replace` | `boolean` | Replace a label of the same type on the same branch | No |
| `:typename` | `String` | Name of the label type | Yes |
| `:version` | `String` | Identify a specific version to attach the label to | No |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | No |
| `:vob` | `String` | Name of the VOB | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmklabel

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel`
sourceraw docstring

ccmklbtypeclj

(ccmklbtype & args)

Task to perform a cleartool mklbtype command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecify a commentNo; only one of the two may be used
:commentfileStringSpecify a file containing a commentNo; only one of the two may be used
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:globalbooleanCreates a label type that is global to the VOB or to VOBs that use this VOB.No; only one of the two may be used, default ordinary=true
:objselectString
:ordinarybooleanCreates a label type that can be used only in the current VOB.No; only one of the two may be used, default ordinary=true
:pbranchbooleanAllows the label type to be used once per branch in a given element's version treeNo
:replacebooleanReplace an existing label definition of the same typeNo
:sharedbooleanSets the way mastership is checked by ClearCase. See ClearCase documentation for detailsNo
:typenameStringName of the label type to createYes
:viewpathString
:vobStringName of the VOBNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccmklbtype

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype

Task to perform a cleartool mklbtype command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specify a comment | No; only one of the two may be used |
| `:commentfile` | `String` | Specify a file containing a comment | No; only one of the two may be used |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:global` | `boolean` | Creates a label type that is global to the VOB or to VOBs that use this VOB. | No; only one of the two may be used, default ordinary=true |
| `:objselect` | `String` |  |  |
| `:ordinary` | `boolean` | Creates a label type that can be used only in the current VOB. | No; only one of the two may be used, default ordinary=true |
| `:pbranch` | `boolean` | Allows the label type to be used once per branch in a given element's version tree | No |
| `:replace` | `boolean` | Replace an existing label definition of the same type | No |
| `:shared` | `boolean` | Sets the way mastership is checked by ClearCase. See ClearCase documentation for details | No |
| `:typename` | `String` | Name of the label type to create | Yes |
| `:viewpath` | `String` |  |  |
| `:vob` | `String` | Name of the VOB | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccmklbtype

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype`
sourceraw docstring

ccmreconfigureclj

(ccmreconfigure & args)

Run a Continuus reconfigure/update command

Attributes

AttributeTypeDescriptionRequired
:ccmactionString
:ccmdirStringpath to the ccm executable file, required if it is not on the PATHNo
:ccmprojectStringSpecifies the ccm project on which the operation is applied.Yes
:recursebooleanrecurse on subprojectNo; default is false
:verbosebooleando a verbose reconfigure operationNo; default is false

Reference

https://ant.apache.org/manual/Tasks/ccm.html#ccmreconfigure

Defined by

org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure

Run a Continuus reconfigure/update command

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:ccmaction` | `String` |  |  |
| `:ccmdir` | `String` | path to the ccm executable file, required if it is not on the PATH | No |
| `:ccmproject` | `String` | Specifies the ccm project on which the operation is applied. | Yes |
| `:recurse` | `boolean` | recurse on subproject | No; default is false |
| `:verbose` | `boolean` | do a verbose reconfigure operation | No; default is false |

**Reference**

https://ant.apache.org/manual/Tasks/ccm.html#ccmreconfigure

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure`
sourceraw docstring

ccrmtypeclj

(ccrmtype & args)

Task to perform a cleartool rmtype command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentString
:commentfileString
:failonerrboolean
:ignoreboolean
:objselectString
:rmallboolean
:typekindString
:typenameString
:viewpathString
:vobString

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccrmtype

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype

Task to perform a cleartool rmtype command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` |  |  |
| `:commentfile` | `String` |  |  |
| `:failonerr` | `boolean` |  |  |
| `:ignore` | `boolean` |  |  |
| `:objselect` | `String` |  |  |
| `:rmall` | `boolean` |  |  |
| `:typekind` | `String` |  |  |
| `:typename` | `String` |  |  |
| `:viewpath` | `String` |  |  |
| `:vob` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccrmtype

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype`
sourceraw docstring

ccuncheckoutclj

(ccuncheckout & args)

Task to perform a cleartool uncheckout command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:keepcopybooleanSpecifies whether to keep a copy of the file with a .keep extension or notNo
:objselectString
:viewpathStringPath to the ClearCase view file or directory that the command will operate onNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccuncheckout

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout

Task to perform a cleartool uncheckout command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:keepcopy` | `boolean` | Specifies whether to keep a copy of the file with a .keep extension or not | No |
| `:objselect` | `String` |  |  |
| `:viewpath` | `String` | Path to the ClearCase view file or directory that the command will operate on | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccuncheckout

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout`
sourceraw docstring

ccunlockclj

(ccunlock & args)

Task to perform a cleartool unlock command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:commentStringSpecifies how to populate comments fieldsNo
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:objselStringSpecifies the object(s) to be unlocked. Since Ant 1.6.1No
:objselectStringObsolete. Use objsel instead.No
:pnameStringSpecifies the object pathname to be unlocked.No
:viewpathString

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccunlock

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock

Task to perform a cleartool unlock command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:comment` | `String` | Specifies how to populate comments fields | No |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:objsel` | `String` | Specifies the object(s) to be unlocked. Since Ant 1.6.1 | No |
| `:objselect` | `String` | Obsolete. Use objsel instead. | No |
| `:pname` | `String` | Specifies the object pathname to be unlocked. | No |
| `:viewpath` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccunlock

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock`
sourceraw docstring

ccupdateclj

(ccupdate & args)

Task to perform an cleartool update command to ClearCase.

Attributes

AttributeTypeDescriptionRequired
:cleartooldirString
:currenttimebooleanSpecifies that modification time should be written as the current time. Mutually exclusive with preservetime.No
:failonerrbooleanThrow an exception if the command fails. Since Ant 1.6.1No; default is true
:graphicalbooleanDisplays a graphical dialog during the updateNo
:logStringSpecifies a log file for ClearCase to write toNo
:objselectString
:overwritebooleanSpecifies whether to overwrite hijacked files or notNo
:preservetimebooleanSpecifies that modification time should preserved from the VOB time. Mutually exclusive with currenttime.No
:renamebooleanSpecifies that hijacked files should be renamed with a .keep extensionNo
:viewpathStringPath to the ClearCase snapshot view file or directory that the command will operate onNo

Reference

https://ant.apache.org/manual/Tasks/clearcase.html#ccupdate

Defined by

org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate

Task to perform an cleartool update command to ClearCase.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleartooldir` | `String` |  |  |
| `:currenttime` | `boolean` | Specifies that modification time should be written as the current time. Mutually exclusive with preservetime. | No |
| `:failonerr` | `boolean` | Throw an exception if the command fails. Since Ant 1.6.1 | No; default is true |
| `:graphical` | `boolean` | Displays a graphical dialog during the update | No |
| `:log` | `String` | Specifies a log file for ClearCase to write to | No |
| `:objselect` | `String` |  |  |
| `:overwrite` | `boolean` | Specifies whether to overwrite hijacked files or not | No |
| `:preservetime` | `boolean` | Specifies that modification time should preserved from the VOB time. Mutually exclusive with currenttime. | No |
| `:rename` | `boolean` | Specifies that hijacked files should be renamed with a .keep extension | No |
| `:viewpath` | `String` | Path to the ClearCase snapshot view file or directory that the command will operate on | No |

**Reference**

https://ant.apache.org/manual/Tasks/clearcase.html#ccupdate

**Defined by**

`org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate`
sourceraw docstring

chainedmapperclj

(chainedmapper & args)

Ant type chainedmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Nested elements

  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Types/chainedmapper.html

Defined by

org.apache.tools.ant.util.ChainedMapper

Ant type chainedmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/chainedmapper.html

**Defined by**

`org.apache.tools.ant.util.ChainedMapper`
sourceraw docstring

checksumclj

(checksum & args)

Generates checksum for files. This task can also be used to perform checksum verifications. Note that many popular message digest functions-including MD5 and SHA-1-have been broken recently. If you are going to use the task to create checksums used in an environment where security is important, please take some time to investigate the algorithms offered by your JCE provider. Note also that some JCE providers like the one by The Legion of the Bouncy Castle, the GNU Crypto project or the Technical University Graz offer more digest algorithms than those built-in into your JDK. Warning: the case of the extension is that of the algorithm used. If you ask for SHA1, you get a .SHA1 extension; if you ask for sha1, you get a file ending in .sha1. The Java Crypto Engines are case-insensitive in matching algorithms, so choose a name to match your desired output extension, or set the fileext attribute. The names of common hashing algorithms can be located on the Cryptography Architecture Standard Algorithm Name Documentation

Attributes

AttributeTypeDescriptionRequired
:algorithmStringSpecifies the algorithm to be used to compute the checksum. Please check the documentation for available algorithm names, like SHA-1 or SHA-512.No; defaults to MD5
:casesensitiveboolean
:defaultexcludesboolean
:excludesString
:excludesfileFile
:fileFileThe file to generate checksum for.Yes, unless at least one nested (filesystem-only) resource collection is specified.
:fileextStringThe generated checksum file's name will be the original filename with the fileext added to it.No; defaults to a. and the algorithm name being used
:followsymlinksboolean
:forceoverwriteboolean
:formatFormatElement
:includesString
:includesfileFile
:patternStringSpecifies the pattern to use as a pattern suitable for MessageFormat where {0} is replaced with the checksum and {1} with the file name. Since Ant 1.7.0 Since Ant 1.8.2 {2} is replaced by the path of the file relative to the checksum file being written, {3} with the path of the file relative to the project's basedir and {4} with the absolute path of the file.No; default is {0}
:propertyStringThis attribute can mean two different things, it depends on the presence of the verifyproperty attribute. If you don't set the verifyproperty attribute, property specifies the name of the property to be set with the generated checksum value. If you set the verifyproperty attribute, property specifies the checksum you expect to be generated (the checksum itself, not a name of a property containing the checksum). This cannot be specified when fileext is being used or when the number of files for which checksums are to be generated is greater than 1.No
:providerStringSpecifies the provider of the algorithm.No
:readbuffersizeint
:todirFileThe root directory where checksums should be written.No; by default, checksum files will be written to the same directory as the original files. since Apache Ant 1.6
:totalpropertyString
:verifypropertyString

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/checksum.html

Defined by

org.apache.tools.ant.taskdefs.Checksum

Generates checksum for files. This task can also be used to perform checksum
verifications. Note that many popular message digest functions-including MD5 and
SHA-1-have been broken recently. If you are going to use the task to create checksums
used in an environment where security is important, please take some time to investigate
the algorithms offered by your JCE provider. Note also that some JCE providers like the
one by The Legion of the Bouncy Castle, the GNU Crypto project or the Technical
University Graz offer more digest algorithms than those built-in into your JDK. Warning:
the case of the extension is that of the algorithm used. If you ask for SHA1, you get a
.SHA1 extension; if you ask for sha1, you get a file ending in .sha1. The Java Crypto
Engines are case-insensitive in matching algorithms, so choose a name to match your
desired output extension, or set the fileext attribute. The names of common hashing
algorithms can be located on the Cryptography Architecture Standard Algorithm Name
Documentation

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:algorithm` | `String` | Specifies the algorithm to be used to compute the checksum. Please check the documentation for available algorithm names, like SHA-1 or SHA-512. | No; defaults to MD5 |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` | The file to generate checksum for. | Yes, unless at least one nested (filesystem-only) resource collection is specified. |
| `:fileext` | `String` | The generated checksum file's name will be the original filename with the fileext added to it. | No; defaults to a. and the algorithm name being used |
| `:followsymlinks` | `boolean` |  |  |
| `:forceoverwrite` | `boolean` |  |  |
| `:format` | `FormatElement` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:pattern` | `String` | Specifies the pattern to use as a pattern suitable for MessageFormat where {0} is replaced with the checksum and {1} with the file name. Since Ant 1.7.0 Since Ant 1.8.2 {2} is replaced by the path of the file relative to the checksum file being written, {3} with the path of the file relative to the project's basedir and {4} with the absolute path of the file. | No; default is {0} |
| `:property` | `String` | This attribute can mean two different things, it depends on the presence of the verifyproperty attribute. If you don't set the verifyproperty attribute, property specifies the name of the property to be set with the generated checksum value. If you set the verifyproperty attribute, property specifies the checksum you expect to be generated (the checksum itself, not a name of a property containing the checksum). This cannot be specified when fileext is being used or when the number of files for which checksums are to be generated is greater than 1. | No |
| `:provider` | `String` | Specifies the provider of the algorithm. | No |
| `:readbuffersize` | `int` |  |  |
| `:todir` | `File` | The root directory where checksums should be written. | No; by default, checksum files will be written to the same directory as the original files. since Apache Ant 1.6 |
| `:totalproperty` | `String` |  |  |
| `:verifyproperty` | `String` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/checksum.html

**Defined by**

`org.apache.tools.ant.taskdefs.Checksum`
sourceraw docstring

chgrpclj

(chgrp & args)

Changes the group of a file or all files inside specified directories. Right now it has effect only under Unix. The group attribute is equivalent to the corresponding argument for the chgrp command. FileSets, DirSets or FileLists can be specified using nested <fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this task supports arbitrary resource collections as nested elements. By default this task will use a single invocation of the underlying chgrp command. If you are working on a large number of files this may result in a command line that is too long for your operating system. If you encounter such problems, you should set the maxparallel attribute of this task to a non-zero value. The number to use highly depends on the length of your file names (the depth of your directory tree) and your operating system, so you'll have to experiment a little. POSIX recommends command line length limits of at least 4096 characters, this may give you an approximation for the number you could use as initial value for these experiments. By default this task won't do anything unless it detects it is running on a Unix system. If you know for sure that you have a chgrp executable on your PATH that is command line compatible with the Unix command, you can use the task's os attribute and set its value to your current OS.

Attributes

AttributeTypeDescriptionRequired
:addsourcefileboolean
:appendboolean
:commandCommandline
:destFile
:dirFile
:discarderrorboolean
:discardoutputboolean
:errorFile
:errorpropertyString
:executableString
:failifexecutionfailsboolean
:failonerrorboolean
:fileFilethe file or directory of which the group must be changed.Yes, unless nested <fileset|filelist|dirset> elements are specified
:forceboolean
:forwardslashboolean
:groupStringthe new group.Yes
:ignoremissingboolean
:inputFile
:inputstringString
:logerrorboolean
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited.No; defaults to unlimited
:newenvironmentboolean
:osStringlist of Operating Systems on which the command may be executed.No
:osfamilyStringOS family as used in the <os> condition.No; defaults to unix
:outputFile
:outputpropertyString
:parallelbooleanprocess all specified files using a single chgrp command.No; defaults to true
:relativeboolean
:resolveexecutableboolean
:resultpropertyString
:searchpathboolean
:skipemptyfilesetsboolean
:spawnboolean
:timeoutInteger
:typeFileDirBothOne of file, dir or both. If set to file, only the group of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not.No; defaults to false
:vmlauncherboolean

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/chgrp.html

Defined by

org.apache.tools.ant.taskdefs.optional.unix.Chgrp

Changes the group of a file or all files inside specified directories. Right now it has
effect only under Unix. The group attribute is equivalent to the corresponding argument
for the chgrp command. FileSets, DirSets or FileLists can be specified using nested
<fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this task supports arbitrary
resource collections as nested elements. By default this task will use a single
invocation of the underlying chgrp command. If you are working on a large number of
files this may result in a command line that is too long for your operating system. If
you encounter such problems, you should set the maxparallel attribute of this task to a
non-zero value. The number to use highly depends on the length of your file names (the
depth of your directory tree) and your operating system, so you'll have to experiment a
little. POSIX recommends command line length limits of at least 4096 characters, this
may give you an approximation for the number you could use as initial value for these
experiments. By default this task won't do anything unless it detects it is running on a
Unix system. If you know for sure that you have a chgrp executable on your PATH that is
command line compatible with the Unix command, you can use the task's os attribute and
set its value to your current OS.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` |  |  |
| `:append` | `boolean` |  |  |
| `:command` | `Commandline` |  |  |
| `:dest` | `File` |  |  |
| `:dir` | `File` |  |  |
| `:discarderror` | `boolean` |  |  |
| `:discardoutput` | `boolean` |  |  |
| `:error` | `File` |  |  |
| `:errorproperty` | `String` |  |  |
| `:executable` | `String` |  |  |
| `:failifexecutionfails` | `boolean` |  |  |
| `:failonerror` | `boolean` |  |  |
| `:file` | `File` | the file or directory of which the group must be changed. | Yes, unless nested <fileset\|filelist\|dirset> elements are specified |
| `:force` | `boolean` |  |  |
| `:forwardslash` | `boolean` |  |  |
| `:group` | `String` | the new group. | Yes |
| `:ignoremissing` | `boolean` |  |  |
| `:input` | `File` |  |  |
| `:inputstring` | `String` |  |  |
| `:logerror` | `boolean` |  |  |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. | No; defaults to unlimited |
| `:newenvironment` | `boolean` |  |  |
| `:os` | `String` | list of Operating Systems on which the command may be executed. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. | No; defaults to unix |
| `:output` | `File` |  |  |
| `:outputproperty` | `String` |  |  |
| `:parallel` | `boolean` | process all specified files using a single chgrp command. | No; defaults to true |
| `:relative` | `boolean` |  |  |
| `:resolveexecutable` | `boolean` |  |  |
| `:resultproperty` | `String` |  |  |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` |  |  |
| `:spawn` | `boolean` |  |  |
| `:timeout` | `Integer` |  |  |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the group of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. | No; defaults to false |
| `:vmlauncher` | `boolean` |  |  |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/chgrp.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.unix.Chgrp`
sourceraw docstring

chmodclj

(chmod & args)

Changes the permissions of a file or all files inside specified directories. Right now it has effect only under Unix or NonStop Kernel (Tandem). The permissions are also UNIX style, like the argument for the chmod command. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task holds an implicit FileSet and supports all of FileSet's attributes and nested elements directly. More sets can be specified using nested <fileset> or <dirset> (since Apache Ant 1.6) elements. Since Ant 1.6, this task also supports nested filelists. Since Ant 1.7, this task supports arbitrary resource collections as nested elements. By default this task will use a single invocation of the underlying chmod command. If you are working on a large number of files this may result in a command line that is too long for your operating system. If you encounter such problems, you should set the maxparallel attribute of this task to a non-zero value. The number to use highly depends on the length of your file names (the depth of your directory tree) and your operating system, so you'll have to experiment a little. POSIX recommends command line length limits of at least 4096 characters, this may give you an approximation for the number you could use as initial value for these experiments. By default this task won't do anything unless it detects it is running on a Unix system. If you know for sure that you have a chmod executable on your PATH that is command line compatible with the Unix command, you can use the task's os attribute and set its value to your current OS. See the setpermissions task for a platform independent alternative.

Attributes

AttributeTypeDescriptionRequired
:addsourcefileboolean
:appendboolean
:commandCommandline
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destFile
:dirFilethe directory which holds the files whose permissions must be changed. Note: for backwards compatibility reasons <chmod dir="some-dir"/> will only change the permissions on some-dir but not recurse into it, unless you also specify any patterns.Exactly one of the two, unless nested <fileset|filelist|dirset> elements are specified
:discarderrorboolean
:discardoutputboolean
:errorFile
:errorpropertyString
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:executableString
:failifexecutionfailsboolean
:failonerrorboolean
:fileFilethe file or single directory of which the permissions must be changed.Exactly one of the two, unless nested <fileset|filelist|dirset> elements are specified
:forceboolean
:forwardslashboolean
:ignoremissingboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:inputFile
:inputstringString
:logerrorboolean
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6.No; defaults to unlimited
:newenvironmentboolean
:osStringlist of Operating Systems on which the command may be executed.No
:osfamilyStringOS family as used in the <os> condition.No; defaults to unix
:outputFile
:outputpropertyString
:parallelbooleanprocess all specified files using a single chmod command.No; defaults to true
:permStringthe new permissions.Yes
:relativeboolean
:resolveexecutableboolean
:resultpropertyString
:searchpathboolean
:skipemptyfilesetsboolean
:spawnboolean
:timeoutInteger
:typeFileDirBothOne of file, dir or both. If set to file, only the permissions of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not. Since Ant 1.6.No; defaults to false
:vmlauncherboolean

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :exclude (NameEntry)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :mapper (Mapper)
  • :patternset (PatternSet)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/chmod.html

Defined by

org.apache.tools.ant.taskdefs.Chmod

Changes the permissions of a file or all files inside specified directories. Right now
it has effect only under Unix or NonStop Kernel (Tandem). The permissions are also UNIX
style, like the argument for the chmod command. See the section on directory based
tasks, on how the inclusion/exclusion of files works, and how to write patterns. This
task holds an implicit FileSet and supports all of FileSet's attributes and nested
elements directly. More sets can be specified using nested <fileset> or <dirset> (since
Apache Ant 1.6) elements. Since Ant 1.6, this task also supports nested filelists. Since
Ant 1.7, this task supports arbitrary resource collections as nested elements. By
default this task will use a single invocation of the underlying chmod command. If you
are working on a large number of files this may result in a command line that is too
long for your operating system. If you encounter such problems, you should set the
maxparallel attribute of this task to a non-zero value. The number to use highly depends
on the length of your file names (the depth of your directory tree) and your operating
system, so you'll have to experiment a little. POSIX recommends command line length
limits of at least 4096 characters, this may give you an approximation for the number
you could use as initial value for these experiments. By default this task won't do
anything unless it detects it is running on a Unix system. If you know for sure that you
have a chmod executable on your PATH that is command line compatible with the Unix
command, you can use the task's os attribute and set its value to your current OS. See
the setpermissions task for a platform independent alternative.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` |  |  |
| `:append` | `boolean` |  |  |
| `:command` | `Commandline` |  |  |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:dest` | `File` |  |  |
| `:dir` | `File` | the directory which holds the files whose permissions must be changed. Note: for backwards compatibility reasons <chmod dir="some-dir"/> will only change the permissions on some-dir but not recurse into it, unless you also specify any patterns. | Exactly one of the two, unless nested <fileset\|filelist\|dirset> elements are specified |
| `:discarderror` | `boolean` |  |  |
| `:discardoutput` | `boolean` |  |  |
| `:error` | `File` |  |  |
| `:errorproperty` | `String` |  |  |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:executable` | `String` |  |  |
| `:failifexecutionfails` | `boolean` |  |  |
| `:failonerror` | `boolean` |  |  |
| `:file` | `File` | the file or single directory of which the permissions must be changed. | Exactly one of the two, unless nested <fileset\|filelist\|dirset> elements are specified |
| `:force` | `boolean` |  |  |
| `:forwardslash` | `boolean` |  |  |
| `:ignoremissing` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:input` | `File` |  |  |
| `:inputstring` | `String` |  |  |
| `:logerror` | `boolean` |  |  |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6. | No; defaults to unlimited |
| `:newenvironment` | `boolean` |  |  |
| `:os` | `String` | list of Operating Systems on which the command may be executed. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. | No; defaults to unix |
| `:output` | `File` |  |  |
| `:outputproperty` | `String` |  |  |
| `:parallel` | `boolean` | process all specified files using a single chmod command. | No; defaults to true |
| `:perm` | `String` | the new permissions. | Yes |
| `:relative` | `boolean` |  |  |
| `:resolveexecutable` | `boolean` |  |  |
| `:resultproperty` | `String` |  |  |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` |  |  |
| `:spawn` | `boolean` |  |  |
| `:timeout` | `Integer` |  |  |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the permissions of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. Since Ant 1.6. | No; defaults to false |
| `:vmlauncher` | `boolean` |  |  |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:exclude` (`NameEntry`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:mapper` (`Mapper`)
- `:patternset` (`PatternSet`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/chmod.html

**Defined by**

`org.apache.tools.ant.taskdefs.Chmod`
sourceraw docstring

chownclj

(chown & args)

Changes the owner of a file or all files inside specified directories. Right now it has effect only under Unix. The owner attribute is equivalent to the corresponding argument for the chown command. FileSets, DirSets or FileLists can be specified using nested <fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this task supports arbitrary resource collections as nested elements. By default this task will use a single invocation of the underlying chown command. If you are working on a large number of files this may result in a command line that is too long for your operating system. If you encounter such problems, you should set the maxparallel attribute of this task to a non-zero value. The number to use highly depends on the length of your file names (the depth of your directory tree) and your operating system, so you'll have to experiment a little. POSIX recommends command line length limits of at least 4096 characters, this may give you an approximation for the number you could use as initial value for these experiments. By default this task won't do anything unless it detects it is running on a Unix system. If you know for sure that you have a chown executable on your PATH that is command line compatible with the Unix command, you can use the task's os attribute and set its value to your current OS.

Attributes

AttributeTypeDescriptionRequired
:addsourcefileboolean
:appendboolean
:commandCommandline
:destFile
:dirFile
:discarderrorboolean
:discardoutputboolean
:errorFile
:errorpropertyString
:executableString
:failifexecutionfailsboolean
:failonerrorboolean
:fileFilethe file or directory of which the owner must be changed.Yes, unless nested <fileset|filelist|dirset> elements are specified
:forceboolean
:forwardslashboolean
:ignoremissingboolean
:inputFile
:inputstringString
:logerrorboolean
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited.No; defaults to unlimited
:newenvironmentboolean
:osStringlist of Operating Systems on which the command may be executed.No
:osfamilyStringOS family as used in the <os> condition.No; defaults to unix
:outputFile
:outputpropertyString
:ownerStringthe new owner.Yes
:parallelbooleanprocess all specified files using a single chown command.No; defaults to true
:relativeboolean
:resolveexecutableboolean
:resultpropertyString
:searchpathboolean
:skipemptyfilesetsboolean
:spawnboolean
:timeoutInteger
:typeFileDirBothOne of file, dir or both. If set to file, only the owner of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not.No; defaults to false
:vmlauncherboolean

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/chown.html

Defined by

org.apache.tools.ant.taskdefs.optional.unix.Chown

Changes the owner of a file or all files inside specified directories. Right now it has
effect only under Unix. The owner attribute is equivalent to the corresponding argument
for the chown command. FileSets, DirSets or FileLists can be specified using nested
<fileset>, <dirset> and <filelist> elements. Since Ant 1.7, this task supports arbitrary
resource collections as nested elements. By default this task will use a single
invocation of the underlying chown command. If you are working on a large number of
files this may result in a command line that is too long for your operating system. If
you encounter such problems, you should set the maxparallel attribute of this task to a
non-zero value. The number to use highly depends on the length of your file names (the
depth of your directory tree) and your operating system, so you'll have to experiment a
little. POSIX recommends command line length limits of at least 4096 characters, this
may give you an approximation for the number you could use as initial value for these
experiments. By default this task won't do anything unless it detects it is running on a
Unix system. If you know for sure that you have a chown executable on your PATH that is
command line compatible with the Unix command, you can use the task's os attribute and
set its value to your current OS.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` |  |  |
| `:append` | `boolean` |  |  |
| `:command` | `Commandline` |  |  |
| `:dest` | `File` |  |  |
| `:dir` | `File` |  |  |
| `:discarderror` | `boolean` |  |  |
| `:discardoutput` | `boolean` |  |  |
| `:error` | `File` |  |  |
| `:errorproperty` | `String` |  |  |
| `:executable` | `String` |  |  |
| `:failifexecutionfails` | `boolean` |  |  |
| `:failonerror` | `boolean` |  |  |
| `:file` | `File` | the file or directory of which the owner must be changed. | Yes, unless nested <fileset\|filelist\|dirset> elements are specified |
| `:force` | `boolean` |  |  |
| `:forwardslash` | `boolean` |  |  |
| `:ignoremissing` | `boolean` |  |  |
| `:input` | `File` |  |  |
| `:inputstring` | `String` |  |  |
| `:logerror` | `boolean` |  |  |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. | No; defaults to unlimited |
| `:newenvironment` | `boolean` |  |  |
| `:os` | `String` | list of Operating Systems on which the command may be executed. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. | No; defaults to unix |
| `:output` | `File` |  |  |
| `:outputproperty` | `String` |  |  |
| `:owner` | `String` | the new owner. | Yes |
| `:parallel` | `boolean` | process all specified files using a single chown command. | No; defaults to true |
| `:relative` | `boolean` |  |  |
| `:resolveexecutable` | `boolean` |  |  |
| `:resultproperty` | `String` |  |  |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` |  |  |
| `:spawn` | `boolean` |  |  |
| `:timeout` | `Integer` |  |  |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the owner of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. | No; defaults to false |
| `:vmlauncher` | `boolean` |  |  |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/chown.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.unix.Chown`
sourceraw docstring

classclj

(class & args)

Ant nested class. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.Javah$ClassArgument

Ant nested class. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Javah$ClassArgument`
sourceraw docstring

classconstantsclj

(classconstants & args)

Ant nested classconstants. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.ClassConstants

Ant nested classconstants. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.ClassConstants`
sourceraw docstring

classesclj

(classes & args)

Ant nested classes. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeString
:encodingString
:erroronmissingarchiveboolean
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeString
:followsymlinksboolean
:fullpathString
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixString
:refidReference
:srcFile
:srcresourceResource

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ZipFileSet

Ant nested classes. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` |  |  |
| `:encoding` | `String` |  |  |
| `:erroronmissingarchive` | `boolean` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:src` | `File` |  |  |
| `:srcresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ZipFileSet`
sourceraw docstring

classfilesetclj

(classfileset & args)

A classfileset is a specialized type of fileset which, given a set of "root" classes, will include all of the class files upon which the root classes depend. This is typically used to create a jar with all of the required classes for a particular application. classfilesets are typically used by reference. They are declared with an id value and this is then used as a reference where a normal fileset is expected. This type requires the BCEL library.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference
:rootclassStringA single root class nameNo

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :root (ClassRoot)
  • :rootfileset (FileSet)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/classfileset.html

Defined by

org.apache.tools.ant.types.optional.depend.ClassfileSet

A classfileset is a specialized type of fileset which, given a set of "root" classes,
will include all of the class files upon which the root classes depend. This is
typically used to create a jar with all of the required classes for a particular
application. classfilesets are typically used by reference. They are declared with an id
value and this is then used as a reference where a normal fileset is expected. This type
requires the BCEL library.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |
| `:rootclass` | `String` | A single root class name | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:root` (`ClassRoot`)
- `:rootfileset` (`FileSet`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/classfileset.html

**Defined by**

`org.apache.tools.ant.types.optional.depend.ClassfileSet`
sourceraw docstring

classloaderclj

(classloader & args)

Ant task classloader. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:nameString
:parentfirstboolean
:parentnameString
:resetboolean
:reverseboolean

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/classloader.html

Defined by

org.apache.tools.ant.taskdefs.Classloader

Ant task classloader. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:name` | `String` |  |  |
| `:parentfirst` | `boolean` |  |  |
| `:parentname` | `String` |  |  |
| `:reset` | `boolean` |  |  |
| `:reverse` | `boolean` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/classloader.html

**Defined by**

`org.apache.tools.ant.taskdefs.Classloader`
sourceraw docstring

classpathclj

(classpath & args)

Ant nested classpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested classpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

commandlauncherclj

(commandlauncher & args)

Ant task commandlauncher. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:vmlauncherboolean

Reference

https://ant.apache.org/manual/Tasks/commandlauncher.html

Defined by

org.apache.tools.ant.taskdefs.CommandLauncherTask

Ant task commandlauncher. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:vmlauncher` | `boolean` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/commandlauncher.html

**Defined by**

`org.apache.tools.ant.taskdefs.CommandLauncherTask`
sourceraw docstring

commandlineclj

(commandline & args)

Ant nested commandline. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:executableString

Nested elements

  • :argument (Argument)
  • :marker (Marker)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline

Ant nested commandline. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:executable` | `String` |  |  |

**Nested elements**

- `:argument` (`Argument`)
- `:marker` (`Marker`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline`
sourceraw docstring

commandpathclj

(commandpath & args)

Ant nested commandpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested commandpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

commentclj

(comment & args)

Ant nested comment. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:valueString

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.StripLineComments$Comment

Ant nested comment. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:value` | `String` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.StripLineComments$Comment`
sourceraw docstring

compilerargclj

(compilerarg & args)

Ant nested compilerarg. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:compilerString
:fileFile
:implementationString
:lineString
:pathPath
:pathrefReference
:prefixString
:suffixString
:valueString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.Rmic$ImplementationSpecificArgument

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javac$ImplementationSpecificArgument

Ant nested compilerarg. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:compiler` | `String` |  |  |
| `:file` | `File` |  |  |
| `:implementation` | `String` |  |  |
| `:line` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:value` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.Rmic$ImplementationSpecificArgument`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javac$ImplementationSpecificArgument`
sourceraw docstring

compilerclasspathclj

(compilerclasspath & args)

Ant nested compilerclasspath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested compilerclasspath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

componentdefclj

(componentdef & args)

Adds a component definition to the current project. A component definition is the same as a typedef except: that it can only be used in other types or tasks that accept components (by having an add() method). multiple components may have the same name, provided they implement different interfaces. The purpose of this is to allow internal Apache Ant definitions to be made for tags like and or or.

Attributes

AttributeTypeDescriptionRequired
:adapterString
:adapttoString
:antlibString
:classnameString
:classpathPath
:classpathrefReference
:fileFile
:formatFormat
:loaderrefReference
:nameString
:onerrorOnError
:resourceString
:reverseloaderboolean
:uriString

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/componentdef.html

Defined by

org.apache.tools.ant.taskdefs.Componentdef

Adds a component definition to the current project. A component definition is the same
as a typedef except: that it can only be used in other types or tasks that accept
components (by having an add() method). multiple components may have the same name,
provided they implement different interfaces. The purpose of this is to allow internal
Apache Ant definitions to be made for tags like and or or.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:adapter` | `String` |  |  |
| `:adaptto` | `String` |  |  |
| `:antlib` | `String` |  |  |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:file` | `File` |  |  |
| `:format` | `Format` |  |  |
| `:loaderref` | `Reference` |  |  |
| `:name` | `String` |  |  |
| `:onerror` | `OnError` |  |  |
| `:resource` | `String` |  |  |
| `:reverseloader` | `boolean` |  |  |
| `:uri` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/componentdef.html

**Defined by**

`org.apache.tools.ant.taskdefs.Componentdef`
sourceraw docstring

compositemapperclj

(compositemapper & args)

Ant type compositemapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Nested elements

  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Types/compositemapper.html

Defined by

org.apache.tools.ant.util.CompositeMapper

Ant type compositemapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/compositemapper.html

**Defined by**

`org.apache.tools.ant.util.CompositeMapper`
sourceraw docstring

compressclj

(compress & args)

Ant nested compress. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:filesString
:levelCompressionLevel

Nested elements

  • :files (PatternListEntry)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$Compression

Ant nested compress. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:files` | `String` |  |  |
| `:level` | `CompressionLevel` |  |  |

**Nested elements**

- `:files` (`PatternListEntry`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$Compression`
sourceraw docstring

concatclj

(concat & args)

Concatenates one or more resources to a single file or to the console. The destination file will be created if it does not exist unless the resource list is empty and ignoreempty is true. Since Apache Ant 1.7.1, this task can be used as a resource collection that will return exactly one resource. Resource collections are used to select which resources are to be concatenated. There is no singular attribute to specify a single resource to concat.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanSpecifies whether or not the file specified by destfile should be appended.No; defaults to no
:binarybooleanSince Ant 1.6.2 If this attribute is set to true, the task concatenates the files in a byte by byte fashion. If this attribute is false, concat will not normally work for binary files due to character encoding issues. If this option is set to true, the destfile attribute must be set, and the task cannot used nested text. Also the attributes encoding, outputencoding, filelastline cannot be used.No; default is false
:destResource
:destfileFileThe destination file for the concatenated stream. If not specified the console will be used instead.No
:encodingStringSpecifies the encoding for the input files. Please see Supported Encodings for a list of possible values.No; defaults to default JVM character encoding
:eolCrLfSpecifies what the end of line character are for use by the fixlastline attribute. Since Ant 1.6 Valid values for this property are: cr: a single CR lf: a single LF crlf: the pair CRLF mac: a single CR unix: a single LF dos: the pair CRLFNo; default is platform dependent: lf for Unix, crlf for DOS family (including Windows), cr for Mac OS 9 or earlier
:filterbeforeconcatbooleanIf this attribute is set to true, the task applies the filterchain to each input after applying fixlastline. If this attribute is false, concat will apply the filterchain only once to the already concatenated inputs. Filtering of header and footer is not affected by this setting. Since Ant 1.10.10No; default is false
:fixlastlinebooleanSpecifies whether or not to check if each file concatenated is terminated by a new line. If this attribute is yes a new line will be appended to the stream if the file did not end in a new line. Since Ant 1.6. This attribute does not apply to embedded text.No; defaults to no
:forcebooleanSpecifies whether or not the file specified by destfile should be written to even if it is newer than all source files. Deprecated, use the overwrite attribute instead.No; defaults to yes
:forcereadonlybooleanOverwrite read-only destination files. Since Ant 1.8.2No; defaults to false
:ignoreemptybooleanSince Ant 1.8.0 Specifies whether or not the file specified by destfile should be created if the source resource list is empty.No; defaults to true
:outputencodingStringThe encoding to use when writing the output file. Since Ant 1.6.No; defaults to encoding if set or default JVM character encoding otherwise
:overwritebooleanSpecifies whether or not the file specified by destfile should be written to even if it is newer than all source files. Since Ant 1.8.2.No; defaults to yes
:resourcenameStringSince Ant 1.8.3 Specifies the name reported if this task is exposed as a resource.No

Nested elements

  • :filelist (FileList)
  • :fileset (FileSet)
  • :filterchain (FilterChain)
  • :footer (TextElement)
  • :header (TextElement)
  • :path (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/concat.html

Defined by

org.apache.tools.ant.taskdefs.Concat

Concatenates one or more resources to a single file or to the console. The destination
file will be created if it does not exist unless the resource list is empty and
ignoreempty is true. Since Apache Ant 1.7.1, this task can be used as a resource
collection that will return exactly one resource. Resource collections are used to
select which resources are to be concatenated. There is no singular attribute to specify
a single resource to concat.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Specifies whether or not the file specified by destfile should be appended. | No; defaults to no |
| `:binary` | `boolean` | Since Ant 1.6.2 If this attribute is set to true, the task concatenates the files in a byte by byte fashion. If this attribute is false, concat will not normally work for binary files due to character encoding issues. If this option is set to true, the destfile attribute must be set, and the task cannot used nested text. Also the attributes encoding, outputencoding, filelastline cannot be used. | No; default is false |
| `:dest` | `Resource` |  |  |
| `:destfile` | `File` | The destination file for the concatenated stream. If not specified the console will be used instead. | No |
| `:encoding` | `String` | Specifies the encoding for the input files. Please see Supported Encodings for a list of possible values. | No; defaults to default JVM character encoding |
| `:eol` | `CrLf` | Specifies what the end of line character are for use by the fixlastline attribute. Since Ant 1.6 Valid values for this property are: cr: a single CR lf: a single LF crlf: the pair CRLF mac: a single CR unix: a single LF dos: the pair CRLF | No; default is platform dependent: lf for Unix, crlf for DOS family (including Windows), cr for Mac OS 9 or earlier |
| `:filterbeforeconcat` | `boolean` | If this attribute is set to true, the task applies the filterchain to each input after applying fixlastline. If this attribute is false, concat will apply the filterchain only once to the already concatenated inputs. Filtering of header and footer is not affected by this setting. Since Ant 1.10.10 | No; default is false |
| `:fixlastline` | `boolean` | Specifies whether or not to check if each file concatenated is terminated by a new line. If this attribute is yes a new line will be appended to the stream if the file did not end in a new line. Since Ant 1.6. This attribute does not apply to embedded text. | No; defaults to no |
| `:force` | `boolean` | Specifies whether or not the file specified by destfile should be written to even if it is newer than all source files. Deprecated, use the overwrite attribute instead. | No; defaults to yes |
| `:forcereadonly` | `boolean` | Overwrite read-only destination files. Since Ant 1.8.2 | No; defaults to false |
| `:ignoreempty` | `boolean` | Since Ant 1.8.0 Specifies whether or not the file specified by destfile should be created if the source resource list is empty. | No; defaults to true |
| `:outputencoding` | `String` | The encoding to use when writing the output file. Since Ant 1.6. | No; defaults to encoding if set or default JVM character encoding otherwise |
| `:overwrite` | `boolean` | Specifies whether or not the file specified by destfile should be written to even if it is newer than all source files. Since Ant 1.8.2. | No; defaults to yes |
| `:resourcename` | `String` | Since Ant 1.8.3 Specifies the name reported if this task is exposed as a resource. | No |

**Nested elements**

- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:filterchain` (`FilterChain`)
- `:footer` (`TextElement`)
- `:header` (`TextElement`)
- `:path` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/concat.html

**Defined by**

`org.apache.tools.ant.taskdefs.Concat`
sourceraw docstring

concatfilterclj

(concatfilter & args)

Ant type concatfilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:appendFile
:prependFile

Reference

https://ant.apache.org/manual/Types/concatfilter.html

Defined by

org.apache.tools.ant.filters.ConcatFilter

Ant type concatfilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `File` |  |  |
| `:prepend` | `File` |  |  |

**Reference**

https://ant.apache.org/manual/Types/concatfilter.html

**Defined by**

`org.apache.tools.ant.filters.ConcatFilter`
sourceraw docstring

conditionclj

(condition & args)

Sets a property if a certain condition holds true-this is a generalization of Available and Uptodate. If the condition holds true, the property value is set to true by default; otherwise, the property is not set. You can set the value to something other than the default by specifying the value attribute. Conditions are specified as nested elements, you must specify exactly one condition.

Attributes

AttributeTypeDescriptionRequired
:elseObjectThe value to set the property to if the condition evaluates to false. Since Apache Ant 1.6.3No; by default the property will remain unset
:propertyStringThe name of the property to set.Yes
:valueObjectThe value to set the property to.No; defaults to true

Nested elements

  • :and (And)
  • :available (Available)
  • :checksum (Checksum)
  • :contains (Contains)
  • :equals (Equals)
  • :filesmatch (FilesMatch)
  • :http (Http)
  • :isfalse (IsFalse)
  • :isfileselected (IsFileSelected)
  • :isreference (IsReference)
  • :isset (IsSet)
  • :istrue (IsTrue)
  • :not (Not)
  • :or (Or)
  • :os (Os)
  • :socket (Socket)
  • :uptodate (UpToDate)

Reference

https://ant.apache.org/manual/Tasks/condition.html

Defined by

org.apache.tools.ant.taskdefs.ConditionTask

Sets a property if a certain condition holds true-this is a generalization of Available
and Uptodate. If the condition holds true, the property value is set to true by default;
otherwise, the property is not set. You can set the value to something other than the
default by specifying the value attribute. Conditions are specified as nested elements,
you must specify exactly one condition.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:else` | `Object` | The value to set the property to if the condition evaluates to false. Since Apache Ant 1.6.3 | No; by default the property will remain unset |
| `:property` | `String` | The name of the property to set. | Yes |
| `:value` | `Object` | The value to set the property to. | No; defaults to true |

**Nested elements**

- `:and` (`And`)
- `:available` (`Available`)
- `:checksum` (`Checksum`)
- `:contains` (`Contains`)
- `:equals` (`Equals`)
- `:filesmatch` (`FilesMatch`)
- `:http` (`Http`)
- `:isfalse` (`IsFalse`)
- `:isfileselected` (`IsFileSelected`)
- `:isreference` (`IsReference`)
- `:isset` (`IsSet`)
- `:istrue` (`IsTrue`)
- `:not` (`Not`)
- `:or` (`Or`)
- `:os` (`Os`)
- `:socket` (`Socket`)
- `:uptodate` (`UpToDate`)

**Reference**

https://ant.apache.org/manual/Tasks/condition.html

**Defined by**

`org.apache.tools.ant.taskdefs.ConditionTask`
sourceraw docstring

configpathclj

(configpath & args)

Ant nested configpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested configpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

connectionpropertyclj

(connectionproperty & args)

Ant nested connectionproperty. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile
:classpathPath
:classpathrefReference
:environmentString
:fileFile
:nameString
:prefixString
:prefixvaluesboolean
:refidReference
:relativeboolean
:resourceString
:runtimeString
:urlURL
:userpropertyboolean
:valueObject

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Property

Ant nested connectionproperty. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:environment` | `String` |  |  |
| `:file` | `File` |  |  |
| `:name` | `String` |  |  |
| `:prefix` | `String` |  |  |
| `:prefixvalues` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:relative` | `boolean` |  |  |
| `:resource` | `String` |  |  |
| `:runtime` | `String` |  |  |
| `:url` | `URL` |  |  |
| `:userproperty` | `boolean` |  |  |
| `:value` | `Object` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Property`
sourceraw docstring

containsclj

(contains & args)

Ant nested contains. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:encodingString
:errorString
:ignorewhitespaceboolean
:refidReference
:textString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.filters.LineContains$Contains
  • org.apache.tools.ant.taskdefs.condition.Contains

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.ContainsSelector

Ant nested contains. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:encoding` | `String` |  |  |
| `:error` | `String` |  |  |
| `:ignorewhitespace` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:text` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.filters.LineContains$Contains`
- `org.apache.tools.ant.taskdefs.condition.Contains`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.ContainsSelector`
sourceraw docstring

containsregexclj

(containsregex & args)

Ant nested containsregex. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean
:flagsString
:patternString
:replaceString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$ContainsRegex

Ant nested containsregex. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |
| `:flags` | `String` |  |  |
| `:pattern` | `String` |  |  |
| `:replace` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$ContainsRegex`
sourceraw docstring

containsregexpclj

(containsregexp & args)

Ant nested containsregexp. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:errorString
:expressionString
:multilineboolean
:refidReference
:singlelineboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.ContainsRegexpSelector

Ant nested containsregexp. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:error` | `String` |  |  |
| `:expression` | `String` |  |  |
| `:multiline` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:singleline` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.ContainsRegexpSelector`
sourceraw docstring

containsstringclj

(containsstring & args)

Ant nested containsstring. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:containsString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$ContainsString

Ant nested containsstring. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:contains` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$ContainsString`
sourceraw docstring

copyclj

(copy & args)

Copies a file or resource collection to a new file or directory. By default, files are only copied if the source file is newer than the destination file, or when the destination file does not exist - please see the granularity attribute for Ant's idea of newer. However, you can explicitly overwrite files with the overwrite attribute. Resource collections are used to select a group of files to copy. To use a resource collection, the todir attribute must be set. Note that some resources (for example the file resource) return absolute paths as names and the result of using them without using a nested mapper (or the flatten attribute) may not be what you expect. Note: If you employ filters in your copy operation, you should limit the copy to text files. Binary files will be corrupted by the copy operation. This applies whether the filters are implicitly defined by the filter task or explicitly provided to the copy operation as filtersets. See encoding note.

Attributes

AttributeTypeDescriptionRequired
:enablemultiplemappingsbooleanIf true the task will process to all the mappings for a given source path. If false the task will only process the first file or directory. This attribute is only relevant if there is a mapper subelement. since Ant 1.6.No; defaults to false
:encodingStringThe encoding to assume when filter-copying the files. since Ant 1.5.No; defaults to default JVM character encoding
:failonerrorbooleanIf false, log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying.No; defaults to true
:fileFileThe file to copy.Yes, unless a nested resource collection element is used
:filteringbooleanIndicates whether token filtering using the global build-file filters should take place during the copy. Note: Nested <filterset> elements will always be used, even if this attribute is not specified, or its value is false, no, or off.No; defaults to false
:flattenbooleanIgnore the directory structure of the source files, and copy all files into the directory specified by the todir attribute. Note that you can achieve the same effect by using a flatten mapper.No; defaults to false
:forcebooleanOverwrite read-only destination files. since Ant 1.8.2No; defaults to false
:granularitylongThe number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6.2.No; default is 1 second, or 2 seconds on DOS systems
:includeemptydirsbooleanCopy any empty directories included in the FileSet(s).No; defaults to true
:outputencodingStringThe encoding to use when writing the files. since Ant 1.6.No; defaults to encoding if set or default JVM character encoding otherwise
:overwritebooleanOverwrite existing files even if the destination files are newer.No; defaults to false
:preservelastmodifiedbooleanGive the copied files the same last modified time as the original source files.No; defaults to false
:quietbooleanIf true and failonerror is false, then do not log a warning message when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. since Ant 1.8.3.No; defaults to false
:todirFileThe directory to copy to.With the file attribute, either tofile or todir can be used. With nested resource collection elements, if the number of included resources is greater than 1, or if only the dir attribute is specified in the <fileset>, or if the file attribute is also specified, then only todir is allowed.
:tofileFileThe file to copy to. Prior to Apache Ant 1.8.2, the tofile attribute only supported file resources to copy from.With the file attribute, either tofile or todir can be used. With nested resource collection elements, if the number of included resources is greater than 1, or if only the dir attribute is specified in the <fileset>, or if the file attribute is also specified, then only todir is allowed.
:verbosebooleanLog the files that are being copied.No; defaults to false

Nested elements

  • :fileset (FileSet)
  • :filterchain (FilterChain)
  • :filterset (FilterSet)
  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Tasks/copy.html

Defined by

org.apache.tools.ant.taskdefs.Copy

Copies a file or resource collection to a new file or directory. By default, files are
only copied if the source file is newer than the destination file, or when the
destination file does not exist - please see the granularity attribute for Ant's idea of
newer. However, you can explicitly overwrite files with the overwrite attribute.
Resource collections are used to select a group of files to copy. To use a resource
collection, the todir attribute must be set. Note that some resources (for example the
file resource) return absolute paths as names and the result of using them without using
a nested mapper (or the flatten attribute) may not be what you expect. Note: If you
employ filters in your copy operation, you should limit the copy to text files. Binary
files will be corrupted by the copy operation. This applies whether the filters are
implicitly defined by the filter task or explicitly provided to the copy operation as
filtersets. See encoding note.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:enablemultiplemappings` | `boolean` | If true the task will process to all the mappings for a given source path. If false the task will only process the first file or directory. This attribute is only relevant if there is a mapper subelement. since Ant 1.6. | No; defaults to false |
| `:encoding` | `String` | The encoding to assume when filter-copying the files. since Ant 1.5. | No; defaults to default JVM character encoding |
| `:failonerror` | `boolean` | If false, log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. | No; defaults to true |
| `:file` | `File` | The file to copy. | Yes, unless a nested resource collection element is used |
| `:filtering` | `boolean` | Indicates whether token filtering using the global build-file filters should take place during the copy. Note: Nested <filterset> elements will always be used, even if this attribute is not specified, or its value is false, no, or off. | No; defaults to false |
| `:flatten` | `boolean` | Ignore the directory structure of the source files, and copy all files into the directory specified by the todir attribute. Note that you can achieve the same effect by using a flatten mapper. | No; defaults to false |
| `:force` | `boolean` | Overwrite read-only destination files. since Ant 1.8.2 | No; defaults to false |
| `:granularity` | `long` | The number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6.2. | No; default is 1 second, or 2 seconds on DOS systems |
| `:includeemptydirs` | `boolean` | Copy any empty directories included in the FileSet(s). | No; defaults to true |
| `:outputencoding` | `String` | The encoding to use when writing the files. since Ant 1.6. | No; defaults to encoding if set or default JVM character encoding otherwise |
| `:overwrite` | `boolean` | Overwrite existing files even if the destination files are newer. | No; defaults to false |
| `:preservelastmodified` | `boolean` | Give the copied files the same last modified time as the original source files. | No; defaults to false |
| `:quiet` | `boolean` | If true and failonerror is false, then do not log a warning message when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. since Ant 1.8.3. | No; defaults to false |
| `:todir` | `File` | The directory to copy to. | With the file attribute, either tofile or todir can be used. With nested resource collection elements, if the number of included resources is greater than 1, or if only the dir attribute is specified in the <fileset>, or if the file attribute is also specified, then only todir is allowed. |
| `:tofile` | `File` | The file to copy to. Prior to Apache Ant 1.8.2, the tofile attribute only supported file resources to copy from. | With the file attribute, either tofile or todir can be used. With nested resource collection elements, if the number of included resources is greater than 1, or if only the dir attribute is specified in the <fileset>, or if the file attribute is also specified, then only todir is allowed. |
| `:verbose` | `boolean` | Log the files that are being copied. | No; defaults to false |

**Nested elements**

- `:fileset` (`FileSet`)
- `:filterchain` (`FilterChain`)
- `:filterset` (`FilterSet`)
- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Tasks/copy.html

**Defined by**

`org.apache.tools.ant.taskdefs.Copy`
sourceraw docstring

copydirclj

(copydir & args)

Copies a directory tree from the source to the destination. It is possible to refine the set of files that are being copied. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes src) as well as the nested <include>, <exclude> and <patternset> elements.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destFilethe directory to copy to.Yes
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:filteringbooleanindicates whether token filtering should take place during the copyNo; default is false
:flattenbooleanignore directory structure of source directory, copy all files into a single directory, specified by the dest attribute.No; default is false
:followsymlinksboolean
:forceoverwritebooleanoverwrite existing files even if the destination files are newer.No; default is false
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:srcFilethe directory to copy.Yes

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/copydir.html

Defined by

org.apache.tools.ant.taskdefs.Copydir

Copies a directory tree from the source to the destination. It is possible to refine the
set of files that are being copied. This can be done with the includes, includesfile,
excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile
attribute you specify the files you want to have included by using patterns. The exclude
or excludesfile attribute is used to specify the files you want to have excluded. This
is also done with patterns. And finally with the defaultexcludes attribute, you can
specify whether you want to use default exclusions or not. See the section on directory
based tasks, on how the inclusion/exclusion of files works, and how to write patterns.
This task forms an implicit FileSet and supports most attributes of <fileset> (dir
becomes src) as well as the nested <include>, <exclude> and <patternset> elements.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:dest` | `File` | the directory to copy to. | Yes |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:filtering` | `boolean` | indicates whether token filtering should take place during the copy | No; default is false |
| `:flatten` | `boolean` | ignore directory structure of source directory, copy all files into a single directory, specified by the dest attribute. | No; default is false |
| `:followsymlinks` | `boolean` |  |  |
| `:forceoverwrite` | `boolean` | overwrite existing files even if the destination files are newer. | No; default is false |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:src` | `File` | the directory to copy. | Yes |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/copydir.html

**Defined by**

`org.apache.tools.ant.taskdefs.Copydir`
sourceraw docstring

copyfileclj

(copyfile & args)

Copies a file from the source to the destination. The file is only copied if the source file is newer than the destination file, or when the destination file does not exist.

Attributes

AttributeTypeDescriptionRequired
:destFilethe filename of the file where to copy to.Yes
:filteringStringindicates whether token filtering should take place during the copyNo; default is false
:forceoverwritebooleanoverwrite existing files even if the destination files are newer.No; default is false
:srcFilethe filename of the file to copy.Yes

Reference

https://ant.apache.org/manual/Tasks/copyfile.html

Defined by

org.apache.tools.ant.taskdefs.Copyfile

Copies a file from the source to the destination. The file is only copied if the source
file is newer than the destination file, or when the destination file does not exist.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dest` | `File` | the filename of the file where to copy to. | Yes |
| `:filtering` | `String` | indicates whether token filtering should take place during the copy | No; default is false |
| `:forceoverwrite` | `boolean` | overwrite existing files even if the destination files are newer. | No; default is false |
| `:src` | `File` | the filename of the file to copy. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/copyfile.html

**Defined by**

`org.apache.tools.ant.taskdefs.Copyfile`
sourceraw docstring

copypathclj

(copypath & args)

Ant task copypath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:destdirFile
:granularitylong
:pathPath
:pathrefReference
:preservelastmodifiedboolean

Nested elements

  • :path (Path)

Reference

https://ant.apache.org/manual/Tasks/copypath.html

Defined by

org.apache.tools.ant.taskdefs.CopyPath

Ant task copypath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:destdir` | `File` |  |  |
| `:granularity` | `long` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |
| `:preservelastmodified` | `boolean` |  |  |

**Nested elements**

- `:path` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/copypath.html

**Defined by**

`org.apache.tools.ant.taskdefs.CopyPath`
sourceraw docstring

customclj

(custom & args)

Ant nested custom. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:errorString
:refidReference

Nested elements

  • :classpath (Path)
  • :param (Parameter)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.ExtendSelector

Ant nested custom. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:param` (`Parameter`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.ExtendSelector`
sourceraw docstring

cutdirsmapperclj

(cutdirsmapper & args)

Ant type cutdirsmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:dirsint
:fromString
:toString

Reference

https://ant.apache.org/manual/Types/cutdirsmapper.html

Defined by

org.apache.tools.ant.types.mappers.CutDirsMapper

Ant type cutdirsmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dirs` | `int` |  |  |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/cutdirsmapper.html

**Defined by**

`org.apache.tools.ant.types.mappers.CutDirsMapper`
sourceraw docstring

cvsclj

(cvs & args)

Handles packages/modules retrieved from a CVS repository. Important: This task needs cvs binary on the path. If it isn't, you will get an error (such as error=2 on Windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working. Also note that this task assumes that the cvs executable is compatible with the Unix version, this is not completely true for certain other CVS clients-like CVSNT for example-and some operation may fail when using such an incompatible client. CVSNT Note: CVSNT prefers users to store the passwords inside the registry. If the cvspass task and the passfile attribute don't seem to work for you, the most likely reason is that CVSNT ignores your .cvspass file completely. See bugzilla report 21657 for recommended workarounds.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanwhether to append output/error when redirecting to a file.No; defaults to false
:commandStringthe CVS command to execute.No; default is checkout
:compressionbooleantrue (equivalent to compressionlevel=3) or falseNo; defaults to false
:compressionlevelintA number between 1 and 9 (corresponding to possible values for CVS -z# argument). Any other value is treated as compression=falseNo; defaults to no compression
:cvsrootStringthe CVSROOT variable.No
:cvsrshStringthe CVS_RSH variable.No
:dateStringUse the most recent revision no later than the given dateNo
:destFilethe directory where the checked out files should be placed. Note that this is different from CVS's -d command line switch as Apache Ant will never shorten pathnames to avoid empty directories.No; default is project's basedir
:errorFilethe file to direct standard error from the command.No; default is error to the log as MSG_WARN
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No; defaults to false
:noexecbooleanreport only, don't change any files.No; defaults to false
:outputFilethe file to direct standard output from the command.No; default is output to the log as MSG_INFO
:packageStringthe package/module to check out. Note: multiple attributes can be split using spaces. Use a nested <module> element if you want to specify a module with spaces in its name.No
:passfileFilePassword file to read passwords from.No; default is ~/.cvspass
:portintPort used by CVS to communicate with the server.No; default is 2401
:quietbooleansuppress informational messages. This is the same as -q on the command line.No; defaults to false
:reallyquietbooleansuppress all messages. This is the same as -Q on the command line. since Ant 1.6.No; defaults to false
:tagStringthe tag of the package/module to check out.No

Nested elements

  • :commandline (Commandline)
  • :module (Module)

Reference

https://ant.apache.org/manual/Tasks/cvs.html

Defined by

org.apache.tools.ant.taskdefs.Cvs

Handles packages/modules retrieved from a CVS repository. Important: This task needs cvs
binary on the path. If it isn't, you will get an error (such as error=2 on Windows). If
<cvs> doesn't work, try to execute cvs.exe from the command line in the target directory
in which you are working. Also note that this task assumes that the cvs executable is
compatible with the Unix version, this is not completely true for certain other CVS
clients-like CVSNT for example-and some operation may fail when using such an
incompatible client. CVSNT Note: CVSNT prefers users to store the passwords inside the
registry. If the cvspass task and the passfile attribute don't seem to work for you, the
most likely reason is that CVSNT ignores your .cvspass file completely. See bugzilla
report 21657 for recommended workarounds.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | whether to append output/error when redirecting to a file. | No; defaults to false |
| `:command` | `String` | the CVS command to execute. | No; default is checkout |
| `:compression` | `boolean` | true (equivalent to compressionlevel=3) or false | No; defaults to false |
| `:compressionlevel` | `int` | A number between 1 and 9 (corresponding to possible values for CVS -z# argument). Any other value is treated as compression=false | No; defaults to no compression |
| `:cvsroot` | `String` | the CVSROOT variable. | No |
| `:cvsrsh` | `String` | the CVS_RSH variable. | No |
| `:date` | `String` | Use the most recent revision no later than the given date | No |
| `:dest` | `File` | the directory where the checked out files should be placed. Note that this is different from CVS's -d command line switch as Apache Ant will never shorten pathnames to avoid empty directories. | No; default is project's basedir |
| `:error` | `File` | the file to direct standard error from the command. | No; default is error to the log as MSG_WARN |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No; defaults to false |
| `:noexec` | `boolean` | report only, don't change any files. | No; defaults to false |
| `:output` | `File` | the file to direct standard output from the command. | No; default is output to the log as MSG_INFO |
| `:package` | `String` | the package/module to check out. Note: multiple attributes can be split using spaces. Use a nested <module> element if you want to specify a module with spaces in its name. | No |
| `:passfile` | `File` | Password file to read passwords from. | No; default is ~/.cvspass |
| `:port` | `int` | Port used by CVS to communicate with the server. | No; default is 2401 |
| `:quiet` | `boolean` | suppress informational messages. This is the same as -q on the command line. | No; defaults to false |
| `:reallyquiet` | `boolean` | suppress all messages. This is the same as -Q on the command line. since Ant 1.6. | No; defaults to false |
| `:tag` | `String` | the tag of the package/module to check out. | No |

**Nested elements**

- `:commandline` (`Commandline`)
- `:module` (`Module`)

**Reference**

https://ant.apache.org/manual/Tasks/cvs.html

**Defined by**

`org.apache.tools.ant.taskdefs.Cvs`
sourceraw docstring

cvschangelogclj

(cvschangelog & args)

Generates an XML-formatted report file of the change logs recorded in a CVS repository. Important: This task needs cvs on the path. If it isn't, you will get an error (such as error=2 on Windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working. Also note that this task assumes that the cvs executable is compatible with the Unix version, this is not completely true for certain other CVS clients-like CVSNT for example-and some operation may fail when using such an incompatible client.

Attributes

AttributeTypeDescriptionRequired
:appendboolean
:commandString
:compressionboolean
:compressionlevelint
:cvsrootStringthe CVSROOT variable.No
:cvsrshStringthe CVS_RSH variable.No
:dateString
:daysinpastintSets the number of days into the past for which the change log information should be retrieved.No
:destFile
:destfileFileThe file in which to write the change log report.Yes
:dirFileThe directory from which to run the cvs log command.No; defaults to ${basedir}
:endDateThe latest date to which change logs are to be included in the report.No
:endtagStringThe end of a tag range. If startTag is also specified, they must both be on the same branch. If startTag is not specified, the start of the range will be the top of the branch on which endTag lives. Since Ant 1.8.0No
:errorFile
:failonerrorbooleanStop the build process if the command exits with a return code other than 0No; defaults to false
:noexecboolean
:outputFile
:packageStringthe package/module to check out. Note: multiple attributes can be split using spaces. Use a nested <module> element if you want to specify a module with spaces in its name.No
:passfileFilePassword file to read passwords from.No; defaults to ~/.cvspass
:portintPort used by CVS to communicate with the server.No; defaults to 2401
:quietboolean
:reallyquietboolean
:remotebooleanIf set to true, works against the repository (using cvs rlog) without a working copy. Since Ant 1.8.0No; default is false
:startDateThe earliest date from which change logs are to be included in the report.No
:starttagStringThe start of a tag range. If endTag is also specified, they must both be on the same branch. If endTag is not specified, the end of the range will be the latest on the same branch on which startTag lives. Since Ant 1.8.0No
:tagStringquery the changelog for a specific branch.No
:usersfileFileProperty file that contains name-value pairs mapping user IDs and names that should be used in the report in place of the user ID.No

Nested elements

  • :commandline (Commandline)
  • :fileset (FileSet)
  • :module (Module)
  • :user (CvsUser)

Reference

https://ant.apache.org/manual/Tasks/changelog.html

Defined by

org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask

Generates an XML-formatted report file of the change logs recorded in a CVS repository.
Important: This task needs cvs on the path. If it isn't, you will get an error (such as
error=2 on Windows). If <cvs> doesn't work, try to execute cvs.exe from the command line
in the target directory in which you are working. Also note that this task assumes that
the cvs executable is compatible with the Unix version, this is not completely true for
certain other CVS clients-like CVSNT for example-and some operation may fail when using
such an incompatible client.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` |  |  |
| `:command` | `String` |  |  |
| `:compression` | `boolean` |  |  |
| `:compressionlevel` | `int` |  |  |
| `:cvsroot` | `String` | the CVSROOT variable. | No |
| `:cvsrsh` | `String` | the CVS_RSH variable. | No |
| `:date` | `String` |  |  |
| `:daysinpast` | `int` | Sets the number of days into the past for which the change log information should be retrieved. | No |
| `:dest` | `File` |  |  |
| `:destfile` | `File` | The file in which to write the change log report. | Yes |
| `:dir` | `File` | The directory from which to run the cvs log command. | No; defaults to ${basedir} |
| `:end` | `Date` | The latest date to which change logs are to be included in the report. | No |
| `:endtag` | `String` | The end of a tag range. If startTag is also specified, they must both be on the same branch. If startTag is not specified, the start of the range will be the top of the branch on which endTag lives. Since Ant 1.8.0 | No |
| `:error` | `File` |  |  |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0 | No; defaults to false |
| `:noexec` | `boolean` |  |  |
| `:output` | `File` |  |  |
| `:package` | `String` | the package/module to check out. Note: multiple attributes can be split using spaces. Use a nested <module> element if you want to specify a module with spaces in its name. | No |
| `:passfile` | `File` | Password file to read passwords from. | No; defaults to ~/.cvspass |
| `:port` | `int` | Port used by CVS to communicate with the server. | No; defaults to 2401 |
| `:quiet` | `boolean` |  |  |
| `:reallyquiet` | `boolean` |  |  |
| `:remote` | `boolean` | If set to true, works against the repository (using cvs rlog) without a working copy. Since Ant 1.8.0 | No; default is false |
| `:start` | `Date` | The earliest date from which change logs are to be included in the report. | No |
| `:starttag` | `String` | The start of a tag range. If endTag is also specified, they must both be on the same branch. If endTag is not specified, the end of the range will be the latest on the same branch on which startTag lives. Since Ant 1.8.0 | No |
| `:tag` | `String` | query the changelog for a specific branch. | No |
| `:usersfile` | `File` | Property file that contains name-value pairs mapping user IDs and names that should be used in the report in place of the user ID. | No |

**Nested elements**

- `:commandline` (`Commandline`)
- `:fileset` (`FileSet`)
- `:module` (`Module`)
- `:user` (`CvsUser`)

**Reference**

https://ant.apache.org/manual/Tasks/changelog.html

**Defined by**

`org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask`
sourceraw docstring

cvspassclj

(cvspass & args)

Adds entries to a .cvspass file. Adding entries to this file has the same affect as a cvs login command. CVSNT Note: CVSNT prefers users to store the passwords inside the registry. If the task doesn't seem to work for you, the most likely reason is that CVSNT ignores your .cvspass file completely. See bugzilla report 21657 for recommended workarounds.

Attributes

AttributeTypeDescriptionRequired
:cvsrootStringthe CVS repository to add an entry for.Yes
:passfileFilePassword file to add the entry to.No; default is ~/.cvspass
:passwordStringPassword to be added to the password file.Yes

Reference

https://ant.apache.org/manual/Tasks/cvspass.html

Defined by

org.apache.tools.ant.taskdefs.CVSPass

Adds entries to a .cvspass file. Adding entries to this file has the same affect as a
cvs login command. CVSNT Note: CVSNT prefers users to store the passwords inside the
registry. If the task doesn't seem to work for you, the most likely reason is that CVSNT
ignores your .cvspass file completely. See bugzilla report 21657 for recommended
workarounds.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cvsroot` | `String` | the CVS repository to add an entry for. | Yes |
| `:passfile` | `File` | Password file to add the entry to. | No; default is ~/.cvspass |
| `:password` | `String` | Password to be added to the password file. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/cvspass.html

**Defined by**

`org.apache.tools.ant.taskdefs.CVSPass`
sourceraw docstring

cvstagdiffclj

(cvstagdiff & args)

Generates an XML-formatted report file of the changes between two tags or dates recorded in a CVS repository. Important: This task needs cvs on the path. If it isn't, you will get an error (such as error=2 on Windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working. Also note that this task assumes that the cvs executable is compatible with the Unix version, this is not completely true for certain other CVS clients-like CVSNT for example-and some operation may fail when using such an incompatible client. This task captures the output of the CVS command in a file inside of the temporary directory.

Attributes

AttributeTypeDescriptionRequired
:appendboolean
:commandString
:compressionboolean
:compressionlevelint
:cvsrootString
:cvsrshString
:dateString
:destFile
:destfileFileThe file in which to write the diff report.Yes
:enddateStringThe latest date from which diffs are to be included in the report. Accepts all formats accepted by the cvs command for -D date_spec arguments.Exactly one of the two
:endtagStringThe latest tag from which diffs are to be included in the report.Exactly one of the two
:errorFile
:failonerrorboolean
:ignoreremovedboolean
:noexecboolean
:outputFile
:packageString
:passfileFile
:portint
:quietboolean
:reallyquietboolean
:startdateStringThe earliest date from which diffs are to be included in the report. Accepts all formats accepted by the cvs command for -D date_spec arguments.Exactly one of the two
:starttagStringThe earliest tag from which diffs are to be included in the report.Exactly one of the two
:tagString

Nested elements

  • :commandline (Commandline)
  • :module (Module)

Reference

https://ant.apache.org/manual/Tasks/cvstagdiff.html

Defined by

org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff

Generates an XML-formatted report file of the changes between two tags or dates recorded
in a CVS repository. Important: This task needs cvs on the path. If it isn't, you will
get an error (such as error=2 on Windows). If <cvs> doesn't work, try to execute cvs.exe
from the command line in the target directory in which you are working. Also note that
this task assumes that the cvs executable is compatible with the Unix version, this is
not completely true for certain other CVS clients-like CVSNT for example-and some
operation may fail when using such an incompatible client. This task captures the output
of the CVS command in a file inside of the temporary directory.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` |  |  |
| `:command` | `String` |  |  |
| `:compression` | `boolean` |  |  |
| `:compressionlevel` | `int` |  |  |
| `:cvsroot` | `String` |  |  |
| `:cvsrsh` | `String` |  |  |
| `:date` | `String` |  |  |
| `:dest` | `File` |  |  |
| `:destfile` | `File` | The file in which to write the diff report. | Yes |
| `:enddate` | `String` | The latest date from which diffs are to be included in the report. Accepts all formats accepted by the cvs command for -D date_spec arguments. | Exactly one of the two |
| `:endtag` | `String` | The latest tag from which diffs are to be included in the report. | Exactly one of the two |
| `:error` | `File` |  |  |
| `:failonerror` | `boolean` |  |  |
| `:ignoreremoved` | `boolean` |  |  |
| `:noexec` | `boolean` |  |  |
| `:output` | `File` |  |  |
| `:package` | `String` |  |  |
| `:passfile` | `File` |  |  |
| `:port` | `int` |  |  |
| `:quiet` | `boolean` |  |  |
| `:reallyquiet` | `boolean` |  |  |
| `:startdate` | `String` | The earliest date from which diffs are to be included in the report. Accepts all formats accepted by the cvs command for -D date_spec arguments. | Exactly one of the two |
| `:starttag` | `String` | The earliest tag from which diffs are to be included in the report. | Exactly one of the two |
| `:tag` | `String` |  |  |

**Nested elements**

- `:commandline` (`Commandline`)
- `:module` (`Module`)

**Reference**

https://ant.apache.org/manual/Tasks/cvstagdiff.html

**Defined by**

`org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff`
sourceraw docstring

cvsversionclj

(cvsversion & args)

This task allows to retrieve a CVS client and server version.

Attributes

AttributeTypeDescriptionRequired
:appendboolean
:clientversionpropertyStringName of a property where the CVS client version should be storedNo
:commandString
:compressionboolean
:compressionlevelint
:cvsrootStringthe CVSROOT variable.No
:cvsrshStringthe CVS_RSH variable.No
:dateString
:destFiledirectory containing the checked out version of the projectNo; default is project's basedir
:errorFile
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No; defaults to false
:noexecboolean
:outputFile
:packageStringthe package/module to check out.No
:passfileFilePassword file to read passwords from.No; default is ~/.cvspass
:portintPort used by CVS to communicate with the server.No; default is 2401
:quietboolean
:reallyquietboolean
:serverversionpropertyStringName of a property where the CVS server version should be storedNo
:tagString

Nested elements

  • :commandline (Commandline)
  • :module (Module)

Reference

https://ant.apache.org/manual/Tasks/cvsversion.html

Defined by

org.apache.tools.ant.taskdefs.cvslib.CvsVersion

This task allows to retrieve a CVS client and server version.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` |  |  |
| `:clientversionproperty` | `String` | Name of a property where the CVS client version should be stored | No |
| `:command` | `String` |  |  |
| `:compression` | `boolean` |  |  |
| `:compressionlevel` | `int` |  |  |
| `:cvsroot` | `String` | the CVSROOT variable. | No |
| `:cvsrsh` | `String` | the CVS_RSH variable. | No |
| `:date` | `String` |  |  |
| `:dest` | `File` | directory containing the checked out version of the project | No; default is project's basedir |
| `:error` | `File` |  |  |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No; defaults to false |
| `:noexec` | `boolean` |  |  |
| `:output` | `File` |  |  |
| `:package` | `String` | the package/module to check out. | No |
| `:passfile` | `File` | Password file to read passwords from. | No; default is ~/.cvspass |
| `:port` | `int` | Port used by CVS to communicate with the server. | No; default is 2401 |
| `:quiet` | `boolean` |  |  |
| `:reallyquiet` | `boolean` |  |  |
| `:serverversionproperty` | `String` | Name of a property where the CVS server version should be stored | No |
| `:tag` | `String` |  |  |

**Nested elements**

- `:commandline` (`Commandline`)
- `:module` (`Module`)

**Reference**

https://ant.apache.org/manual/Tasks/cvsversion.html

**Defined by**

`org.apache.tools.ant.taskdefs.cvslib.CvsVersion`
sourceraw docstring

daemonsclj

(daemons & args)

Ant nested daemons. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Parallel$TaskList

Ant nested daemons. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Parallel$TaskList`
sourceraw docstring

dateclj

(date & args)

Ant nested date. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:checkdirsboolean
:datetimeString
:errorString
:granularityint
:millislong
:patternString
:refidReference
:whenTimeComparisons

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.DateSelector

Ant nested date. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:checkdirs` | `boolean` |  |  |
| `:datetime` | `String` |  |  |
| `:error` | `String` |  |  |
| `:granularity` | `int` |  |  |
| `:millis` | `long` |  |  |
| `:pattern` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:when` | `TimeComparisons` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.DateSelector`
sourceraw docstring

defaultexcludesclj

(defaultexcludes & args)

Alters the default excludes for all subsequent processing in the build, and prints out the current default excludes if desired.

Attributes

AttributeTypeDescriptionRequired
:addStringthe pattern to add to the default excludesif no other attribute is specified
:defaultbooleango back to hard wired default excludestrue required if no other attribute is specified
:echobooleanwhether or not to print out the default excludestrue required if no other attribute specified; defaults to false
:removeStringremove the specified pattern from the default excludesif no other attribute is specified

Reference

https://ant.apache.org/manual/Tasks/defaultexcludes.html

Defined by

org.apache.tools.ant.taskdefs.DefaultExcludes

Alters the default excludes for all subsequent processing in the build, and prints out
the current default excludes if desired.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:add` | `String` | the pattern to add to the default excludes | if no other attribute is specified |
| `:default` | `boolean` | go back to hard wired default excludes | true required if no other attribute is specified |
| `:echo` | `boolean` | whether or not to print out the default excludes | true required if no other attribute specified; defaults to false |
| `:remove` | `String` | remove the specified pattern from the default excludes | if no other attribute is specified |

**Reference**

https://ant.apache.org/manual/Tasks/defaultexcludes.html

**Defined by**

`org.apache.tools.ant.taskdefs.DefaultExcludes`
sourceraw docstring

delegateclj

(delegate & args)

Ant nested delegate. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.PropertyHelperTask$DelegateElement

Ant nested delegate. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.PropertyHelperTask$DelegateElement`
sourceraw docstring

deleteclj

(delete & args)

Deletes a single file, a symbolic link or Windows junction, a specified directory and all its files and subdirectories, or a set of files specified by one or more resource collections. The literal implication of <fileset> is that directories are not included; however the removal of empty directories can be triggered when using nested filesets by setting the includeEmptyDirs attribute to true. Note that this attribute is meaningless in the context of any of the various resource collection types that do include directories, but that no attempt will be made to delete non-empty directories in any case. Whether a directory is empty or not is decided by looking into the filesystem-include or exclude patterns don't apply here. If you use this task to delete temporary files created by editors and it doesn't seem to work, read up on the default exclusion set in Directory-based Tasks, and see the defaultexcludes attribute below. For historical reasons <delete dir="x"/> is different from <delete><fileset dir="x"/></delete>; it will try to remove everything inside x including x itself, not taking default excludes into account, blindly following all symbolic links. If you need more control, use a nested <fileset>.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesbooleanDeprecated. Use resource collections. Whether to use default excludes.No; default true
:deleteonexitbooleanIndicates whether to use File#deleteOnExit() if there is a failure to delete a file. This causes the JVM to attempt to delete the file when the JVM process is terminating. Since Ant 1.6.2No; default false
:dirFileThe directory to delete, including all its files and subdirectories. Note: dir is not used to specify a directory name for file; file and dir are independent of each other. Warning: Do not set dir to ., ${basedir}, or the full-pathname equivalent unless you truly intend to recursively remove the entire contents of the current base directory (and the base directory itself, if different from the current working directory).At least one of the three, unless nested resource collections are specified
:excludesStringDeprecated. Use resource collections. Comma- or space-separated list of patterns of files that must be excluded from the deletion list. All files are relative to the directory specified in dir.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFileDeprecated. Use resource collections. Name of a file; each line of this file is taken to be an exclude patternNo
:failonerrorbooleanControls whether an error (such as a failure to delete a file) stops the build or is merely reported to the screen. Only relevant if quiet is false.No; default true
:fileFileThe file to delete, specified as either the simple filename (if the file exists in the current base directory), a relative-path filename, or a full-path filename.At least one of the three, unless nested resource collections are specified
:followsymlinksboolean
:includeemptydirsbooleanWhether to delete empty directories when using filesets.No; default false
:includesStringDeprecated. Use resource collections. Comma- or space-separated list of patterns of files that must be deleted. All files are relative to the directory specified in dir.No
:includesfileFileDeprecated. Use resource collections. Name of a file; each line of this file is taken to be an include pattern.No
:linkFileThe symbolic link or Windows junction to delete, specified as either the simple filename (if the link exists in the current base directory), a relative-path filename, or a full-path filename. since Ant 1.10.16.At least one of the three, unless nested resource collections are specified
:performgconfaileddeletebooleanIf Ant fails to delete a file or directory it will retry the operation once. If this flag is set to true it will perform a garbage collection before retrying the delete. Setting this flag to true is known to resolve some problems on Windows (where it defaults to true) but also for directory trees residing on an NFS share. Since Ant 1.8.3No; default true on Windows and true on any other OS
:quietbooleanIf the specified file or directory does not exist, do not display a diagnostic message (unless Apache Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. When set to true, if a file or directory cannot be deleted, no error is reported. This setting emulates the -f option to the Unix rm command. Setting this to true implies setting failonerror to false.No; default false
:removenotfollowedsymlinksbooleanWhether symbolic links (not the files/directories they link to) should be removed if they haven't been followed because followSymlinks was false or the maximum number of symbolic links was too big. Since Ant 1.8.0 Since since Ant 1.10.16 this also applies to not followed windows junctions.No; default false
:verbosebooleanWhether to show the name of each deleted file.No; default false

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/delete.html

Defined by

org.apache.tools.ant.taskdefs.Delete

Deletes a single file, a symbolic link or Windows junction, a specified directory and
all its files and subdirectories, or a set of files specified by one or more resource
collections. The literal implication of <fileset> is that directories are not included;
however the removal of empty directories can be triggered when using nested filesets by
setting the includeEmptyDirs attribute to true. Note that this attribute is meaningless
in the context of any of the various resource collection types that do include
directories, but that no attempt will be made to delete non-empty directories in any
case. Whether a directory is empty or not is decided by looking into the
filesystem-include or exclude patterns don't apply here. If you use this task to delete
temporary files created by editors and it doesn't seem to work, read up on the default
exclusion set in Directory-based Tasks, and see the defaultexcludes attribute below. For
historical reasons <delete dir="x"/> is different from <delete><fileset
dir="x"/></delete>; it will try to remove everything inside x including x itself, not
taking default excludes into account, blindly following all symbolic links. If you need
more control, use a nested <fileset>.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` | Deprecated. Use resource collections. Whether to use default excludes. | No; default true |
| `:deleteonexit` | `boolean` | Indicates whether to use File#deleteOnExit() if there is a failure to delete a file. This causes the JVM to attempt to delete the file when the JVM process is terminating. Since Ant 1.6.2 | No; default false |
| `:dir` | `File` | The directory to delete, including all its files and subdirectories. Note: dir is not used to specify a directory name for file; file and dir are independent of each other. Warning: Do not set dir to ., ${basedir}, or the full-pathname equivalent unless you truly intend to recursively remove the entire contents of the current base directory (and the base directory itself, if different from the current working directory). | At least one of the three, unless nested resource collections are specified |
| `:excludes` | `String` | Deprecated. Use resource collections. Comma- or space-separated list of patterns of files that must be excluded from the deletion list. All files are relative to the directory specified in dir. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | Deprecated. Use resource collections. Name of a file; each line of this file is taken to be an exclude pattern | No |
| `:failonerror` | `boolean` | Controls whether an error (such as a failure to delete a file) stops the build or is merely reported to the screen. Only relevant if quiet is false. | No; default true |
| `:file` | `File` | The file to delete, specified as either the simple filename (if the file exists in the current base directory), a relative-path filename, or a full-path filename. | At least one of the three, unless nested resource collections are specified |
| `:followsymlinks` | `boolean` |  |  |
| `:includeemptydirs` | `boolean` | Whether to delete empty directories when using filesets. | No; default false |
| `:includes` | `String` | Deprecated. Use resource collections. Comma- or space-separated list of patterns of files that must be deleted. All files are relative to the directory specified in dir. | No |
| `:includesfile` | `File` | Deprecated. Use resource collections. Name of a file; each line of this file is taken to be an include pattern. | No |
| `:link` | `File` | The symbolic link or Windows junction to delete, specified as either the simple filename (if the link exists in the current base directory), a relative-path filename, or a full-path filename. since Ant 1.10.16. | At least one of the three, unless nested resource collections are specified |
| `:performgconfaileddelete` | `boolean` | If Ant fails to delete a file or directory it will retry the operation once. If this flag is set to true it will perform a garbage collection before retrying the delete. Setting this flag to true is known to resolve some problems on Windows (where it defaults to true) but also for directory trees residing on an NFS share. Since Ant 1.8.3 | No; default true on Windows and true on any other OS |
| `:quiet` | `boolean` | If the specified file or directory does not exist, do not display a diagnostic message (unless Apache Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. When set to true, if a file or directory cannot be deleted, no error is reported. This setting emulates the -f option to the Unix rm command. Setting this to true implies setting failonerror to false. | No; default false |
| `:removenotfollowedsymlinks` | `boolean` | Whether symbolic links (not the files/directories they link to) should be removed if they haven't been followed because followSymlinks was false or the maximum number of symbolic links was too big. Since Ant 1.8.0 Since since Ant 1.10.16 this also applies to not followed windows junctions. | No; default false |
| `:verbose` | `boolean` | Whether to show the name of each deleted file. | No; default false |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/delete.html

**Defined by**

`org.apache.tools.ant.taskdefs.Delete`
sourceraw docstring

deletecharactersclj

(deletecharacters & args)

Ant nested deletecharacters. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:charsString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$DeleteCharacters

Ant nested deletecharacters. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:chars` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$DeleteCharacters`
sourceraw docstring

deltreeclj

(deltree & args)

Deletes a directory with all its files and subdirectories.

Attributes

AttributeTypeDescriptionRequired
:dirFilethe directory to delete.Yes

Reference

https://ant.apache.org/manual/Tasks/deltree.html

Defined by

org.apache.tools.ant.taskdefs.Deltree

Deletes a directory with all its files and subdirectories.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dir` | `File` | the directory to delete. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/deltree.html

**Defined by**

`org.apache.tools.ant.taskdefs.Deltree`
sourceraw docstring

dependclj

(depend & args)

The depend task works by determining which classes are out of date with respect to their source and then removing the class files of any other classes which depend on the out-of-date classes. To determine the class dependencies, the depend task analyzes the class files of all class files passed to it. The task does not parse your source code in any way but relies upon the class references encoded into the class files by the compiler. This is generally faster than parsing the Java source files. To learn more about how this information is obtained from the class files, please refer to the Java Virtual Machine Specification Since a class' dependencies only change when the class itself changes, the depend task is able to cache dependency information. Only those class files which have changed will have their dependency information re-analysed. Note that if you change a class' dependencies by changing the source, it will be recompiled anyway. You can examine the dependency files created to understand the dependencies of your classes. Please do not rely, however, on the format of the information, as it may change in a later release. Once depend discovers all of the class dependencies, it "inverts" this relation to determine, for each class, which other classes are dependent upon it. This "affects" list is used to discover which classes are invalidated by the out of date class. The class files of the invalidated classes are removed, triggering the compilation of the affected classes. The depend task supports an attribute, closure, which controls whether depend will only consider direct class-class relationships or whether it will also consider transitive, indirect relationships. For example, say there are three classes, A, which depends on B, which in-turn depends on C. Now say that class C is out of date. Without closure, only class B would be removed by depend. With closure set, class A would also be removed. Normally direct relationships are sufficient-it is unusual for a class to depend on another without having a direct relationship. With closure set, you will notice that depend typically removes far more class files. The classpath attribute for <depend> is optional. If it is present, depend will check class dependencies against classes and jars on this classpath. Any classes which depend on an element from this classpath and which are older than that element will be deleted. A typical example where you would use this facility would be where you are building a utility jar and want to make sure classes which are out of date with respect to this jar are rebuilt. In this classpath, you should not include jars that you do not expect to change, such as the JDK runtime jar or third party jars, since doing so will just slow down the dependency check. This means that if you do use a classpath for the depend task it may be different from the classpath necessary to actually compile your code.

Attributes

AttributeTypeDescriptionRequired
:cacheFileThis is a directory in which depend can store and retrieve dependency information.No; defaults to no cache
:casesensitiveboolean
:classpathPathThe classpath containing jars and classes for which <depend> should also check dependenciesNo
:classpathrefReference
:closurebooleanThis attribute controls whether depend only removes classes which directly depend on out of date classes. If this is set to true, depend will traverse the class dependency graph deleting all affected classes.No; defaults to false
:defaultexcludesboolean
:destdirPathThis is the root directory of the class files which will be analysed.No; defaults to srcdir
:dumpbooleanIf true the dependency information will be written to the debug level logNo; default is false
:excludesString
:excludesfileFile
:followsymlinksboolean
:includesString
:includesfileFile
:srcdirPathThis is the directory where the source exists. depend will examine this to determine which classes are out of date. If you use multiple source directories you can pass this attribute a path of source directories.Yes
:warnonrmistubsbooleanFlag to disable warnings about files that look like rmic generated stub/skeleton classes and have no .java source. Useful when doing RMI development.No; default true

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/depend.html

Defined by

org.apache.tools.ant.taskdefs.optional.depend.Depend

The depend task works by determining which classes are out of date with respect to their
source and then removing the class files of any other classes which depend on the
out-of-date classes. To determine the class dependencies, the depend task analyzes the
class files of all class files passed to it. The task does not parse your source code in
any way but relies upon the class references encoded into the class files by the
compiler. This is generally faster than parsing the Java source files. To learn more
about how this information is obtained from the class files, please refer to the Java
Virtual Machine Specification Since a class' dependencies only change when the class
itself changes, the depend task is able to cache dependency information. Only those
class files which have changed will have their dependency information re-analysed. Note
that if you change a class' dependencies by changing the source, it will be recompiled
anyway. You can examine the dependency files created to understand the dependencies of
your classes. Please do not rely, however, on the format of the information, as it may
change in a later release. Once depend discovers all of the class dependencies, it
"inverts" this relation to determine, for each class, which other classes are dependent
upon it. This "affects" list is used to discover which classes are invalidated by the
out of date class. The class files of the invalidated classes are removed, triggering
the compilation of the affected classes. The depend task supports an attribute, closure,
which controls whether depend will only consider direct class-class relationships or
whether it will also consider transitive, indirect relationships. For example, say there
are three classes, A, which depends on B, which in-turn depends on C. Now say that class
C is out of date. Without closure, only class B would be removed by depend. With closure
set, class A would also be removed. Normally direct relationships are sufficient-it is
unusual for a class to depend on another without having a direct relationship. With
closure set, you will notice that depend typically removes far more class files. The
classpath attribute for <depend> is optional. If it is present, depend will check class
dependencies against classes and jars on this classpath. Any classes which depend on an
element from this classpath and which are older than that element will be deleted. A
typical example where you would use this facility would be where you are building a
utility jar and want to make sure classes which are out of date with respect to this jar
are rebuilt. In this classpath, you should not include jars that you do not expect to
change, such as the JDK runtime jar or third party jars, since doing so will just slow
down the dependency check. This means that if you do use a classpath for the depend task
it may be different from the classpath necessary to actually compile your code.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `File` | This is a directory in which depend can store and retrieve dependency information. | No; defaults to no cache |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | The classpath containing jars and classes for which <depend> should also check dependencies | No |
| `:classpathref` | `Reference` |  |  |
| `:closure` | `boolean` | This attribute controls whether depend only removes classes which directly depend on out of date classes. If this is set to true, depend will traverse the class dependency graph deleting all affected classes. | No; defaults to false |
| `:defaultexcludes` | `boolean` |  |  |
| `:destdir` | `Path` | This is the root directory of the class files which will be analysed. | No; defaults to srcdir |
| `:dump` | `boolean` | If true the dependency information will be written to the debug level log | No; default is false |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:srcdir` | `Path` | This is the directory where the source exists. depend will examine this to determine which classes are out of date. If you use multiple source directories you can pass this attribute a path of source directories. | Yes |
| `:warnonrmistubs` | `boolean` | Flag to disable warnings about files that look like rmic generated stub/skeleton classes and have no .java source. Useful when doing RMI development. | No; default true |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/depend.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.depend.Depend`
sourceraw docstring

dependsclj

(depends & args)

Ant nested depends. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :extension (ExtensionAdapter)
  • :fileset (FileSet)
  • :libfileset (LibFileSet)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet

Ant nested depends. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:extension` (`ExtensionAdapter`)
- `:fileset` (`FileSet`)
- `:libfileset` (`LibFileSet`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet`
sourceraw docstring

dependsetclj

(dependset & args)

The dependset task compares a set of sources with a set of target files. If any of the sources has been modified more recently than any of the target files, all of the target files are removed. Sources and target files are specified via nested resource collections; sources can be resources of any type, while targets are restricted to files only. At least one set of sources and one set of targets is required. Use a FileSet when you want to use wildcard include or exclude patterns and don't care about missing files. Use a FileList when you want to consider the non-existence of a file as if it were out of date. If there are any non-existing files in any source or target FileList, all target files will be removed. DependSet is useful to capture dependencies that are not or cannot be determined algorithmically. For example, the <style> task only compares the source XML file and XSLT stylesheet against the target file to determined whether to restyle the source. Using dependset you can extend this dependency checking to include a DTD or XSD file as well as other stylesheets imported by the main stylesheet.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:excludesString
:excludesfileFile
:followsymlinksboolean
:includesString
:includesfileFile
:verbosebooleanMakes the task list all deleted targets files and the reason why they get deleted.No

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :sources (Union)
  • :srcfilelist (FileList)
  • :srcfileset (FileSet)
  • :targetfilelist (FileList)
  • :targetfileset (FileSet)
  • :targets (Path)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/dependset.html

Defined by

org.apache.tools.ant.taskdefs.DependSet

The dependset task compares a set of sources with a set of target files. If any of the
sources has been modified more recently than any of the target files, all of the target
files are removed. Sources and target files are specified via nested resource
collections; sources can be resources of any type, while targets are restricted to files
only. At least one set of sources and one set of targets is required. Use a FileSet when
you want to use wildcard include or exclude patterns and don't care about missing files.
Use a FileList when you want to consider the non-existence of a file as if it were out
of date. If there are any non-existing files in any source or target FileList, all
target files will be removed. DependSet is useful to capture dependencies that are not
or cannot be determined algorithmically. For example, the <style> task only compares the
source XML file and XSLT stylesheet against the target file to determined whether to
restyle the source. Using dependset you can extend this dependency checking to include a
DTD or XSD file as well as other stylesheets imported by the main stylesheet.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:verbose` | `boolean` | Makes the task list all deleted targets files and the reason why they get deleted. | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:sources` (`Union`)
- `:srcfilelist` (`FileList`)
- `:srcfileset` (`FileSet`)
- `:targetfilelist` (`FileList`)
- `:targetfileset` (`FileSet`)
- `:targets` (`Path`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/dependset.html

**Defined by**

`org.apache.tools.ant.taskdefs.DependSet`
sourceraw docstring

depthclj

(depth & args)

Ant nested depth. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:maxint
:minint
:refidReference

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.DepthSelector

Ant nested depth. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:max` | `int` |  |  |
| `:min` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.DepthSelector`
sourceraw docstring

descriptionclj

(description & args)

Allows for a description of the project to be specified that will be included in the output of the ant -projecthelp command.

Attributes

AttributeTypeDescriptionRequired
:refidReference

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/description.html

Defined by

org.apache.tools.ant.types.Description

Allows for a description of the project to be specified that will be included in the
output of the ant -projecthelp command.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/description.html

**Defined by**

`org.apache.tools.ant.types.Description`
sourceraw docstring

diagnosticsclj

(diagnostics & args)

Runs Apache Ant's -diagnostics code inside Ant itself. This is good for debugging Ant's configuration under an IDE.

Reference

https://ant.apache.org/manual/Tasks/diagnostics.html

Defined by

org.apache.tools.ant.taskdefs.DiagnosticsTask

Runs Apache Ant's -diagnostics code inside Ant itself. This is good for debugging Ant's
configuration under an IDE.

**Reference**

https://ant.apache.org/manual/Tasks/diagnostics.html

**Defined by**

`org.apache.tools.ant.taskdefs.DiagnosticsTask`
sourceraw docstring

differenceclj

(difference & args)

Ant type difference. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

https://ant.apache.org/manual/Types/difference.html

Defined by

org.apache.tools.ant.types.resources.Difference

Ant type difference. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/difference.html

**Defined by**

`org.apache.tools.ant.types.resources.Difference`
sourceraw docstring

differentclj

(different & args)

Ant nested different. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:granularityint
:ignorecontentsboolean
:ignorefiletimesboolean
:refidReference
:targetdirFile

Nested elements

  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.DifferentSelector

Ant nested different. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:granularity` | `int` |  |  |
| `:ignorecontents` | `boolean` |  |  |
| `:ignorefiletimes` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:targetdir` | `File` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.DifferentSelector`
sourceraw docstring

dirnameclj

(dirname & args)

Task to determine the directory path of a specified file. When this task executes, it will set the specified property to the value of the specified file (or directory) up to, but not including, the last path element. If the specified file is a path that ends in a filename, the filename will be dropped. If the specified file is just a filename, the directory will be the current directory. Note: This is not the same as the UNIX dirname command, which is defined as "strip non-directory suffix from filename". <dirname> determines the full directory path of the specified file.

Attributes

AttributeTypeDescriptionRequired
:fileFileThe path to take the dirname of.Yes
:propertyStringThe name of the property to set.Yes

Reference

https://ant.apache.org/manual/Tasks/dirname.html

Defined by

org.apache.tools.ant.taskdefs.Dirname

Task to determine the directory path of a specified file. When this task executes, it
will set the specified property to the value of the specified file (or directory) up to,
but not including, the last path element. If the specified file is a path that ends in a
filename, the filename will be dropped. If the specified file is just a filename, the
directory will be the current directory. Note: This is not the same as the UNIX dirname
command, which is defined as "strip non-directory suffix from filename". <dirname>
determines the full directory path of the specified file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | The path to take the dirname of. | Yes |
| `:property` | `String` | The name of the property to set. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/dirname.html

**Defined by**

`org.apache.tools.ant.taskdefs.Dirname`
sourceraw docstring

dirsetclj

(dirset & args)

A DirSet is a group of directories. These directories can be found in a directory tree starting in a base directory and are matched by patterns taken from a number of PatternSets and Selectors. PatternSets can be specified as nested <patternset> elements. In addition, DirSet holds an implicit PatternSet and supports the nested <include>, <includesfile>, <exclude> and <excludesfile> elements of <patternset> directly, as well as <patternset>'s attributes. Selectors are available as nested elements within the DirSet. If any of the selectors within the DirSet do not select the directory, it is not considered part of the DirSet. This makes a DirSet equivalent to an <and> selector container.

Attributes

AttributeTypeDescriptionRequired
:casesensitivebooleanSpecifies whether case-sensitivity should be applied (true, yes, on or false, no, off).No; defaults to true
:defaultexcludesboolean
:dirFileThe root of the directory tree of this DirSet.Yes
:erroronmissingdirbooleanSpecify what happens if the base directory does not exist. If true a build error will happen, if false, the dirset will be ignored/empty. Since Apache Ant 1.7.1No; defaults to true (for backward compatibility reasons)
:excludesStringComma- or space-separated list of patterns of directories that must be excluded.No; defaults to none
:excludesfileFileName of a file; each line of this file is taken to be an exclude pattern.No
:fileFile
:followsymlinksbooleanShall symbolic links and Windows junctions be followed? See fileset's documentation. Windows junctions are detected since Ant 1.10.16.No; defaults to true
:includesStringComma- or space-separated list of patterns of directories that must be included.No; defaults to all directories
:includesfileFileName of a file; each line of this file is taken to be an include pattern. Note: if the file is empty and there are no other patterns defined for the fileset, all directories will be included.No
:maxlevelsofsymlinksint
:refidReferenceMakes this dirset a reference to a dirset defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/dirset.html

Defined by

org.apache.tools.ant.types.DirSet

A DirSet is a group of directories. These directories can be found in a directory tree
starting in a base directory and are matched by patterns taken from a number of
PatternSets and Selectors. PatternSets can be specified as nested <patternset> elements.
In addition, DirSet holds an implicit PatternSet and supports the nested <include>,
<includesfile>, <exclude> and <excludesfile> elements of <patternset> directly, as well
as <patternset>'s attributes. Selectors are available as nested elements within the
DirSet. If any of the selectors within the DirSet do not select the directory, it is not
considered part of the DirSet. This makes a DirSet equivalent to an <and> selector
container.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` | Specifies whether case-sensitivity should be applied (true, yes, on or false, no, off). | No; defaults to true |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` | The root of the directory tree of this DirSet. | Yes |
| `:erroronmissingdir` | `boolean` | Specify what happens if the base directory does not exist. If true a build error will happen, if false, the dirset will be ignored/empty. Since Apache Ant 1.7.1 | No; defaults to true (for backward compatibility reasons) |
| `:excludes` | `String` | Comma- or space-separated list of patterns of directories that must be excluded. | No; defaults to none |
| `:excludesfile` | `File` | Name of a file; each line of this file is taken to be an exclude pattern. | No |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` | Shall symbolic links and Windows junctions be followed? See fileset's documentation. Windows junctions are detected since Ant 1.10.16. | No; defaults to true |
| `:includes` | `String` | Comma- or space-separated list of patterns of directories that must be included. | No; defaults to all directories |
| `:includesfile` | `File` | Name of a file; each line of this file is taken to be an include pattern. Note: if the file is empty and there are no other patterns defined for the fileset, all directories will be included. | No |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` | Makes this dirset a reference to a dirset defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/dirset.html

**Defined by**

`org.apache.tools.ant.types.DirSet`
sourceraw docstring

disableclj

(disable & args)

Ant nested disable. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classString
:packageString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Assertions$DisabledAssertion

Ant nested disable. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:class` | `String` |  |  |
| `:package` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Assertions$DisabledAssertion`
sourceraw docstring

dnameclj

(dname & args)

Ant nested dname. (No description bundled.)

Nested elements

  • :param (Object)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.GenerateKey$DistinguishedName

Ant nested dname. (No description bundled.)

**Nested elements**

- `:param` (`Object`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.GenerateKey$DistinguishedName`
sourceraw docstring

docletclj

(doclet & args)

Ant nested doclet. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:pathPath
:pathrefReference

Nested elements

  • :param (DocletParam)
  • :path (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$DocletInfo

Ant nested doclet. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |

**Nested elements**

- `:param` (`DocletParam`)
- `:path` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$DocletInfo`
sourceraw docstring

doctitleclj

(doctitle & args)

Ant nested doctitle. (No description bundled.)

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$Html

Ant nested doctitle. (No description bundled.)

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$Html`
sourceraw docstring

dtdclj

(dtd & args)

Ant nested dtd. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:baseURL
:publicidString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.types.ResourceLocation
  • org.apache.tools.ant.types.DTDLocation

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.EjbJar$DTDLocation

Ant nested dtd. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:base` | `URL` |  |  |
| `:publicid` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.types.ResourceLocation`
- `org.apache.tools.ant.types.DTDLocation`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.EjbJar$DTDLocation`
sourceraw docstring

earclj

(ear & args)

An extension of the Jar task with special treatment for files that should end up in an Enterprise Application archive. (The Ear task is a shortcut for specifying the particular layout of a EAR file. The same thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in a Zip or Jar task.) The extended zipfileset element from the Zip task (with attributes prefix, fullpath, and src) is available in the Ear task. Please note that the zip format allows multiple files of the same fully-qualified name to exist within a single archive. This has been documented as causing various problems for unsuspecting users. If you wish to avoid this behavior you must set the duplicate attribute to a value other than its default, add.

Attributes

AttributeTypeDescriptionRequired
:appxmlFileThe deployment descriptor to use (META-INF/application.xml).Yes, unless update is set to true
:basedirFilethe directory from which to jar the files.No
:casesensitiveboolean
:commentString
:compressbooleanNot only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating.No; defaults to true
:createunicodeextrafieldsUnicodeExtraFieldWhether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is never
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destfileFilethe EAR file to create.Yes
:duplicateDuplicatebehavior when a duplicate file is found. Valid values are add, preserve, and fail.No; default is add
:earfileFile
:encodingStringThe character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task pageNo; defaults to UTF8
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude pattern.No
:fallbacktoutf8booleanWhether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is false
:fileFile
:filesetmanifestFilesetManifestConfigbehavior when a manifest file is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests.No; defaults to skip
:filesonlybooleanStore only file entries.No; defaults to false
:flattenattributesbooleanWhether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0.No; default is false
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include pattern.No
:indexbooleanwhether to create an index list to speed up classloading. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index.No; defaults to false
:indexmetainfbooleanwhether to include META-INF and its children in the index. Doesn't have any effect if index is false. Oracle's jar implementation used to skip the META-INF directory and Ant followed that example. The behavior has been changed with Java 5. In order to avoid problems with Ant generated jars on Java 1.4 or earlier, Ant will not include META-INF unless explicitly asked to. Since Ant 1.8.0.No; defaults to false
:jarfileFile
:keepcompressionbooleanFor entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Apache Ant 1.6No; defaults to false
:levelintNon-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7No
:manifestFilethe manifest file to use.No
:manifestencodingStringThe encoding used to read the JAR manifest, when a manifest file is specified.No; defaults to default JVM character encoding
:mergeclasspathattributesbooleanWhether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification.No; default is false
:modificationtimeStringSet all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2.No
:preserve0permissionsbooleanwhen updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. Since Ant 1.8.0No; default is false
:roundupbooleanWhether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2No; defaults to true
:strictStrictMode
:updatebooleanindicates whether to update or overwrite the destination file if it already exists.No; default is false
:uselanguageencodingflagbooleanWhether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is true
:whenemptyWhenEmpty
:whenmanifestonlyWhenEmptybehavior when no files match. Valid values are fail, skip, and create.No; defaults to create
:zip64modeZip64ModeAttributeWhen to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task pageNo; default is never
:zipfileFile

Nested elements

  • :and (AndSelector)
  • :archives (ZipFileSet)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :indexjars (Path)
  • :indexjarsmapper (Mapper)
  • :majority (MajoritySelector)
  • :manifest (Manifest)
  • :metainf (ZipFileSet)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :service (Service)
  • :size (SizeSelector)
  • :type (TypeSelector)
  • :zipfileset (ZipFileSet)
  • :zipgroupfileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/ear.html

Defined by

org.apache.tools.ant.taskdefs.Ear

An extension of the Jar task with special treatment for files that should end up in an
Enterprise Application archive. (The Ear task is a shortcut for specifying the
particular layout of a EAR file. The same thing can be accomplished by using the prefix
and fullpath attributes of zipfilesets in a Zip or Jar task.) The extended zipfileset
element from the Zip task (with attributes prefix, fullpath, and src) is available in
the Ear task. Please note that the zip format allows multiple files of the same
fully-qualified name to exist within a single archive. This has been documented as
causing various problems for unsuspecting users. If you wish to avoid this behavior you
must set the duplicate attribute to a value other than its default, add.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:appxml` | `File` | The deployment descriptor to use (META-INF/application.xml). | Yes, unless update is set to true |
| `:basedir` | `File` | the directory from which to jar the files. | No |
| `:casesensitive` | `boolean` |  |  |
| `:comment` | `String` |  |  |
| `:compress` | `boolean` | Not only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating. | No; defaults to true |
| `:createunicodeextrafields` | `UnicodeExtraField` | Whether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is never |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destfile` | `File` | the EAR file to create. | Yes |
| `:duplicate` | `Duplicate` | behavior when a duplicate file is found. Valid values are add, preserve, and fail. | No; default is add |
| `:earfile` | `File` |  |  |
| `:encoding` | `String` | The character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task page | No; defaults to UTF8 |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern. | No |
| `:fallbacktoutf8` | `boolean` | Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is false |
| `:file` | `File` |  |  |
| `:filesetmanifest` | `FilesetManifestConfig` | behavior when a manifest file is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests. | No; defaults to skip |
| `:filesonly` | `boolean` | Store only file entries. | No; defaults to false |
| `:flattenattributes` | `boolean` | Whether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0. | No; default is false |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern. | No |
| `:index` | `boolean` | whether to create an index list to speed up classloading. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index. | No; defaults to false |
| `:indexmetainf` | `boolean` | whether to include META-INF and its children in the index. Doesn't have any effect if index is false. Oracle's jar implementation used to skip the META-INF directory and Ant followed that example. The behavior has been changed with Java 5. In order to avoid problems with Ant generated jars on Java 1.4 or earlier, Ant will not include META-INF unless explicitly asked to. Since Ant 1.8.0. | No; defaults to false |
| `:jarfile` | `File` |  |  |
| `:keepcompression` | `boolean` | For entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Apache Ant 1.6 | No; defaults to false |
| `:level` | `int` | Non-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7 | No |
| `:manifest` | `File` | the manifest file to use. | No |
| `:manifestencoding` | `String` | The encoding used to read the JAR manifest, when a manifest file is specified. | No; defaults to default JVM character encoding |
| `:mergeclasspathattributes` | `boolean` | Whether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification. | No; default is false |
| `:modificationtime` | `String` | Set all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2. | No |
| `:preserve0permissions` | `boolean` | when updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. Since Ant 1.8.0 | No; default is false |
| `:roundup` | `boolean` | Whether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2 | No; defaults to true |
| `:strict` | `StrictMode` |  |  |
| `:update` | `boolean` | indicates whether to update or overwrite the destination file if it already exists. | No; default is false |
| `:uselanguageencodingflag` | `boolean` | Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is true |
| `:whenempty` | `WhenEmpty` |  |  |
| `:whenmanifestonly` | `WhenEmpty` | behavior when no files match. Valid values are fail, skip, and create. | No; defaults to create |
| `:zip64mode` | `Zip64ModeAttribute` | When to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task page | No; default is never |
| `:zipfile` | `File` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:archives` (`ZipFileSet`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:indexjars` (`Path`)
- `:indexjarsmapper` (`Mapper`)
- `:majority` (`MajoritySelector`)
- `:manifest` (`Manifest`)
- `:metainf` (`ZipFileSet`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:service` (`Service`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)
- `:zipfileset` (`ZipFileSet`)
- `:zipgroupfileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/ear.html

**Defined by**

`org.apache.tools.ant.taskdefs.Ear`
sourceraw docstring

echoclj

(echo & args)

Echoes a message to the current loggers and listeners which means System.out unless overridden. A level can be specified, which controls at what logging level the message is filtered at. The task can also echo to a file, in which case the option to append rather than overwrite the file is available, and the level option is ignored

Attributes

AttributeTypeDescriptionRequired
:appendbooleanAppend to an existing file (or open a new file / overwrite an existing file)?No; ignored unless output indicates a filesystem destination, default is false
:encodingStringencoding to use. since Ant 1.7No; defaults to default JVM character encoding
:fileFilethe file to write the message to.No; only one of these may be used
:forcebooleanOverwrite read-only destination files. since Ant 1.8.2No; defaults to false
:levelEchoLevelControl the level at which this message is reported. One of error, warning, info, verbose, debug (decreasing order)No; default is warning
:messageStringthe message to echo.No; defaults to a blank line unless text is included in a character section within this element
:outputResourcethe Resource to write the message to (see note). Since Apache Ant 1.8No; only one of these may be used

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/echo.html

Defined by

org.apache.tools.ant.taskdefs.Echo

Echoes a message to the current loggers and listeners which means System.out unless
overridden. A level can be specified, which controls at what logging level the message
is filtered at. The task can also echo to a file, in which case the option to append
rather than overwrite the file is available, and the level option is ignored

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Append to an existing file (or open a new file / overwrite an existing file)? | No; ignored unless output indicates a filesystem destination, default is false |
| `:encoding` | `String` | encoding to use. since Ant 1.7 | No; defaults to default JVM character encoding |
| `:file` | `File` | the file to write the message to. | No; only one of these may be used |
| `:force` | `boolean` | Overwrite read-only destination files. since Ant 1.8.2 | No; defaults to false |
| `:level` | `EchoLevel` | Control the level at which this message is reported. One of error, warning, info, verbose, debug (decreasing order) | No; default is warning |
| `:message` | `String` | the message to echo. | No; defaults to a blank line unless text is included in a character section within this element |
| `:output` | `Resource` | the Resource to write the message to (see note). Since Apache Ant 1.8 | No; only one of these may be used |

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/echo.html

**Defined by**

`org.apache.tools.ant.taskdefs.Echo`
sourceraw docstring

echopropertiesclj

(echoproperties & args)

Displays all the current properties (or a subset of them specified by a nested <propertyset>) in the project. The output can be sent to a file if desired. This task can be used as a somewhat contrived means of returning data from an ant invocation, but is really for debugging build files.

Attributes

AttributeTypeDescriptionRequired
:destfileFileIf specified, the value indicates the name of the file to send the output of the statement to. The generated output file is compatible for loading by any Java application as a property file.No; by default, output to the log
:failonerrorbooleanIf an error occurs while writing the properties to a file, and this attribute is enabled, then a BuildException will be thrown, causing the build to fail. If disabled, then IO errors will be reported as a log statement, and the build will continue without failure from this task.No; default is true
:formatFormatAttributeOne of text or xml. Determines the output format.No; defaults to text
:prefixStringa prefix which is used to filter the properties: only properties whose names start with this prefix will be echoed.No
:regexStringa regular expression which is used to filter the properties: only those properties whose names match it will be echoed.No
:srcfileFile

Nested elements

  • :propertyset (PropertySet)

Reference

https://ant.apache.org/manual/Tasks/echoproperties.html

Defined by

org.apache.tools.ant.taskdefs.optional.EchoProperties

Displays all the current properties (or a subset of them specified by a nested
<propertyset>) in the project. The output can be sent to a file if desired. This task
can be used as a somewhat contrived means of returning data from an ant invocation, but
is really for debugging build files.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:destfile` | `File` | If specified, the value indicates the name of the file to send the output of the statement to. The generated output file is compatible for loading by any Java application as a property file. | No; by default, output to the log |
| `:failonerror` | `boolean` | If an error occurs while writing the properties to a file, and this attribute is enabled, then a BuildException will be thrown, causing the build to fail. If disabled, then IO errors will be reported as a log statement, and the build will continue without failure from this task. | No; default is true |
| `:format` | `FormatAttribute` | One of text or xml. Determines the output format. | No; defaults to text |
| `:prefix` | `String` | a prefix which is used to filter the properties: only properties whose names start with this prefix will be echoed. | No |
| `:regex` | `String` | a regular expression which is used to filter the properties: only those properties whose names match it will be echoed. | No |
| `:srcfile` | `File` |  |  |

**Nested elements**

- `:propertyset` (`PropertySet`)

**Reference**

https://ant.apache.org/manual/Tasks/echoproperties.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.EchoProperties`
sourceraw docstring

echoxmlclj

(echoxml & args)

Echo nested XML to the console or a file.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanWhether to append file, if specified.No; default is false
:fileFileThe file to receive the XML.No; by default nested XML is echoed to the log
:namespacepolicyNamespacePolicySets the namespace policy as defined by org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy. Valid values are ignore, elementsOnly, or all. Since Apache Ant 1.8No; default ignore

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/echoxml.html

Defined by

org.apache.tools.ant.taskdefs.EchoXML

Echo nested XML to the console or a file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Whether to append file, if specified. | No; default is false |
| `:file` | `File` | The file to receive the XML. | No; by default nested XML is echoed to the log |
| `:namespacepolicy` | `NamespacePolicy` | Sets the namespace policy as defined by org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy. Valid values are ignore, elementsOnly, or all. Since Apache Ant 1.8 | No; default ignore |

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/echoxml.html

**Defined by**

`org.apache.tools.ant.taskdefs.EchoXML`
sourceraw docstring

ejbjarclj

(ejbjar & args)

This task is designed to support building of EJB jar files (EJB 1.1 & 2.0). Support is currently provided for 'vanilla' EJB jar files-i.e. those containing only the user generated class files and the standard deployment descriptor. Nested elements provide support for vendor specific deployment tools. These currently include: Borland Application Server 4.5 iPlanet Application Server 6.0 JBoss 2.1 and above WebLogic 5.1/6.0 session/entity beans using the weblogic.ejbc tool IBM WebSphere 4.0 TOPLink for WebLogic 2.5.1-enabled entity beans JOnAS 2.4.x and 2.5 Open Source EJB server IronFlare Orion Application Server 2.0 The task works as a directory scanning task, and performs an action for each deployment descriptor found. As such the includes and excludes should be set to ensure that all desired EJB descriptors are found, but no application server descriptors are found. For each descriptor found, ejbjar will parse the deployment descriptor to determine the necessary class files which implement the bean. These files are assembled along with the deployment descriptors into a well formed EJB jar file. Any support files which need to be included in the generated jar can be added with the <support> nested element. For each class included in the jar, ejbjar will scan for any super classes or super interfaces. These will be added to the generated jar. If no nested vendor-specific deployment elements are present, the task will simply generate a generic EJB jar. Such jars are typically used as the input to vendor-specific deployment tools. For each nested deployment element, a vendor specific deployment tool is run to generate a jar file ready for deployment in that vendor's EJB container. The jar files are only built if they are out of date. Each deployment tool element will examine its target jar file and determine if it is out of date with respect to the class files and deployment descriptors that make up the bean. If any of these files are newer than the jar file the jar will be rebuilt otherwise a message is logged that the jar file is up to date. The task uses the BCEL library to extract all dependent classes. This means that, in addition to the classes that are mentioned in the deployment descriptor, any classes that these depend on are also automatically included in the jar file.

Attributes

AttributeTypeDescriptionRequired
:basejarnameStringThe base name that is used for the generated jar files. If this attribute is specified, the generic jar file name will use this value as the prefix (followed by the value specified in the genericjarsuffix attribute) and the resultant EJB jar file (followed by any suffix specified in the nested element).No
:basenameterminatorStringString value used to substring out a string from the name of each deployment descriptor found, which is then used to locate related deployment descriptors (e.g. the WebLogic descriptors). For example, a basename of. and a deployment descriptor called FooBean.ejb-jar.xml would result in a basename of FooBean which would then be used to find FooBean.weblogic-ejb-jar.xml and FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create the filenames of the jar files as FooBean-generic.jar and FooBean-wl.jar. This attribute is not used if the basejarname attribute is specified.No; defaults to -
:casesensitiveboolean
:classpathPathThis classpath is used when resolving classes which are to be added to the jar. Typically nested deployment tool elements will also support a classpath which will be combined with this classpath when resolving classesNo
:cmpversionCMPVersionEither 1.0 or 2.0. A CMP 2.0 implementation exists currently only for JBoss.No; default is 1.0
:defaultexcludesboolean
:dependencyStringThis attribute controls which additional classes and interfaces are added to the jar. Please refer to the description aboveNo
:descriptordirFileThe base directory under which to scan for EJB deployment descriptors. If this attribute is not specified, then the deployment descriptors must be located in the directory specified by the srcdir attribute.No
:destdirFileThe base directory into which generated jar files are deposited. Jar files are deposited in directories corresponding to their location within the descriptordir namespace. Note that this attribute is only used if the task is generating generic jars (i.e. no vendor-specific deployment elements have been specified).Yes, unless vendor-specific deployment elements have been specified.
:excludesString
:excludesfileFile
:flatdestdirbooleanSet this attribute to true if you want all generated jars to be placed in the root of the destdir, rather than according to the location of the deployment descriptor within the descriptordir hierarchy.No
:followsymlinksboolean
:genericjarsuffixStringString value appended to the basename of the deployment descriptor to create the filename of the generic EJB jar file.No; defaults to -generic.jar
:includesString
:includesfileFile
:manifestFilethe manifest file to use, if any.No
:namingNamingSchemeControls the naming convention used to name generated EJB jars. Please refer to the description above.No
:srcdirFileThe base directory containing the .class files that make up the bean. Included are the home-, remote-, pk- and implementation- classes and all classes that these depend on. Note that this can be the same as the descriptordir if all files are in the same directory tree.Yes

Nested elements

  • :and (AndSelector)
  • :borland (BorlandDeploymentTool)
  • :classpath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :dtd (DTDLocation)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :iplanet (IPlanetDeploymentTool)
  • :jboss (JbossDeploymentTool)
  • :jonas (JonasDeploymentTool)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :orion (OrionDeploymentTool)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :support (FileSet)
  • :type (TypeSelector)
  • :weblogic (WeblogicDeploymentTool)
  • :weblogictoplink (WeblogicTOPLinkDeploymentTool)
  • :websphere (WebsphereDeploymentTool)

Reference

https://ant.apache.org/manual/Tasks/ejb.html#ejbjar

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.EjbJar

This task is designed to support building of EJB jar files (EJB 1.1 & 2.0). Support is
currently provided for 'vanilla' EJB jar files-i.e. those containing only the user
generated class files and the standard deployment descriptor. Nested elements provide
support for vendor specific deployment tools. These currently include: Borland
Application Server 4.5 iPlanet Application Server 6.0 JBoss 2.1 and above WebLogic
5.1/6.0 session/entity beans using the weblogic.ejbc tool IBM WebSphere 4.0 TOPLink for
WebLogic 2.5.1-enabled entity beans JOnAS 2.4.x and 2.5 Open Source EJB server IronFlare
Orion Application Server 2.0 The task works as a directory scanning task, and performs
an action for each deployment descriptor found. As such the includes and excludes should
be set to ensure that all desired EJB descriptors are found, but no application server
descriptors are found. For each descriptor found, ejbjar will parse the deployment
descriptor to determine the necessary class files which implement the bean. These files
are assembled along with the deployment descriptors into a well formed EJB jar file. Any
support files which need to be included in the generated jar can be added with the
<support> nested element. For each class included in the jar, ejbjar will scan for any
super classes or super interfaces. These will be added to the generated jar. If no
nested vendor-specific deployment elements are present, the task will simply generate a
generic EJB jar. Such jars are typically used as the input to vendor-specific deployment
tools. For each nested deployment element, a vendor specific deployment tool is run to
generate a jar file ready for deployment in that vendor's EJB container. The jar files
are only built if they are out of date. Each deployment tool element will examine its
target jar file and determine if it is out of date with respect to the class files and
deployment descriptors that make up the bean. If any of these files are newer than the
jar file the jar will be rebuilt otherwise a message is logged that the jar file is up
to date. The task uses the BCEL library to extract all dependent classes. This means
that, in addition to the classes that are mentioned in the deployment descriptor, any
classes that these depend on are also automatically included in the jar file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basejarname` | `String` | The base name that is used for the generated jar files. If this attribute is specified, the generic jar file name will use this value as the prefix (followed by the value specified in the genericjarsuffix attribute) and the resultant EJB jar file (followed by any suffix specified in the nested element). | No |
| `:basenameterminator` | `String` | String value used to substring out a string from the name of each deployment descriptor found, which is then used to locate related deployment descriptors (e.g. the WebLogic descriptors). For example, a basename of. and a deployment descriptor called FooBean.ejb-jar.xml would result in a basename of FooBean which would then be used to find FooBean.weblogic-ejb-jar.xml and FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create the filenames of the jar files as FooBean-generic.jar and FooBean-wl.jar. This attribute is not used if the basejarname attribute is specified. | No; defaults to - |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | This classpath is used when resolving classes which are to be added to the jar. Typically nested deployment tool elements will also support a classpath which will be combined with this classpath when resolving classes | No |
| `:cmpversion` | `CMPVersion` | Either 1.0 or 2.0. A CMP 2.0 implementation exists currently only for JBoss. | No; default is 1.0 |
| `:defaultexcludes` | `boolean` |  |  |
| `:dependency` | `String` | This attribute controls which additional classes and interfaces are added to the jar. Please refer to the description above | No |
| `:descriptordir` | `File` | The base directory under which to scan for EJB deployment descriptors. If this attribute is not specified, then the deployment descriptors must be located in the directory specified by the srcdir attribute. | No |
| `:destdir` | `File` | The base directory into which generated jar files are deposited. Jar files are deposited in directories corresponding to their location within the descriptordir namespace. Note that this attribute is only used if the task is generating generic jars (i.e. no vendor-specific deployment elements have been specified). | Yes, unless vendor-specific deployment elements have been specified. |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:flatdestdir` | `boolean` | Set this attribute to true if you want all generated jars to be placed in the root of the destdir, rather than according to the location of the deployment descriptor within the descriptordir hierarchy. | No |
| `:followsymlinks` | `boolean` |  |  |
| `:genericjarsuffix` | `String` | String value appended to the basename of the deployment descriptor to create the filename of the generic EJB jar file. | No; defaults to -generic.jar |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:manifest` | `File` | the manifest file to use, if any. | No |
| `:naming` | `NamingScheme` | Controls the naming convention used to name generated EJB jars. Please refer to the description above. | No |
| `:srcdir` | `File` | The base directory containing the .class files that make up the bean. Included are the home-, remote-, pk- and implementation- classes and all classes that these depend on. Note that this can be the same as the descriptordir if all files are in the same directory tree. | Yes |

**Nested elements**

- `:and` (`AndSelector`)
- `:borland` (`BorlandDeploymentTool`)
- `:classpath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:dtd` (`DTDLocation`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:iplanet` (`IPlanetDeploymentTool`)
- `:jboss` (`JbossDeploymentTool`)
- `:jonas` (`JonasDeploymentTool`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:orion` (`OrionDeploymentTool`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:support` (`FileSet`)
- `:type` (`TypeSelector`)
- `:weblogic` (`WeblogicDeploymentTool`)
- `:weblogictoplink` (`WeblogicTOPLinkDeploymentTool`)
- `:websphere` (`WebsphereDeploymentTool`)

**Reference**

https://ant.apache.org/manual/Tasks/ejb.html#ejbjar

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.EjbJar`
sourceraw docstring

elementclj

(element & args)

Ant nested element. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:implicitboolean
:nameString
:optionalboolean

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.optional.script.ScriptDef$NestedElement

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.MacroDef$TemplateElement

Ant nested element. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:implicit` | `boolean` |  |  |
| `:name` | `String` |  |  |
| `:optional` | `boolean` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.optional.script.ScriptDef$NestedElement`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.MacroDef$TemplateElement`
sourceraw docstring

enableclj

(enable & args)

Ant nested enable. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classString
:packageString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Assertions$EnabledAssertion

Ant nested enable. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:class` | `String` |  |  |
| `:package` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Assertions$EnabledAssertion`
sourceraw docstring

entityclj

(entity & args)

Ant nested entity. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:baseURL
:publicidString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ResourceLocation

Ant nested entity. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:base` | `URL` |  |  |
| `:publicid` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ResourceLocation`
sourceraw docstring

entryclj

(entry & args)

Ant nested entry. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:defaultString
:keyString
:operationOperation
:patternString
:typeType
:unitUnit
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.PropertyFile$Entry

Ant nested entry. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:default` | `String` |  |  |
| `:key` | `String` |  |  |
| `:operation` | `Operation` |  |  |
| `:pattern` | `String` |  |  |
| `:type` | `Type` |  |  |
| `:unit` | `Unit` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.PropertyFile$Entry`
sourceraw docstring

envclj

(env & args)

Ant nested env. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:keyString
:pathPath
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Environment$Variable

Ant nested env. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:key` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Environment$Variable`
sourceraw docstring

equalsclj

(equals & args)

Ant nested equals. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:arg1Object
:arg2Object
:casesensitiveboolean
:forcestringboolean
:trimboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.Equals

Ant nested equals. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:arg1` | `Object` |  |  |
| `:arg2` | `Object` |  |  |
| `:casesensitive` | `boolean` |  |  |
| `:forcestring` | `boolean` |  |  |
| `:trim` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.Equals`
sourceraw docstring

errorfilterchainclj

(errorfilterchain & args)

Ant nested errorfilterchain. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :classconstants (ClassConstants)
  • :containsregex (ContainsRegex)
  • :deletecharacters (DeleteCharacters)
  • :escapeunicode (EscapeUnicode)
  • :expandproperties (ExpandProperties)
  • :filterreader (AntFilterReader)
  • :headfilter (HeadFilter)
  • :ignoreblank (IgnoreBlank)
  • :linecontains (LineContains)
  • :linecontainsregexp (LineContainsRegExp)
  • :prefixlines (PrefixLines)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :replacetokens (ReplaceTokens)
  • :stripjavacomments (StripJavaComments)
  • :striplinebreaks (StripLineBreaks)
  • :striplinecomments (StripLineComments)
  • :suffixlines (SuffixLines)
  • :tabstospaces (TabsToSpaces)
  • :tailfilter (TailFilter)
  • :tokenfilter (TokenFilter)
  • :trim (Trim)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FilterChain

Ant nested errorfilterchain. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classconstants` (`ClassConstants`)
- `:containsregex` (`ContainsRegex`)
- `:deletecharacters` (`DeleteCharacters`)
- `:escapeunicode` (`EscapeUnicode`)
- `:expandproperties` (`ExpandProperties`)
- `:filterreader` (`AntFilterReader`)
- `:headfilter` (`HeadFilter`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linecontains` (`LineContains`)
- `:linecontainsregexp` (`LineContainsRegExp`)
- `:prefixlines` (`PrefixLines`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:replacetokens` (`ReplaceTokens`)
- `:stripjavacomments` (`StripJavaComments`)
- `:striplinebreaks` (`StripLineBreaks`)
- `:striplinecomments` (`StripLineComments`)
- `:suffixlines` (`SuffixLines`)
- `:tabstospaces` (`TabsToSpaces`)
- `:tailfilter` (`TailFilter`)
- `:tokenfilter` (`TokenFilter`)
- `:trim` (`Trim`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FilterChain`
sourceraw docstring

errormapperclj

(errormapper & args)

Ant nested errormapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:fromString
:refidReference
:toString
:typeMapperType

Nested elements

  • :classpath (Path)
  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Mapper

Ant nested errormapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:from` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:to` | `String` |  |  |
| `:type` | `MapperType` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Mapper`
sourceraw docstring

escapeunicodeclj

(escapeunicode & args)

Ant nested escapeunicode. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.EscapeUnicode

Ant nested escapeunicode. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.EscapeUnicode`
sourceraw docstring

excludeclj

(exclude & args)

Ant nested exclude. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:ifObject
:nameString
:unlessObject

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PatternSet$NameEntry

Ant nested exclude. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:if` | `Object` |  |  |
| `:name` | `String` |  |  |
| `:unless` | `Object` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PatternSet$NameEntry`
sourceraw docstring

excludefilesclj

(excludefiles & args)

Ant nested excludefiles. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:listfileFile
:patternString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry

Ant nested excludefiles. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:listfile` | `File` |  |  |
| `:pattern` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry`
sourceraw docstring

excludepackageclj

(excludepackage & args)

Ant nested excludepackage. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$PackageName

Ant nested excludepackage. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$PackageName`
sourceraw docstring

excluderesourcesclj

(excluderesources & args)

Ant nested excluderesources. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:listfileFile
:patternString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry

Ant nested excluderesources. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:listfile` | `File` |  |  |
| `:pattern` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry`
sourceraw docstring

excludesfileclj

(excludesfile & args)

Ant nested excludesfile. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:ifObject
:nameString
:unlessObject

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PatternSet$NameEntry

Ant nested excludesfile. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:if` | `Object` |  |  |
| `:name` | `String` |  |  |
| `:unless` | `Object` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PatternSet$NameEntry`
sourceraw docstring

execclj

(exec & args)

Executes a system command. When the os attribute is specified, then the command is only executed when Apache Ant is run on one of the specified operating systems. Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes. Also note that since Ant 1.6, any attempt to read input in the forked program will receive an EOF (-1). This is a change from Ant 1.5, where such an attempt would block. If you want to execute an executable using a path relative to the project's basedir, you may need to use vmlauncher=false on some operating systems-but even this may fail (Solaris 8/9 has been reported as problematic). The resolveexecutable attribute should be more reliable, as would be something like <property name="executable-full-path" location="../relative/path/to/executable"/> <exec executable="${executable-full-path}" ... Windows Users The <exec> task delegates to Runtime.exec which in turn apparently calls::CreateProcess. It is the latter Win32 function that defines the exact semantics of the call. In particular, if you do not put a file extension on the executable, only .EXE files are looked for, not .COM, .CMD or other file types listed in the environment variable PATHEXT. That is only used by the shell. Note that .bat files cannot in general by executed directly. One normally needs to execute the command shell executable cmd using the /c switch. <target name="help"> <exec executable="cmd"> <arg value="/c"/> <arg value="ant.bat"/> <arg value="-p"/> </exec> </target> A common problem is not having the executable on the PATH. In case you get an error message Cannot run program "...":CreateProcess error=2. The system cannot find the path specified. have a look at your PATH variable. Just type the command directly on the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program, add the directory of the program to the PATH (set PATH=%PATH%;dirOfProgram) or specify the absolute path in the executable attribute in your buildfile. Cygwin Users The <exec> task will not understand paths such as /bin/sh for the executable parameter. This is because JVM in which Ant is running is a standard Windows executable and is not aware of the Cygwin environment (i.e., doesn't load cygwin1.dll). The only work-around for this is to compile a JVM under Cygwin (at your own risk). See for instance OpenJDK build instructions for cygwin. OpenVMS Users The command specified using executable and <arg> elements is executed exactly as specified inside a temporary DCL script. This has some implications: the DCL script will be created inside the temporary directory. paths have to be written in VMS style if your executable points to a DCL script remember to prefix it with an @-sign (e.g. executable=@[FOO]BAR.COM), just as you would in a DCL script Please note that JVM provided by HP doesn't follow OpenVMS' conventions of exit codes. If you run a JVM with this task, the task may falsely claim that an error occurred (or silently ignore an error). Don't use this task to run JAVA.EXE, use a <java> task with the fork attribute set to true instead as this task will follow the JVM's interpretation of exit codes. RedHat S/390 Users It has been reported on linux-390 that shell scripts invoked via the Ant Exec task must have their interpreter specified, i.e., the scripts must start with something like: #!/bin/bash or the task will fail as follows: [exec] Warning: UNIXProcess.forkAndExec native error: Exec format error [exec] Result: 255 Running Ant as a background process on Unix(-like) systems If you run Ant as a background process (like ant &) and use the <exec> task with spawn set to false, you must provide explicit input to the forked process or Ant will be suspended because it tries to read from the standard input.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanWhether output and error files should be appended to or overwritten.No; defaults to false
:commandCommandlinethe command to execute with all command line arguments. Deprecated, use executable and nested <arg> elements instead.Exactly one of the two
:dirFilethe directory in which the command should be executed.No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir
:discarderrorbooleanWhether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10No; defaults to false
:discardoutputbooleanWhether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10No; defaults to false
:errorFileThe file to which the standard error of the command should be redirected. since Ant 1.6No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored. since Ant 1.6No
:executableStringthe command to execute without any command line arguments.Exactly one of the two
:failifexecutionfailsbooleanStop the build if we can't start the program.No; defaults to true
:failonerrorbooleanStop the build process if the command exits with a return code signaling failure.No; defaults to false
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6No
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6No
:logerrorbooleanThis attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6No
:newenvironmentbooleanDo not propagate old environment when new environment variables are specified.No; default is false
:osStringlist of Operating Systems on which the command may be executed. If the current OS's name is contained in this list, the command will be executed. The OS's name is determined by JVM and is set in the os.name system property.No
:osfamilyStringOS family as used in the <os> condition. since Ant 1.7No
:outputFileName of a file to which to write the output. If the error stream is not also redirected to a file or property, it will appear in this output.No
:outputpropertyStringThe name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output.No
:resolveexecutablebooleanWhen this attribute is true, the name of the executable is resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6No; default is false
:resultpropertyStringthe name of a property in which the return code of the command should be stored. Only of interest if failonerror=false.No
:searchpathbooleanWhen this attribute is true, then system path environment variables will be searched when resolving the location of the executable. since Ant 1.6.3No; default is false
:spawnbooleanwhether or not you want the command to be spawned If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6No; default is false
:timeoutIntegerStop the command if it doesn't finish within the specified time (given in milliseconds).No
:vmlauncherbooleanRun command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well.No; default is true

Nested elements

  • :arg (Argument)
  • :env (Variable)
  • :redirector (RedirectorElement)

Reference

https://ant.apache.org/manual/Tasks/exec.html

Defined by

org.apache.tools.ant.taskdefs.ExecTask

Executes a system command. When the os attribute is specified, then the command is only
executed when Apache Ant is run on one of the specified operating systems. Note that you
cannot interact with the forked program, the only way to send input to it is via the
input and inputstring attributes. Also note that since Ant 1.6, any attempt to read
input in the forked program will receive an EOF (-1). This is a change from Ant 1.5,
where such an attempt would block. If you want to execute an executable using a path
relative to the project's basedir, you may need to use vmlauncher=false on some
operating systems-but even this may fail (Solaris 8/9 has been reported as problematic).
The resolveexecutable attribute should be more reliable, as would be something like
<property name="executable-full-path" location="../relative/path/to/executable"/> <exec
executable="${executable-full-path}" ... Windows Users The <exec> task delegates to
Runtime.exec which in turn apparently calls::CreateProcess. It is the latter Win32
function that defines the exact semantics of the call. In particular, if you do not put
a file extension on the executable, only .EXE files are looked for, not .COM, .CMD or
other file types listed in the environment variable PATHEXT. That is only used by the
shell. Note that .bat files cannot in general by executed directly. One normally needs
to execute the command shell executable cmd using the /c switch. <target name="help">
<exec executable="cmd"> <arg value="/c"/> <arg value="ant.bat"/> <arg value="-p"/>
</exec> </target> A common problem is not having the executable on the PATH. In case you
get an error message Cannot run program "...":CreateProcess error=2. The system cannot
find the path specified. have a look at your PATH variable. Just type the command
directly on the command line and if Windows finds it, Ant should do it too. (Otherwise
ask on the user mailinglist for help.) If Windows can not execute the program, add the
directory of the program to the PATH (set PATH=%PATH%;dirOfProgram) or specify the
absolute path in the executable attribute in your buildfile. Cygwin Users The <exec>
task will not understand paths such as /bin/sh for the executable parameter. This is
because JVM in which Ant is running is a standard Windows executable and is not aware of
the Cygwin environment (i.e., doesn't load cygwin1.dll). The only work-around for this
is to compile a JVM under Cygwin (at your own risk). See for instance OpenJDK build
instructions for cygwin. OpenVMS Users The command specified using executable and <arg>
elements is executed exactly as specified inside a temporary DCL script. This has some
implications: the DCL script will be created inside the temporary directory. paths have
to be written in VMS style if your executable points to a DCL script remember to prefix
it with an @-sign (e.g. executable=@[FOO]BAR.COM), just as you would in a DCL script
Please note that JVM provided by HP doesn't follow OpenVMS' conventions of exit codes.
If you run a JVM with this task, the task may falsely claim that an error occurred (or
silently ignore an error). Don't use this task to run JAVA.EXE, use a <java> task with
the fork attribute set to true instead as this task will follow the JVM's interpretation
of exit codes. RedHat S/390 Users It has been reported on linux-390 that shell scripts
invoked via the Ant Exec task must have their interpreter specified, i.e., the scripts
must start with something like: #!/bin/bash or the task will fail as follows: [exec]
Warning: UNIXProcess.forkAndExec native error: Exec format error [exec] Result: 255
Running Ant as a background process on Unix(-like) systems If you run Ant as a
background process (like ant &) and use the <exec> task with spawn set to false, you
must provide explicit input to the forked process or Ant will be suspended because it
tries to read from the standard input.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Whether output and error files should be appended to or overwritten. | No; defaults to false |
| `:command` | `Commandline` | the command to execute with all command line arguments. Deprecated, use executable and nested <arg> elements instead. | Exactly one of the two |
| `:dir` | `File` | the directory in which the command should be executed. | No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir |
| `:discarderror` | `boolean` | Whether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10 | No; defaults to false |
| `:discardoutput` | `boolean` | Whether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10 | No; defaults to false |
| `:error` | `File` | The file to which the standard error of the command should be redirected. since Ant 1.6 | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. since Ant 1.6 | No |
| `:executable` | `String` | the command to execute without any command line arguments. | Exactly one of the two |
| `:failifexecutionfails` | `boolean` | Stop the build if we can't start the program. | No; defaults to true |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code signaling failure. | No; defaults to false |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6 | No |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6 | No |
| `:logerror` | `boolean` | This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6 | No |
| `:newenvironment` | `boolean` | Do not propagate old environment when new environment variables are specified. | No; default is false |
| `:os` | `String` | list of Operating Systems on which the command may be executed. If the current OS's name is contained in this list, the command will be executed. The OS's name is determined by JVM and is set in the os.name system property. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. since Ant 1.7 | No |
| `:output` | `File` | Name of a file to which to write the output. If the error stream is not also redirected to a file or property, it will appear in this output. | No |
| `:outputproperty` | `String` | The name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. | No |
| `:resolveexecutable` | `boolean` | When this attribute is true, the name of the executable is resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6 | No; default is false |
| `:resultproperty` | `String` | the name of a property in which the return code of the command should be stored. Only of interest if failonerror=false. | No |
| `:searchpath` | `boolean` | When this attribute is true, then system path environment variables will be searched when resolving the location of the executable. since Ant 1.6.3 | No; default is false |
| `:spawn` | `boolean` | whether or not you want the command to be spawned If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6 | No; default is false |
| `:timeout` | `Integer` | Stop the command if it doesn't finish within the specified time (given in milliseconds). | No |
| `:vmlauncher` | `boolean` | Run command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well. | No; default is true |

**Nested elements**

- `:arg` (`Argument`)
- `:env` (`Variable`)
- `:redirector` (`RedirectorElement`)

**Reference**

https://ant.apache.org/manual/Tasks/exec.html

**Defined by**

`org.apache.tools.ant.taskdefs.ExecTask`
sourceraw docstring

execonclj

(execon & args)

Executes a system command. When the os attribute is specified, then the command is only executed when Apache Ant is run on one of the specified operating systems. The files and/or directories of a number of Resource Collections -- including but not restricted to FileSets, DirSets (since Ant 1.6) or FileLists (since Ant 1.6) -- are passed as arguments to the system command. If you specify a nested mapper, the timestamp of each source file is compared to the timestamp of a target file which is defined by the nested mapper element and searched for in the given dest, if specified. At least one fileset or filelist is required, and you must not specify more than one mapper. Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes. Running Ant as a background process on Unix(-like) systems If you run Ant as a background process (like ant &) and use the <apply> task with spawn set to false, you must provide explicit input to the forked process or Ant will be suspended because it tries to read from the standard input.

Attributes

AttributeTypeDescriptionRequired
:addsourcefilebooleanWhether source file names should be added to the command automatically. Since Ant 1.6.No; default is true
:appendbooleanwhether output should be appended to or overwrite an existing file. If you set parallel to false, you will probably want to set this one to true.No; default is false
:commandCommandline
:destFilethe directory where the command is expected to place target files when it is executed.No; ignored unless a nested mapper is specified; by default, the target filenames returned by the mapper will be interpreted as absolute paths
:dirFilethe directory in which the command should be executed.No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir
:discarderrorbooleanWhether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10No; defaults to false
:discardoutputbooleanWhether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10No; defaults to false
:errorFileThe file to which the standard error of the command should be redirected. since Ant 1.6No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored. since Ant 1.6No
:executableStringthe command to execute without any command line arguments.Yes
:failifexecutionfailsbooleanStop the build if we can't start the program.No; defaults to true
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No; defaults to false
:forcebooleanWhether to bypass timestamp comparisons for target files. Since Ant 1.6.3.No; default is false
:forwardslashbooleanwhether the file names should be passed with forward slashes even if the operating system requires other file separator. The option is ignored if the system file separator is a forward slash.No; default is false
:ignoremissingbooleanWhether to ignore nonexistent files specified via filelists. Since Ant 1.6.2.No; default is true
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6No
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6No
:logerrorbooleanThis attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6No
:maxparallelintLimit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6.No, unlimited by default
:newenvironmentbooleanDo not propagate old environment when new environment variables are specified.No; default is false
:osStringlist of Operating Systems on which the command may be executed.No
:osfamilyStringOS family as used in the <os> condition. since Ant 1.7No
:outputFilethe file to which the output of the command should be redirected. If the error stream is not also redirected to a file or property, it will appear in this output.No
:outputpropertyStringthe name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output.No
:parallelbooleanRun the command only once, appending all files as arguments. If false, command will be executed once for every file.No; default is false
:relativebooleanwhether the filenames should be passed on the command line as relative pathnames (relative to the base directory of the corresponding fileset/list for source files or the dest attribute for target files).No; default is false
:resolveexecutablebooleanWhen this attribute is true, the name of the executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6No; default is false
:resultpropertyStringthe name of a property in which the return code of the command should be stored. Only of interest if failonerror is false. If you set parallel to false, only the result of the first execution will be stored.No
:searchpathboolean
:skipemptyfilesetsbooleanDon't run the command, if no source files have been found or are newer than their corresponding target files. Despite its name, this attribute applies to filelists as well.No; default is false
:spawnbooleanwhether or not you want the commands to be spawned. If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6No; default is false
:timeoutIntegerStop the command if it doesn't finish within the specified time (given in milliseconds).No
:typeFileDirBothOne of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only the names of directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir.No; default is file
:verbosebooleanWhether to print a summary after execution or not. Since Ant 1.6.No; default is false
:vmlauncherbooleanRun command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well.No; default is true

Nested elements

  • :arg (Argument)
  • :dirset (DirSet)
  • :env (Variable)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)
  • :redirector (RedirectorElement)
  • :srcfile (Marker)
  • :targetfile (Marker)

Reference

https://ant.apache.org/manual/Tasks/apply.html

Defined by

org.apache.tools.ant.taskdefs.ExecuteOn

Executes a system command. When the os attribute is specified, then the command is only
executed when Apache Ant is run on one of the specified operating systems. The files
and/or directories of a number of Resource Collections -- including but not restricted
to FileSets, DirSets (since Ant 1.6) or FileLists (since Ant 1.6) -- are passed as
arguments to the system command. If you specify a nested mapper, the timestamp of each
source file is compared to the timestamp of a target file which is defined by the nested
mapper element and searched for in the given dest, if specified. At least one fileset or
filelist is required, and you must not specify more than one mapper. Note that you
cannot interact with the forked program, the only way to send input to it is via the
input and inputstring attributes. Running Ant as a background process on Unix(-like)
systems If you run Ant as a background process (like ant &) and use the <apply> task
with spawn set to false, you must provide explicit input to the forked process or Ant
will be suspended because it tries to read from the standard input.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addsourcefile` | `boolean` | Whether source file names should be added to the command automatically. Since Ant 1.6. | No; default is true |
| `:append` | `boolean` | whether output should be appended to or overwrite an existing file. If you set parallel to false, you will probably want to set this one to true. | No; default is false |
| `:command` | `Commandline` |  |  |
| `:dest` | `File` | the directory where the command is expected to place target files when it is executed. | No; ignored unless a nested mapper is specified; by default, the target filenames returned by the mapper will be interpreted as absolute paths |
| `:dir` | `File` | the directory in which the command should be executed. | No; if vmlauncher is true, defaults to the current working directory, otherwise the project's basedir |
| `:discarderror` | `boolean` | Whether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10 | No; defaults to false |
| `:discardoutput` | `boolean` | Whether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10 | No; defaults to false |
| `:error` | `File` | The file to which the standard error of the command should be redirected. since Ant 1.6 | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. since Ant 1.6 | No |
| `:executable` | `String` | the command to execute without any command line arguments. | Yes |
| `:failifexecutionfails` | `boolean` | Stop the build if we can't start the program. | No; defaults to true |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No; defaults to false |
| `:force` | `boolean` | Whether to bypass timestamp comparisons for target files. Since Ant 1.6.3. | No; default is false |
| `:forwardslash` | `boolean` | whether the file names should be passed with forward slashes even if the operating system requires other file separator. The option is ignored if the system file separator is a forward slash. | No; default is false |
| `:ignoremissing` | `boolean` | Whether to ignore nonexistent files specified via filelists. Since Ant 1.6.2. | No; default is true |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6 | No |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6 | No |
| `:logerror` | `boolean` | This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. since Ant 1.6 | No |
| `:maxparallel` | `int` | Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to negative integer for unlimited. Since Ant 1.6. | No, unlimited by default |
| `:newenvironment` | `boolean` | Do not propagate old environment when new environment variables are specified. | No; default is false |
| `:os` | `String` | list of Operating Systems on which the command may be executed. | No |
| `:osfamily` | `String` | OS family as used in the <os> condition. since Ant 1.7 | No |
| `:output` | `File` | the file to which the output of the command should be redirected. If the error stream is not also redirected to a file or property, it will appear in this output. | No |
| `:outputproperty` | `String` | the name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. | No |
| `:parallel` | `boolean` | Run the command only once, appending all files as arguments. If false, command will be executed once for every file. | No; default is false |
| `:relative` | `boolean` | whether the filenames should be passed on the command line as relative pathnames (relative to the base directory of the corresponding fileset/list for source files or the dest attribute for target files). | No; default is false |
| `:resolveexecutable` | `boolean` | When this attribute is true, the name of the executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6 | No; default is false |
| `:resultproperty` | `String` | the name of a property in which the return code of the command should be stored. Only of interest if failonerror is false. If you set parallel to false, only the result of the first execution will be stored. | No |
| `:searchpath` | `boolean` |  |  |
| `:skipemptyfilesets` | `boolean` | Don't run the command, if no source files have been found or are newer than their corresponding target files. Despite its name, this attribute applies to filelists as well. | No; default is false |
| `:spawn` | `boolean` | whether or not you want the commands to be spawned. If you spawn a command, its output will not be logged by Ant. The input, output, error, and result property settings are not active when spawning a process. since Ant 1.6 | No; default is false |
| `:timeout` | `Integer` | Stop the command if it doesn't finish within the specified time (given in milliseconds). | No |
| `:type` | `FileDirBoth` | One of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only the names of directories are considered. Note: The type attribute does not apply to nested dirsets-dirsets always implicitly assume type to be dir. | No; default is file |
| `:verbose` | `boolean` | Whether to print a summary after execution or not. Since Ant 1.6. | No; default is false |
| `:vmlauncher` | `boolean` | Run command using the JVM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through JVM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well. | No; default is true |

**Nested elements**

- `:arg` (`Argument`)
- `:dirset` (`DirSet`)
- `:env` (`Variable`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:redirector` (`RedirectorElement`)
- `:srcfile` (`Marker`)
- `:targetfile` (`Marker`)

**Reference**

https://ant.apache.org/manual/Tasks/apply.html

**Defined by**

`org.apache.tools.ant.taskdefs.ExecuteOn`
sourceraw docstring

executableclj

(executable & args)

Ant nested executable. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.ExecutableSelector

Ant nested executable. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.ExecutableSelector`
sourceraw docstring

existingclj

(existing & args)

Ant nested existing. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested existing. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

expandpropertiesclj

(expandproperties & args)

Ant nested expandproperties. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.ExpandProperties

Ant nested expandproperties. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.ExpandProperties`
sourceraw docstring

extdirsclj

(extdirs & args)

Ant nested extdirs. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested extdirs. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

extensionclj

(extension & args)

Utility type that represents either an available "Optional Package" (formerly known as "Standard Extension") as described in the manifest of a JAR file, or the requirement for such an optional package. Note that this type works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or the online Package Versioning documentation.

Attributes

AttributeTypeDescriptionRequired
:extensionnameStringThe name of extensionyes
:implementationurlStringThe url from which to retrieve extension.no
:implementationvendorStringThe implementation vendorno
:implementationvendoridStringThe implementation vendor IDno
:implementationversionStringThe version of extension implementation (must be in dewey decimal aka dotted decimal notation, eg 3.2.4)no
:refidReferenceMakes this extension a reference to an extension defined elsewhere. If specified no other attributes or nested elements are allowed.No
:specificationvendorStringThe specification vendorno
:specificationversionStringThe version of extension specification (must be in dewey decimal aka dotted decimal notation, eg 3.2.4)no

Reference

https://ant.apache.org/manual/Types/extension.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter

Utility type that represents either an available "Optional Package" (formerly known as
"Standard Extension") as described in the manifest of a JAR file, or the requirement for
such an optional package. Note that this type works with extensions as defined by the
"Optional Package" specification. For more information about optional packages, see the
document Optional Package Versioning in the documentation bundle for your Java Standard
Edition package, in file guide/extensions/versioning.html or the online Package
Versioning documentation.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:extensionname` | `String` | The name of extension | yes |
| `:implementationurl` | `String` | The url from which to retrieve extension. | no |
| `:implementationvendor` | `String` | The implementation vendor | no |
| `:implementationvendorid` | `String` | The implementation vendor ID | no |
| `:implementationversion` | `String` | The version of extension implementation (must be in dewey decimal aka dotted decimal notation, eg 3.2.4) | no |
| `:refid` | `Reference` | Makes this extension a reference to an extension defined elsewhere. If specified no other attributes or nested elements are allowed. | No |
| `:specificationvendor` | `String` | The specification vendor | no |
| `:specificationversion` | `String` | The version of extension specification (must be in dewey decimal aka dotted decimal notation, eg 3.2.4) | no |

**Reference**

https://ant.apache.org/manual/Types/extension.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter`
sourceraw docstring

extensionSetclj

(extensionSet & args)

Utility type that represents a set of Extensions. Note that this type works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or online at Package Versioning documentation. The only supported attribute is refid which makes this extensionset a reference to an extensionset defined elsewhere. If specified no other attributes or nested elements are allowed.

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :extension (ExtensionAdapter)
  • :fileset (FileSet)
  • :libfileset (LibFileSet)

Reference

https://ant.apache.org/manual/Types/extensionSet.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet

Utility type that represents a set of Extensions. Note that this type works with
extensions as defined by the "Optional Package" specification. For more information
about optional packages, see the document Optional Package Versioning in the
documentation bundle for your Java Standard Edition package, in file
guide/extensions/versioning.html or online at Package Versioning documentation. The only
supported attribute is refid which makes this extensionset a reference to an
extensionset defined elsewhere. If specified no other attributes or nested elements are
allowed.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:extension` (`ExtensionAdapter`)
- `:fileset` (`FileSet`)
- `:libfileset` (`LibFileSet`)

**Reference**

https://ant.apache.org/manual/Types/extensionSet.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet`
sourceraw docstring

extensionsetclj

(extensionset & args)

Utility type that represents a set of Extensions. Note that this type works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or online at Package Versioning documentation. The only supported attribute is refid which makes this extensionset a reference to an extensionset defined elsewhere. If specified no other attributes or nested elements are allowed.

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :extension (ExtensionAdapter)
  • :fileset (FileSet)
  • :libfileset (LibFileSet)

Reference

https://ant.apache.org/manual/Types/extensionset.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet

Utility type that represents a set of Extensions. Note that this type works with
extensions as defined by the "Optional Package" specification. For more information
about optional packages, see the document Optional Package Versioning in the
documentation bundle for your Java Standard Edition package, in file
guide/extensions/versioning.html or online at Package Versioning documentation. The only
supported attribute is refid which makes this extensionset a reference to an
extensionset defined elsewhere. If specified no other attributes or nested elements are
allowed.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:extension` (`ExtensionAdapter`)
- `:fileset` (`FileSet`)
- `:libfileset` (`LibFileSet`)

**Reference**

https://ant.apache.org/manual/Types/extensionset.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet`
sourceraw docstring

factoryclj

(factory & args)

Ant nested factory. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Nested elements

  • :attribute (Attribute)
  • :feature (Feature)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess$Factory

Ant nested factory. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Nested elements**

- `:attribute` (`Attribute`)
- `:feature` (`Feature`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess$Factory`
sourceraw docstring

failclj

(fail & args)

Exits the current build (just throwing a BuildException), optionally printing additional information. The message of the Exception can be set via the message attribute or character data nested into the element.

Attributes

AttributeTypeDescriptionRequired
:ifObjectOnly fail if a property of the given name exists in the current projectNo
:messageStringA message giving further information on why the build exitedNo
:statusintExit using the specified status code; assuming the generated Exception is not caught, the JVM will exit with this status. Since Apache Ant 1.6.2No
:unlessObjectOnly fail if a property of the given name doesn't exist in the current projectNo

Nested elements

  • :condition (ConditionBase)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/fail.html

Defined by

org.apache.tools.ant.taskdefs.Exit

Exits the current build (just throwing a BuildException), optionally printing additional
information. The message of the Exception can be set via the message attribute or
character data nested into the element.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:if` | `Object` | Only fail if a property of the given name exists in the current project | No |
| `:message` | `String` | A message giving further information on why the build exited | No |
| `:status` | `int` | Exit using the specified status code; assuming the generated Exception is not caught, the JVM will exit with this status. Since Apache Ant 1.6.2 | No |
| `:unless` | `Object` | Only fail if a property of the given name doesn't exist in the current project | No |

**Nested elements**

- `:condition` (`ConditionBase`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/fail.html

**Defined by**

`org.apache.tools.ant.taskdefs.Exit`
sourceraw docstring

featureclj

(feature & args)

Ant nested feature. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:valueboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess$Factory$Feature

Ant nested feature. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:value` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess$Factory$Feature`
sourceraw docstring

fileclj

(file & args)

Ant type file. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile
:directoryboolean
:existsboolean
:fileFile
:lastmodifiedlong
:nameString
:refidReference
:sizelong

Reference

https://ant.apache.org/manual/Types/file.html

Defined by

org.apache.tools.ant.types.resources.FileResource

Ant type file. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:file` | `File` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

https://ant.apache.org/manual/Types/file.html

**Defined by**

`org.apache.tools.ant.types.resources.FileResource`
sourceraw docstring

filelistclj

(filelist & args)

FileLists are explicitly named lists of files. Whereas FileSets act as filters, returning only those files that exist in the file system and match specified patterns, FileLists are useful for specifying files that may or may not exist. Multiple files are specified as a list of files, relative to the specified directory, with no support for wildcard expansion (filenames with wildcards will be included in the list unchanged). FileLists can appear inside tasks that support this feature or as stand-alone types.

Attributes

AttributeTypeDescriptionRequired
:dirFileThe base directory of this FileList.Yes
:filesStringThe list of file names. This is a list of file name separated by whitespace, or by commas.Yes, unless there is a nested file element
:refidReferenceMakes this filelist a reference to a filelist defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :file (FileName)

Reference

https://ant.apache.org/manual/Types/filelist.html

Defined by

org.apache.tools.ant.types.FileList

FileLists are explicitly named lists of files. Whereas FileSets act as filters,
returning only those files that exist in the file system and match specified patterns,
FileLists are useful for specifying files that may or may not exist. Multiple files are
specified as a list of files, relative to the specified directory, with no support for
wildcard expansion (filenames with wildcards will be included in the list unchanged).
FileLists can appear inside tasks that support this feature or as stand-alone types.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dir` | `File` | The base directory of this FileList. | Yes |
| `:files` | `String` | The list of file names. This is a list of file name separated by whitespace, or by commas. | Yes, unless there is a nested file element |
| `:refid` | `Reference` | Makes this filelist a reference to a filelist defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:file` (`FileName`)

**Reference**

https://ant.apache.org/manual/Types/filelist.html

**Defined by**

`org.apache.tools.ant.types.FileList`
sourceraw docstring

filenameclj

(filename & args)

Ant nested filename. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:errorString
:nameString
:negateboolean
:refidReference
:regexString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.FilenameSelector

Ant nested filename. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:error` | `String` |  |  |
| `:name` | `String` |  |  |
| `:negate` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:regex` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.FilenameSelector`
sourceraw docstring

filepathclj

(filepath & args)

Ant nested filepath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested filepath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

filesclj

(files & args)

Ant type files. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:excludesString
:excludesfileFile
:followsymlinksboolean
:includesString
:includesfileFile
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/files.html

Defined by

org.apache.tools.ant.types.resources.Files

Ant type files. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/files.html

**Defined by**

`org.apache.tools.ant.types.resources.Files`
sourceraw docstring

filesetclj

(fileset & args)

A FileSet is a group of files. These files can be found in a directory tree starting in a base directory and are matched by patterns taken from a number of PatternSets and Selectors. PatternSets can be specified as nested <patternset> elements. In addition, FileSet holds an implicit PatternSet and supports the nested <include>, <includesfile>, <exclude> and <excludesfile> elements of PatternSet directly, as well as PatternSet's attributes. Selectors are available as nested elements within the FileSet. If any of the selectors within the FileSet do not select the file, the file is not considered part of the FileSet. This makes a FileSet equivalent to an <and> selector container.

Attributes

AttributeTypeDescriptionRequired
:casesensitivebooleanMust the include and exclude patterns be treated in a case sensitive way?No; defaults to true
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:dirFilethe root of the directory tree of this FileSet.Exactly one of dir or file must be specified
:erroronmissingdirbooleanSpecify what happens if the base directory does not exist. If true a build error will happen, if false, the fileset will be ignored/empty. Since Apache Ant 1.7.1No; defaults to true (for backward compatibility reasons)
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file; each line of this file is taken to be an exclude pattern.No
:fileFileshortcut for specifying a single-file filesetExactly one of dir or file must be specified
:followsymlinksbooleanShall symbolic links and Windows junctions be followed? See the note below. Windows junctions are detected since Ant 1.10.16.No; defaults to true
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all files
:includesfileFilename of a file; each line of this file is taken to be an include pattern. Note: if the file is empty and there are no other patterns defined for the fileset, all files will be included.No
:maxlevelsofsymlinksint
:refidReferenceMakes this fileset a reference to a fileset defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/fileset.html

Defined by

org.apache.tools.ant.types.FileSet

A FileSet is a group of files. These files can be found in a directory tree starting in
a base directory and are matched by patterns taken from a number of PatternSets and
Selectors. PatternSets can be specified as nested <patternset> elements. In addition,
FileSet holds an implicit PatternSet and supports the nested <include>, <includesfile>,
<exclude> and <excludesfile> elements of PatternSet directly, as well as PatternSet's
attributes. Selectors are available as nested elements within the FileSet. If any of the
selectors within the FileSet do not select the file, the file is not considered part of
the FileSet. This makes a FileSet equivalent to an <and> selector container.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` | Must the include and exclude patterns be treated in a case sensitive way? | No; defaults to true |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:dir` | `File` | the root of the directory tree of this FileSet. | Exactly one of dir or file must be specified |
| `:erroronmissingdir` | `boolean` | Specify what happens if the base directory does not exist. If true a build error will happen, if false, the fileset will be ignored/empty. Since Apache Ant 1.7.1 | No; defaults to true (for backward compatibility reasons) |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file; each line of this file is taken to be an exclude pattern. | No |
| `:file` | `File` | shortcut for specifying a single-file fileset | Exactly one of dir or file must be specified |
| `:followsymlinks` | `boolean` | Shall symbolic links and Windows junctions be followed? See the note below. Windows junctions are detected since Ant 1.10.16. | No; defaults to true |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all files |
| `:includesfile` | `File` | name of a file; each line of this file is taken to be an include pattern. Note: if the file is empty and there are no other patterns defined for the fileset, all files will be included. | No |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` | Makes this fileset a reference to a fileset defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/fileset.html

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

filesmatchclj

(filesmatch & args)

Ant nested filesmatch. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:file1File
:file2File
:textfileboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.FilesMatch

Ant nested filesmatch. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file1` | `File` |  |  |
| `:file2` | `File` |  |  |
| `:textfile` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.FilesMatch`
sourceraw docstring

filetokenizerclj

(filetokenizer & args)

Ant type filetokenizer. (No description bundled.)

Reference

https://ant.apache.org/manual/Types/filetokenizer.html

Defined by

org.apache.tools.ant.util.FileTokenizer

Ant type filetokenizer. (No description bundled.)

**Reference**

https://ant.apache.org/manual/Types/filetokenizer.html

**Defined by**

`org.apache.tools.ant.util.FileTokenizer`
sourceraw docstring

filterclj

(filter & args)

Sets a token filter for this project or reads a properties file as multiple token filter definitions and sets them. Token filters are used by all tasks that perform file copying operations through the Project commodity methods. See the warning here before using. The task uses @ as token separator. Token strings cannot contain separator characters; incorrect tokens are ignored.

Attributes

AttributeTypeDescriptionRequired
:filtersfileFileThe file from which the filters must be read. This file must be a formatted as a property file.Yes; either both token and value, or only filtersfile
:tokenStringthe token string without the separator chars (@)Yes; either both token and value, or only filtersfile
:valueStringthe string that should be put to replace the token when the file is copiedYes; either both token and value, or only filtersfile

Reference

https://ant.apache.org/manual/Tasks/filter.html

Defined by

org.apache.tools.ant.taskdefs.Filter

Sets a token filter for this project or reads a properties file as multiple token filter
definitions and sets them. Token filters are used by all tasks that perform file copying
operations through the Project commodity methods. See the warning here before using. The
task uses @ as token separator. Token strings cannot contain separator characters;
incorrect tokens are ignored.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:filtersfile` | `File` | The file from which the filters must be read. This file must be a formatted as a property file. | Yes; either both token and value, or only filtersfile |
| `:token` | `String` | the token string without the separator chars (@) | Yes; either both token and value, or only filtersfile |
| `:value` | `String` | the string that should be put to replace the token when the file is copied | Yes; either both token and value, or only filtersfile |

**Reference**

https://ant.apache.org/manual/Tasks/filter.html

**Defined by**

`org.apache.tools.ant.taskdefs.Filter`
sourceraw docstring

filterchainclj

(filterchain & args)

Consider the flexibility of Unix pipes. If you wanted, for example, to copy just those lines that contained the string blee from the first 10 lines of a text file foo (you wouldn't want to filter a binary file) to a file bar, you would do something like: cat foo|head -n10|grep blee > bar Apache Ant was not flexible enough. There was no way for the <copy> task to do something similar. If you wanted the <copy> task to get the first 10 lines, you would have had to create special attributes: <copy file="foo" tofile="bar" head="10" contains="blee"/> The obvious problem thus surfaced: Ant tasks would not be able to accommodate such data transformation attributes as they would be endless. The task would also not know in which order these attributes were to be interpreted. That is, must the task execute the contains attribute first and then the head attribute or vice-versa? What Ant tasks needed was a mechanism to allow pluggable filter (data transformer) chains. Ant would provide a few filters for which there have been repeated requests. Users with special filtering needs would be able to easily write their own and plug them in. The solution was to refactor data transformation oriented tasks to support FilterChains. A FilterChain is a group of ordered FilterReaders. Users can define their own FilterReaders by just extending the java.io.FilterReader class. Such custom FilterReaders can be easily plugged in as nested elements of <filterchain> by using <filterreader> elements. Example: <copy file="${src.file}" tofile="${dest.file}"> <filterchain> <filterreader classname="your.extension.of.java.io.FilterReader"> <param name="foo" value="bar"/> </filterreader> <filterreader classname="another.extension.of.java.io.FilterReader"> <classpath> <pathelement path="${classpath}"/> </classpath> <param name="blah" value="blee"/> <param type="abra" value="cadabra"/> </filterreader> </filterchain> </copy> Ant provides some built-in filter readers. These filter readers can also be declared using a syntax similar to the above syntax. However, they can be declared using some simpler syntax also. Example: <loadfile srcfile="${src.file}" property="src.file.head"> <filterchain> <headfilter lines="15"/> </filterchain> </loadfile> is equivalent to: <loadfile srcfile="${src.file}" property="src.file.head"> <filterchain> <filterreader classname="org.apache.tools.ant.filters.HeadFilter"> <param name="lines" value="15"/> </filterreader> </filterchain> </loadfile> The only supported attribute is refid which makes this filterchain a reference to a filterchain defined elsewhere. If specified no other attributes or nested elements are allowed. The following built-in tasks support nested <filterchain> elements. Concat, Copy, LoadFile, LoadProperties, LoadResource, Move A FilterChain is formed by defining zero or more of the following nested elements. FilterReader ClassConstants EscapeUnicode ExpandProperties HeadFilter LineContains LineContainsRegExp PrefixLines ReplaceTokens StripJavaComments StripLineBreaks StripLineComments SuffixLines TabsToSpaces TailFilter DeleteCharacters ConcatFilter SortFilter TokenFilter FixCRLF

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :classconstants (ClassConstants)
  • :containsregex (ContainsRegex)
  • :deletecharacters (DeleteCharacters)
  • :escapeunicode (EscapeUnicode)
  • :expandproperties (ExpandProperties)
  • :filterreader (AntFilterReader)
  • :headfilter (HeadFilter)
  • :ignoreblank (IgnoreBlank)
  • :linecontains (LineContains)
  • :linecontainsregexp (LineContainsRegExp)
  • :prefixlines (PrefixLines)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :replacetokens (ReplaceTokens)
  • :stripjavacomments (StripJavaComments)
  • :striplinebreaks (StripLineBreaks)
  • :striplinecomments (StripLineComments)
  • :suffixlines (SuffixLines)
  • :tabstospaces (TabsToSpaces)
  • :tailfilter (TailFilter)
  • :tokenfilter (TokenFilter)
  • :trim (Trim)

Reference

https://ant.apache.org/manual/Types/filterchain.html

Defined by

org.apache.tools.ant.types.FilterChain

Consider the flexibility of Unix pipes. If you wanted, for example, to copy just those
lines that contained the string blee from the first 10 lines of a text file foo (you
wouldn't want to filter a binary file) to a file bar, you would do something like: cat
foo|head -n10|grep blee > bar Apache Ant was not flexible enough. There was no way for
the <copy> task to do something similar. If you wanted the <copy> task to get the first
10 lines, you would have had to create special attributes: <copy file="foo" tofile="bar"
head="10" contains="blee"/> The obvious problem thus surfaced: Ant tasks would not be
able to accommodate such data transformation attributes as they would be endless. The
task would also not know in which order these attributes were to be interpreted. That
is, must the task execute the contains attribute first and then the head attribute or
vice-versa? What Ant tasks needed was a mechanism to allow pluggable filter (data
transformer) chains. Ant would provide a few filters for which there have been repeated
requests. Users with special filtering needs would be able to easily write their own and
plug them in. The solution was to refactor data transformation oriented tasks to support
FilterChains. A FilterChain is a group of ordered FilterReaders. Users can define their
own FilterReaders by just extending the java.io.FilterReader class. Such custom
FilterReaders can be easily plugged in as nested elements of <filterchain> by using
<filterreader> elements. Example: <copy file="${src.file}" tofile="${dest.file}">
<filterchain> <filterreader classname="your.extension.of.java.io.FilterReader"> <param
name="foo" value="bar"/> </filterreader> <filterreader
classname="another.extension.of.java.io.FilterReader"> <classpath> <pathelement
path="${classpath}"/> </classpath> <param name="blah" value="blee"/> <param type="abra"
value="cadabra"/> </filterreader> </filterchain> </copy> Ant provides some built-in
filter readers. These filter readers can also be declared using a syntax similar to the
above syntax. However, they can be declared using some simpler syntax also. Example:
<loadfile srcfile="${src.file}" property="src.file.head"> <filterchain> <headfilter
lines="15"/> </filterchain> </loadfile> is equivalent to: <loadfile
srcfile="${src.file}" property="src.file.head"> <filterchain> <filterreader
classname="org.apache.tools.ant.filters.HeadFilter"> <param name="lines" value="15"/>
</filterreader> </filterchain> </loadfile> The only supported attribute is refid which
makes this filterchain a reference to a filterchain defined elsewhere. If specified no
other attributes or nested elements are allowed. The following built-in tasks support
nested <filterchain> elements. Concat, Copy, LoadFile, LoadProperties, LoadResource,
Move A FilterChain is formed by defining zero or more of the following nested elements.
FilterReader ClassConstants EscapeUnicode ExpandProperties HeadFilter LineContains
LineContainsRegExp PrefixLines ReplaceTokens StripJavaComments StripLineBreaks
StripLineComments SuffixLines TabsToSpaces TailFilter DeleteCharacters ConcatFilter
SortFilter TokenFilter FixCRLF

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classconstants` (`ClassConstants`)
- `:containsregex` (`ContainsRegex`)
- `:deletecharacters` (`DeleteCharacters`)
- `:escapeunicode` (`EscapeUnicode`)
- `:expandproperties` (`ExpandProperties`)
- `:filterreader` (`AntFilterReader`)
- `:headfilter` (`HeadFilter`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linecontains` (`LineContains`)
- `:linecontainsregexp` (`LineContainsRegExp`)
- `:prefixlines` (`PrefixLines`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:replacetokens` (`ReplaceTokens`)
- `:stripjavacomments` (`StripJavaComments`)
- `:striplinebreaks` (`StripLineBreaks`)
- `:striplinecomments` (`StripLineComments`)
- `:suffixlines` (`SuffixLines`)
- `:tabstospaces` (`TabsToSpaces`)
- `:tailfilter` (`TailFilter`)
- `:tokenfilter` (`TokenFilter`)
- `:trim` (`Trim`)

**Reference**

https://ant.apache.org/manual/Types/filterchain.html

**Defined by**

`org.apache.tools.ant.types.FilterChain`
sourceraw docstring

filtermapperclj

(filtermapper & args)

Ant type filtermapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:refidReference
:toString

Nested elements

  • :classconstants (ClassConstants)
  • :containsregex (ContainsRegex)
  • :deletecharacters (DeleteCharacters)
  • :escapeunicode (EscapeUnicode)
  • :expandproperties (ExpandProperties)
  • :filterreader (AntFilterReader)
  • :headfilter (HeadFilter)
  • :ignoreblank (IgnoreBlank)
  • :linecontains (LineContains)
  • :linecontainsregexp (LineContainsRegExp)
  • :prefixlines (PrefixLines)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :replacetokens (ReplaceTokens)
  • :stripjavacomments (StripJavaComments)
  • :striplinebreaks (StripLineBreaks)
  • :striplinecomments (StripLineComments)
  • :suffixlines (SuffixLines)
  • :tabstospaces (TabsToSpaces)
  • :tailfilter (TailFilter)
  • :tokenfilter (TokenFilter)
  • :trim (Trim)

Reference

https://ant.apache.org/manual/Types/filtermapper.html

Defined by

org.apache.tools.ant.types.mappers.FilterMapper

Ant type filtermapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:to` | `String` |  |  |

**Nested elements**

- `:classconstants` (`ClassConstants`)
- `:containsregex` (`ContainsRegex`)
- `:deletecharacters` (`DeleteCharacters`)
- `:escapeunicode` (`EscapeUnicode`)
- `:expandproperties` (`ExpandProperties`)
- `:filterreader` (`AntFilterReader`)
- `:headfilter` (`HeadFilter`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linecontains` (`LineContains`)
- `:linecontainsregexp` (`LineContainsRegExp`)
- `:prefixlines` (`PrefixLines`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:replacetokens` (`ReplaceTokens`)
- `:stripjavacomments` (`StripJavaComments`)
- `:striplinebreaks` (`StripLineBreaks`)
- `:striplinecomments` (`StripLineComments`)
- `:suffixlines` (`SuffixLines`)
- `:tabstospaces` (`TabsToSpaces`)
- `:tailfilter` (`TailFilter`)
- `:tokenfilter` (`TokenFilter`)
- `:trim` (`Trim`)

**Reference**

https://ant.apache.org/manual/Types/filtermapper.html

**Defined by**

`org.apache.tools.ant.types.mappers.FilterMapper`
sourceraw docstring

filterreaderclj

(filterreader & args)

Ant type filterreader. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:refidReference

Nested elements

  • :classpath (Path)
  • :param (Parameter)

Reference

https://ant.apache.org/manual/Types/filterreader.html

Defined by

org.apache.tools.ant.types.AntFilterReader

Ant type filterreader. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:param` (`Parameter`)

**Reference**

https://ant.apache.org/manual/Types/filterreader.html

**Defined by**

`org.apache.tools.ant.types.AntFilterReader`
sourceraw docstring

filtersetclj

(filterset & args)

FilterSets are groups of filters. Filters can be defined as token-value pairs or be read in from a file. FilterSets can appear inside tasks that support this feature or at the same level as <target>-i.e., as children of <project>. FilterSets support the id and refid attributes. You can define a FilterSet with an id attribute and then refer to that definition from another FilterSet with a refid attribute. It is also possible to nest filtersets into filtersets to get a set union of the contained filters. In addition, FilterSets can specify begintoken and/or endtoken attributes to define what to match. Filtersets are used for doing replacements in tasks such as <copy>, etc. Filters can also by specified by one or more nested propertysets, the contents of which are applied when the filterset is created. If you specify multiple values for the same token, the last one defined within a filterset will be used. Note: When a filterset is used in an operation, the files are processed in text mode and the filters applied line by line. This means that the copy operations will typically corrupt binary files. When applying filters you should ensure that the set of files being filtered are all text files.

Attributes

AttributeTypeDescriptionRequired
:begintokenStringThe string marking the beginning of a token (eg., @DATE@).@
:endtokenStringThe string marking the end of a token (eg., @DATE@).@
:filtersfileFileSpecify a single filtersfile.none
:onmissingfiltersfileOnMissingIndicate behavior when a nonexistent filtersfile is specified. One of fail, warn, ignore. Since Ant 1.7fail
:recursebooleanIndicates whether the replacement text of tokens should be searched for more tokens. Since Ant 1.6.3true
:refidReferenceMakes this filterset a reference to a filterset defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :filter (Filter)
  • :filterset (FilterSet)
  • :filtersfile (FiltersFile)
  • :propertyset (PropertySet)

Reference

https://ant.apache.org/manual/Types/filterset.html

Defined by

org.apache.tools.ant.types.FilterSet

FilterSets are groups of filters. Filters can be defined as token-value pairs or be read
in from a file. FilterSets can appear inside tasks that support this feature or at the
same level as <target>-i.e., as children of <project>. FilterSets support the id and
refid attributes. You can define a FilterSet with an id attribute and then refer to that
definition from another FilterSet with a refid attribute. It is also possible to nest
filtersets into filtersets to get a set union of the contained filters. In addition,
FilterSets can specify begintoken and/or endtoken attributes to define what to match.
Filtersets are used for doing replacements in tasks such as <copy>, etc. Filters can
also by specified by one or more nested propertysets, the contents of which are applied
when the filterset is created. If you specify multiple values for the same token, the
last one defined within a filterset will be used. Note: When a filterset is used in an
operation, the files are processed in text mode and the filters applied line by line.
This means that the copy operations will typically corrupt binary files. When applying
filters you should ensure that the set of files being filtered are all text files.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:begintoken` | `String` | The string marking the beginning of a token (eg., @DATE@). | @ |
| `:endtoken` | `String` | The string marking the end of a token (eg., @DATE@). | @ |
| `:filtersfile` | `File` | Specify a single filtersfile. | none |
| `:onmissingfiltersfile` | `OnMissing` | Indicate behavior when a nonexistent filtersfile is specified. One of fail, warn, ignore. Since Ant 1.7 | fail |
| `:recurse` | `boolean` | Indicates whether the replacement text of tokens should be searched for more tokens. Since Ant 1.6.3 | true |
| `:refid` | `Reference` | Makes this filterset a reference to a filterset defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:filter` (`Filter`)
- `:filterset` (`FilterSet`)
- `:filtersfile` (`FiltersFile`)
- `:propertyset` (`PropertySet`)

**Reference**

https://ant.apache.org/manual/Types/filterset.html

**Defined by**

`org.apache.tools.ant.types.FilterSet`
sourceraw docstring

filtersfileclj

(filtersfile & args)

Ant nested filtersfile. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FilterSet$FiltersFile

Ant nested filtersfile. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FilterSet$FiltersFile`
sourceraw docstring

firstclj

(first & args)

Ant type first. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:countint
:refidReference

Reference

https://ant.apache.org/manual/Types/first.html

Defined by

org.apache.tools.ant.types.resources.First

Ant type first. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:count` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/first.html

**Defined by**

`org.apache.tools.ant.types.resources.First`
sourceraw docstring

firstmatchmapperclj

(firstmatchmapper & args)

Ant type firstmatchmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Nested elements

  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Types/firstmatchmapper.html

Defined by

org.apache.tools.ant.util.FirstMatchMapper

Ant type firstmatchmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/firstmatchmapper.html

**Defined by**

`org.apache.tools.ant.util.FirstMatchMapper`
sourceraw docstring

fixcrlfclj

(fixcrlf & args)

Adjusts a text file to local conventions. The set of files to be adjusted can be refined with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. Patterns provided through the includes or includesfile attributes specify files to be included. Patterns provided through the exclude or excludesfile attribute specify files to be excluded. Additionally, default exclusions can be specified with the defaultexcludes attribute. See the section on directory-based tasks, for details of file inclusion/exclusion patterns and their usage. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes srcdir) as well as the nested <include>, <exclude> and <patternset> elements. The output file is only written if it is a new file, or if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which have been regenerated by this task. In order to assess whether a file has changed, this task will create a pre-processed version of the source file inside of the temporary directory. Since Apache Ant 1.7, this task can be used in a filterchain.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:crAddAsisRemoveDeprecated. Specifies how CR characters are to be handled at end-of-line (EOL). Valid values for this property are: asis: leave EOL characters alone. add: add a CR before any single LF characters. The intent is to convert all EOLs to the pair CRLF. remove: remove all CRs from the file. The intent is to convert all EOLs to a single LF. Note: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as asis, this sequence will be converted into the specified EOL type.No; default is platform-specific: remove for Unix platforms, add for DOS based systems (including Windows)
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destdirFileWhere to place the corrected files.No; defaults to srcDir (replace the original files)
:encodingStringThe encoding of the files.No; defaults to default JVM character encoding
:eofAddAsisRemoveSpecifies how DOS end of file (control-Z) characters are to be handled. Valid values for this property are: add: ensure that there is an EOF character at the end of the file asis: leave EOF characters alone remove: remove any EOF character found at the endNo; default is platform-specific: remove for Unix platforms, asis for DOS based systems (including Windows)
:eolCrLfSpecifies how end-of-line (EOL) characters are to be handled. The EOL characters are CR, LF and the pair CRLF. Valid values for this property are: asis: leave EOL characters alone cr: convert all EOLs to a single CR lf: convert all EOLs to a single LF crlf: convert all EOLs to the pair CRLF mac: convert all EOLs to a single CR unix: convert all EOLs to a single LF dos: convert all EOLs to the pair CRLF This is the preferred method for specifying EOL. The cr attribute (see below) is now deprecated. Note: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as asis, this sequence will be converted into the specified EOL type.No; default is platform-specific: lf for Unix platforms (including Mac OS X/macOS), crlf for DOS-based systems (including Windows), cr for Mac environments other than OS X
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude pattern.No
:fileFileName of a single file to fix. Since Ant 1.7One of these
:fixlastbooleanWhether to add a missing EOL to the last line of a processed file. Ignored if eof is asis. Since Ant 1.6.1No; default is true
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include pattern.No
:javafilesbooleanUsed only in association with the tab attribute (see below), this boolean attribute indicates whether the fileset is a set of Java source files (yes|no). See notes in section on tab.No; defaults to no
:outputencodingStringThe encoding to use when writing the files. Since Ant 1.7No; defaults to encoding if set or default JVM character encoding otherwise
:preservelastmodifiedbooleanWhether to preserve the last modified date of source files. Since Ant 1.6.3No; default is false
:srcdirFileWhere to find the files to be fixed up.One of these
:tabAddAsisRemoveSpecifies how tab characters are to be handled. Valid values for this property are: add: convert sequences of spaces which span a tab stop to tabs asis: leave tab and space characters alone remove: convert tabs to spaces Note: When the attribute javafiles (see above) is true, literal TAB characters occurring within Java string or character constants are never modified. This functionality also requires the recognition of Java-style comments. Note: There is an incompatibility between this and the previous version in the handling of white space at the end of lines. This version does not remove trailing whitespace on lines.No; default is asis
:tablengthintTAB character interval. Valid values are between 2 and 80 inclusive.No; default is 8

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/fixcrlf.html

Defined by

org.apache.tools.ant.taskdefs.FixCRLF

Adjusts a text file to local conventions. The set of files to be adjusted can be refined
with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes.
Patterns provided through the includes or includesfile attributes specify files to be
included. Patterns provided through the exclude or excludesfile attribute specify files
to be excluded. Additionally, default exclusions can be specified with the
defaultexcludes attribute. See the section on directory-based tasks, for details of file
inclusion/exclusion patterns and their usage. This task forms an implicit FileSet and
supports most attributes of <fileset> (dir becomes srcdir) as well as the nested
<include>, <exclude> and <patternset> elements. The output file is only written if it is
a new file, or if it differs from the existing file. This prevents spurious rebuilds
based on unchanged files which have been regenerated by this task. In order to assess
whether a file has changed, this task will create a pre-processed version of the source
file inside of the temporary directory. Since Apache Ant 1.7, this task can be used in a
filterchain.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:cr` | `AddAsisRemove` | Deprecated. Specifies how CR characters are to be handled at end-of-line (EOL). Valid values for this property are: asis: leave EOL characters alone. add: add a CR before any single LF characters. The intent is to convert all EOLs to the pair CRLF. remove: remove all CRs from the file. The intent is to convert all EOLs to a single LF. Note: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as asis, this sequence will be converted into the specified EOL type. | No; default is platform-specific: remove for Unix platforms, add for DOS based systems (including Windows) |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | Where to place the corrected files. | No; defaults to srcDir (replace the original files) |
| `:encoding` | `String` | The encoding of the files. | No; defaults to default JVM character encoding |
| `:eof` | `AddAsisRemove` | Specifies how DOS end of file (control-Z) characters are to be handled. Valid values for this property are: add: ensure that there is an EOF character at the end of the file asis: leave EOF characters alone remove: remove any EOF character found at the end | No; default is platform-specific: remove for Unix platforms, asis for DOS based systems (including Windows) |
| `:eol` | `CrLf` | Specifies how end-of-line (EOL) characters are to be handled. The EOL characters are CR, LF and the pair CRLF. Valid values for this property are: asis: leave EOL characters alone cr: convert all EOLs to a single CR lf: convert all EOLs to a single LF crlf: convert all EOLs to the pair CRLF mac: convert all EOLs to a single CR unix: convert all EOLs to a single LF dos: convert all EOLs to the pair CRLF This is the preferred method for specifying EOL. The cr attribute (see below) is now deprecated. Note: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as asis, this sequence will be converted into the specified EOL type. | No; default is platform-specific: lf for Unix platforms (including Mac OS X/macOS), crlf for DOS-based systems (including Windows), cr for Mac environments other than OS X |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern. | No |
| `:file` | `File` | Name of a single file to fix. Since Ant 1.7 | One of these |
| `:fixlast` | `boolean` | Whether to add a missing EOL to the last line of a processed file. Ignored if eof is asis. Since Ant 1.6.1 | No; default is true |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern. | No |
| `:javafiles` | `boolean` | Used only in association with the tab attribute (see below), this boolean attribute indicates whether the fileset is a set of Java source files (yes\|no). See notes in section on tab. | No; defaults to no |
| `:outputencoding` | `String` | The encoding to use when writing the files. Since Ant 1.7 | No; defaults to encoding if set or default JVM character encoding otherwise |
| `:preservelastmodified` | `boolean` | Whether to preserve the last modified date of source files. Since Ant 1.6.3 | No; default is false |
| `:srcdir` | `File` | Where to find the files to be fixed up. | One of these |
| `:tab` | `AddAsisRemove` | Specifies how tab characters are to be handled. Valid values for this property are: add: convert sequences of spaces which span a tab stop to tabs asis: leave tab and space characters alone remove: convert tabs to spaces Note: When the attribute javafiles (see above) is true, literal TAB characters occurring within Java string or character constants are never modified. This functionality also requires the recognition of Java-style comments. Note: There is an incompatibility between this and the previous version in the handling of white space at the end of lines. This version does not remove trailing whitespace on lines. | No; default is asis |
| `:tablength` | `int` | TAB character interval. Valid values are between 2 and 80 inclusive. | No; default is 8 |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/fixcrlf.html

**Defined by**

`org.apache.tools.ant.taskdefs.FixCRLF`
sourceraw docstring

flattenmapperclj

(flattenmapper & args)

Ant type flattenmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Reference

https://ant.apache.org/manual/Types/flattenmapper.html

Defined by

org.apache.tools.ant.util.FlatFileNameMapper

Ant type flattenmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/flattenmapper.html

**Defined by**

`org.apache.tools.ant.util.FlatFileNameMapper`
sourceraw docstring

(footer & args)

Ant nested footer. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:encodingString
:fileFile
:filteringboolean
:trimboolean
:trimleadingboolean

Body text

Accepts a free-form text body.

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.Javadoc$Html

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Concat$TextElement

Ant nested footer. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:encoding` | `String` |  |  |
| `:file` | `File` |  |  |
| `:filtering` | `boolean` |  |  |
| `:trim` | `boolean` |  |  |
| `:trimleading` | `boolean` |  |  |

**Body text**

Accepts a free-form text body.

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.Javadoc$Html`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Concat$TextElement`
sourceraw docstring

formatclj

(format & args)

Ant nested format. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:localeString
:offsetint
:patternString
:propertyString
:timezoneString
:unitUnit

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Tstamp$CustomFormat

Ant nested format. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:locale` | `String` |  |  |
| `:offset` | `int` |  |  |
| `:pattern` | `String` |  |  |
| `:property` | `String` |  |  |
| `:timezone` | `String` |  |  |
| `:unit` | `Unit` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Tstamp$CustomFormat`
sourceraw docstring

fromclj

(from & args)

Ant nested from. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:addressString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.EmailAddress

Ant nested from. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:address` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailAddress`
sourceraw docstring

genericclj

(generic & args)

Ant nested generic. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:passwordString
:serverString
:usernameString

Nested elements

  • :arg (Argument)
  • :classpath (Path)
  • :jvmarg (Argument)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool

Ant nested generic. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:password` | `String` |  |  |
| `:server` | `String` |  |  |
| `:username` | `String` |  |  |

**Nested elements**

- `:arg` (`Argument`)
- `:classpath` (`Path`)
- `:jvmarg` (`Argument`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool`
sourceraw docstring

genkeyclj

(genkey & args)

Generates a key in a keystore.

Attributes

AttributeTypeDescriptionRequired
:aliasStringthe alias to add underYes.
:dnameStringThe distinguished name for entityYes unless <dname> element is specified
:keyalgStringthe method to use when generating name-value pairNo
:keypassStringpassword for private key (if different)No
:keysizeString(integer) indicates the size of key generatedNo
:keystoreStringkeystore locationNo
:sanameStringThe subject alternative name for entity. Requires Java 7 or higher.No
:sigalgStringthe algorithm to use in signingNo
:storepassStringpassword for keystore integrity. Must be at least 6 characters longYes.
:storetypeStringkeystore typeNo
:validityString(integer) indicates how many days certificate is validNo
:verboseboolean(true|false) verbose output when signingNo

Nested elements

  • :dname (DistinguishedName)

Reference

https://ant.apache.org/manual/Tasks/genkey.html

Defined by

org.apache.tools.ant.taskdefs.GenerateKey

Generates a key in a keystore.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:alias` | `String` | the alias to add under | Yes. |
| `:dname` | `String` | The distinguished name for entity | Yes unless <dname> element is specified |
| `:keyalg` | `String` | the method to use when generating name-value pair | No |
| `:keypass` | `String` | password for private key (if different) | No |
| `:keysize` | `String` | (integer) indicates the size of key generated | No |
| `:keystore` | `String` | keystore location | No |
| `:saname` | `String` | The subject alternative name for entity. Requires Java 7 or higher. | No |
| `:sigalg` | `String` | the algorithm to use in signing | No |
| `:storepass` | `String` | password for keystore integrity. Must be at least 6 characters long | Yes. |
| `:storetype` | `String` | keystore type | No |
| `:validity` | `String` | (integer) indicates how many days certificate is valid | No |
| `:verbose` | `boolean` | (true\|false) verbose output when signing | No |

**Nested elements**

- `:dname` (`DistinguishedName`)

**Reference**

https://ant.apache.org/manual/Tasks/genkey.html

**Defined by**

`org.apache.tools.ant.taskdefs.GenerateKey`
sourceraw docstring

getclj

(get & args)

Gets files from URLs. When the verbose option is on, this task displays a. for every 100 Kb retrieved. Any URL schema supported by the runtime is valid here, including http:, https:, ftp: and jar:. The usetimestamp option enables you to control downloads so that the remote file is only fetched if newer than the local copy. If there is no local copy, the download always takes place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp. Note: This timestamp facility only works on downloads using the HTTP protocol. A username and password can be specified, in which case basic ('slightly encoded plain text') authentication is used. This is only secure over an HTTPS link. Proxies. Since Apache Ant 1.7.0, Ant running on Java 5 or later can use the proxy settings of the operating system if enabled with the -autoproxy command line option. There is also the <setproxy> task for earlier Java versions. With proxies turned on, <get> requests against localhost may not work as expected, if the request is relayed to the proxy.

Attributes

AttributeTypeDescriptionRequired
:authenticateonredirectbooleanWhether the credentials should also be sent to the new location when a redirect is followed. since Ant 1.10.13No; default is false
:destFilethe file or directory where to store the retrieved file(s).Yes
:httpusecachesbooleanHTTP only-if true, allow caching at the HttpUrlConnection level, if false, turn caching off. Note this is only a hint to the underlying UrlConnection class, implementations and proxies are free to ignore the setting.No; default is true
:ignoreerrorsbooleanLog errors but don't treat as fatal.No; default is false
:maxtimelongMaximum time in seconds a single download may take, otherwise it will be interrupted and treated like a download error. Since Ant 1.8.0No; default is 0 which means unlimited
:passwordStringpassword for basic HTTP authenticationYes if username is set
:quietbooleanLog errors only.(true|false).No; default is false
:retriesintThe number of attempts to make for opening the URI. The name of the attribute is misleading as a value of 1 means "don't retry on error" and a value of 0 meant don't even try to reach the URI at all. since Ant 1.8.0No; default is 3
:skipexistingbooleanskip files that already exist on the local filesystem since Ant 1.8.0No; default is false
:srcURLthe URL from which to retrieve a file.Yes, or a nested resource collection
:trygzipencodingboolean
:useragentStringUser-Agent HTTP header to send. since Ant 1.9.3No; defaults to Apache Ant VERSION
:usernameStringusername for basic HTTP authenticationYes, if password is set
:usetimestampbooleanconditionally download a file based on the timestamp of the local copy. HTTP onlyNo; default is false
:verbosebooleanshow verbose progress information (on|off).No; default is off

Nested elements

  • :header (Header)
  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Tasks/get.html

Defined by

org.apache.tools.ant.taskdefs.Get

Gets files from URLs. When the verbose option is on, this task displays a. for every 100
Kb retrieved. Any URL schema supported by the runtime is valid here, including http:,
https:, ftp: and jar:. The usetimestamp option enables you to control downloads so that
the remote file is only fetched if newer than the local copy. If there is no local copy,
the download always takes place. When a file is downloaded, the timestamp of the
downloaded file is set to the remote timestamp. Note: This timestamp facility only works
on downloads using the HTTP protocol. A username and password can be specified, in which
case basic ('slightly encoded plain text') authentication is used. This is only secure
over an HTTPS link. Proxies. Since Apache Ant 1.7.0, Ant running on Java 5 or later can
use the proxy settings of the operating system if enabled with the -autoproxy command
line option. There is also the <setproxy> task for earlier Java versions. With proxies
turned on, <get> requests against localhost may not work as expected, if the request is
relayed to the proxy.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:authenticateonredirect` | `boolean` | Whether the credentials should also be sent to the new location when a redirect is followed. since Ant 1.10.13 | No; default is false |
| `:dest` | `File` | the file or directory where to store the retrieved file(s). | Yes |
| `:httpusecaches` | `boolean` | HTTP only-if true, allow caching at the HttpUrlConnection level, if false, turn caching off. Note this is only a hint to the underlying UrlConnection class, implementations and proxies are free to ignore the setting. | No; default is true |
| `:ignoreerrors` | `boolean` | Log errors but don't treat as fatal. | No; default is false |
| `:maxtime` | `long` | Maximum time in seconds a single download may take, otherwise it will be interrupted and treated like a download error. Since Ant 1.8.0 | No; default is 0 which means unlimited |
| `:password` | `String` | password for basic HTTP authentication | Yes if username is set |
| `:quiet` | `boolean` | Log errors only.(true\|false). | No; default is false |
| `:retries` | `int` | The number of attempts to make for opening the URI. The name of the attribute is misleading as a value of 1 means "don't retry on error" and a value of 0 meant don't even try to reach the URI at all. since Ant 1.8.0 | No; default is 3 |
| `:skipexisting` | `boolean` | skip files that already exist on the local filesystem since Ant 1.8.0 | No; default is false |
| `:src` | `URL` | the URL from which to retrieve a file. | Yes, or a nested resource collection |
| `:trygzipencoding` | `boolean` |  |  |
| `:useragent` | `String` | User-Agent HTTP header to send. since Ant 1.9.3 | No; defaults to Apache Ant VERSION |
| `:username` | `String` | username for basic HTTP authentication | Yes, if password is set |
| `:usetimestamp` | `boolean` | conditionally download a file based on the timestamp of the local copy. HTTP only | No; default is false |
| `:verbose` | `boolean` | show verbose progress information (on\|off). | No; default is off |

**Nested elements**

- `:header` (`Header`)
- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Tasks/get.html

**Defined by**

`org.apache.tools.ant.taskdefs.Get`
sourceraw docstring

globmapperclj

(globmapper & args)

Ant type globmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:fromString
:handledirsepboolean
:toString

Reference

https://ant.apache.org/manual/Types/globmapper.html

Defined by

org.apache.tools.ant.util.GlobPatternMapper

Ant type globmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:from` | `String` |  |  |
| `:handledirsep` | `boolean` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/globmapper.html

**Defined by**

`org.apache.tools.ant.util.GlobPatternMapper`
sourceraw docstring

grantclj

(grant & args)

Ant nested grant. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:actionsString
:classString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Permissions$Permission

Ant nested grant. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:actions` | `String` |  |  |
| `:class` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Permissions$Permission`
sourceraw docstring

groupclj

(group & args)

Ant nested group. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:packagesString
:titleString

Nested elements

  • :package (PackageName)
  • :title (Html)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$GroupArgument

Ant nested group. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:packages` | `String` |  |  |
| `:title` | `String` |  |  |

**Nested elements**

- `:package` (`PackageName`)
- `:title` (`Html`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$GroupArgument`
sourceraw docstring

gunzipclj

(gunzip & args)

Expands a resource packed using GZip, BZip2 or XZ. If dest is a directory the name of the destination file is the same as src (with the .gz, .bz2 or .xz extension removed if present). If dest is omitted, the parent dir of src is taken. The file is only expanded if the source resource is newer than the destination file, or when the destination file does not exist. XZ compression support has been added since Apache Ant 1.10.1 and depends on external libraries not included in the Ant distribution. See Library Dependencies for more information.

Attributes

AttributeTypeDescriptionRequired
:destFilethe destination file or directory.No
:srcFilethe file to expand.Yes, or a nested resource collection
:srcresourceResource

Reference

https://ant.apache.org/manual/Tasks/unpack.html

Defined by

org.apache.tools.ant.taskdefs.GUnzip

Expands a resource packed using GZip, BZip2 or XZ. If dest is a directory the name of
the destination file is the same as src (with the .gz, .bz2 or .xz extension removed if
present). If dest is omitted, the parent dir of src is taken. The file is only expanded
if the source resource is newer than the destination file, or when the destination file
does not exist. XZ compression support has been added since Apache Ant 1.10.1 and
depends on external libraries not included in the Ant distribution. See Library
Dependencies for more information.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dest` | `File` | the destination file or directory. | No |
| `:src` | `File` | the file to expand. | Yes, or a nested resource collection |
| `:srcresource` | `Resource` |  |  |

**Reference**

https://ant.apache.org/manual/Tasks/unpack.html

**Defined by**

`org.apache.tools.ant.taskdefs.GUnzip`
sourceraw docstring

gzipclj

(gzip & args)

Packs a resource using the GZip, BZip2 or XZ algorithm. The output file is only generated if it doesn't exist or the source resource is newer. XZ compression support has been added since Apache Ant 1.10.1 and depends on external libraries not included in the Ant distribution. See Library Dependencies for more information.

Attributes

AttributeTypeDescriptionRequired
:destfileFilethe destination file to create.Exactly one of the two
:srcFilethe file to gzip/bzip/xz.Yes, or a nested resource collection
:srcresourceResource
:zipfileFiledeprecated old name of destfile.Exactly one of the two

Reference

https://ant.apache.org/manual/Tasks/pack.html

Defined by

org.apache.tools.ant.taskdefs.GZip

Packs a resource using the GZip, BZip2 or XZ algorithm. The output file is only
generated if it doesn't exist or the source resource is newer. XZ compression support
has been added since Apache Ant 1.10.1 and depends on external libraries not included in
the Ant distribution. See Library Dependencies for more information.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:destfile` | `File` | the destination file to create. | Exactly one of the two |
| `:src` | `File` | the file to gzip/bzip/xz. | Yes, or a nested resource collection |
| `:srcresource` | `Resource` |  |  |
| `:zipfile` | `File` | deprecated old name of destfile. | Exactly one of the two |

**Reference**

https://ant.apache.org/manual/Tasks/pack.html

**Defined by**

`org.apache.tools.ant.taskdefs.GZip`
sourceraw docstring

gzipresourceclj

(gzipresource & args)

Ant type gzipresource. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:directoryboolean
:existsboolean
:lastmodifiedlong
:nameString
:refidReference
:sizelong

Reference

https://ant.apache.org/manual/Types/gzipresource.html

Defined by

org.apache.tools.ant.types.resources.GZipResource

Ant type gzipresource. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

https://ant.apache.org/manual/Types/gzipresource.html

**Defined by**

`org.apache.tools.ant.types.resources.GZipResource`
sourceraw docstring

handlerclj

(handler & args)

Ant nested handler. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:loaderrefReference
:refidString
:reverseloaderboolean
:typeHandlerType
:uriString

Nested elements

  • :classpath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Input$Handler

Ant nested handler. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:loaderref` | `Reference` |  |  |
| `:refid` | `String` |  |  |
| `:reverseloader` | `boolean` |  |  |
| `:type` | `HandlerType` |  |  |
| `:uri` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Input$Handler`
sourceraw docstring

(header & args)

Ant nested header. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:encodingString
:fileFile
:filteringboolean
:trimboolean
:trimleadingboolean

Body text

Accepts a free-form text body.

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.email.Header
  • org.apache.tools.ant.taskdefs.Javadoc$Html

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Concat$TextElement

Ant nested header. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:encoding` | `String` |  |  |
| `:file` | `File` |  |  |
| `:filtering` | `boolean` |  |  |
| `:trim` | `boolean` |  |  |
| `:trimleading` | `boolean` |  |  |

**Body text**

Accepts a free-form text body.

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.email.Header`
- `org.apache.tools.ant.taskdefs.Javadoc$Html`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Concat$TextElement`
sourceraw docstring

headerpathclj

(headerpath & args)

Ant nested headerpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested headerpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

headfilterclj

(headfilter & args)

Ant nested headfilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:lineslong
:skiplong

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.HeadFilter

Ant nested headfilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:lines` | `long` |  |  |
| `:skip` | `long` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.HeadFilter`
sourceraw docstring

hostinfoclj

(hostinfo & args)

Sets the NAME, DOMAIN, ADDR4, and ADDR6 properties in the current project. The NAME contains the host part of the canonical name of the host. If the host is not found, the host will contain the name as provided to the task, or localhost if no host was provided, and no name for the local host was found. The DOMAIN contains the domain part of the canonical name of the host. If the host is not found, the domain will contain the domain as provided to the task, or localdomain if no host / domain was provided. The ADDR4 contains the IPv4 address of the host with the widest meaning. If no IPv4 address is found and a host has been provided the address 0.0.0.0 is returned, when no host was provided the address 127.0.0.1 is returned. The ADDR6 contains the IPv6 address of the host with the widest meaning. If no IPv6 address is found and a host has been provided the address:: is returned, when no host was provided the address::1 is returned. These properties can be used in the build-file, for instance, to create host-stamped filenames, or used to replace placeholder tags inside documents to indicate, for example, the host where the build was performed on. The best place for this task is probably in an initialization target.

Attributes

AttributeTypeDescriptionRequired
:hostStringThe host to retrieve the information for.No; default is to retrieve information for the host the task is running on
:prefixStringPrefix used for all properties set.No; defaults to no prefix

Reference

https://ant.apache.org/manual/Tasks/hostinfo.html

Defined by

org.apache.tools.ant.taskdefs.HostInfo

Sets the NAME, DOMAIN, ADDR4, and ADDR6 properties in the current project. The NAME
contains the host part of the canonical name of the host. If the host is not found, the
host will contain the name as provided to the task, or localhost if no host was
provided, and no name for the local host was found. The DOMAIN contains the domain part
of the canonical name of the host. If the host is not found, the domain will contain the
domain as provided to the task, or localdomain if no host / domain was provided. The
ADDR4 contains the IPv4 address of the host with the widest meaning. If no IPv4 address
is found and a host has been provided the address 0.0.0.0 is returned, when no host was
provided the address 127.0.0.1 is returned. The ADDR6 contains the IPv6 address of the
host with the widest meaning. If no IPv6 address is found and a host has been provided
the address:: is returned, when no host was provided the address::1 is returned. These
properties can be used in the build-file, for instance, to create host-stamped
filenames, or used to replace placeholder tags inside documents to indicate, for
example, the host where the build was performed on. The best place for this task is
probably in an initialization target.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:host` | `String` | The host to retrieve the information for. | No; default is to retrieve information for the host the task is running on |
| `:prefix` | `String` | Prefix used for all properties set. | No; defaults to no prefix |

**Reference**

https://ant.apache.org/manual/Tasks/hostinfo.html

**Defined by**

`org.apache.tools.ant.taskdefs.HostInfo`
sourceraw docstring

httpclj

(http & args)

Ant nested http. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorsbeginatint
:followredirectsboolean
:readtimeoutint
:requestmethodString
:urlString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.Http

Ant nested http. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:errorsbeginat` | `int` |  |  |
| `:followredirects` | `boolean` |  |  |
| `:readtimeout` | `int` |  |  |
| `:requestmethod` | `String` |  |  |
| `:url` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.Http`
sourceraw docstring

identitymapperclj

(identitymapper & args)

Ant type identitymapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Reference

https://ant.apache.org/manual/Types/identitymapper.html

Defined by

org.apache.tools.ant.util.IdentityMapper

Ant type identitymapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/identitymapper.html

**Defined by**

`org.apache.tools.ant.util.IdentityMapper`
sourceraw docstring

ignoreblankclj

(ignoreblank & args)

Ant nested ignoreblank. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$IgnoreBlank

Ant nested ignoreblank. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$IgnoreBlank`
sourceraw docstring

implementationclasspathclj

(implementationclasspath & args)

Ant nested implementationclasspath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested implementationclasspath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

importclj

(import & args)

Imports another build file into the current project. On execution it will select the proper ProjectHelper to parse the imported file, using the same algorithm as the one executed at startup. The selected ProjectHelper instance will then be responsible to actually parse the imported file. Note as seen above, this task heavily relies on the ProjectHelper implementation and doesn't really perform any work of its own. If you have configured Apache Ant to use a ProjectHelper other than Ant's default, this task may or may not work. In the common use case where only Ant's default project helper is used, it basically works like the Entity Includes as explained in the Ant FAQ, as if the imported file was contained in the importing file, minus the top <project> tag. The import task may only be used as a top-level task. This means that it may not be used in a target. There are two further functional aspects that pertain to this task and that are not possible with entity includes: target overriding special properties Target overriding If a target in the main file is also present in at least one of the imported files, the one from the main file takes precedence. So if I import for example a docsbuild.xml file containing a project named builddocs that contains a docs target, I can define a docs target in my main buildfile and that is the one that will be called. This makes it easy to keep the same target name, so that the overriding target is still called by any other targets-in either the main or imported buildfile(s)-for which it is a dependency, with a different implementation. The target from docsbuild.xml is made available by the name builddocs.docs. This enables the new implementation to call the old target, thus enhancing it with tasks called before or after it. If you use the as attribute of the task, its value will be used to prefix the overridden target's name instead of the name attribute of the project tag. Special properties Imported files are treated as they are present in the main buildfile. This makes it easy to understand, but it makes it impossible for them to reference files and resources relative to their path. Because of this, for every imported file, Ant adds a property that contains the path to the imported buildfile. With this path, the imported buildfile can keep resources and be able to reference them relative to its position. So if I import for example a docsbuild.xml file named builddocs, I can get its path as ant.file.builddocs, similarly to the ant.file property of the main buildfile. Note that builddocs is not the filename, but the name attribute present in the imported project tag. If the imported file does not have a name attribute, the ant.file.projectname property will not be set. Since Ant 1.8.0, the task can also import resources from URLs or classpath resources (which are URLs, really). If you need to know whether the current build file's source has been a file or an URL you can consult the property ant.file.type.projectname (using the same example as above ant.file.type.builddocs) which either have the value file or url. Resolving files against the imported file Suppose your main build file called importing.xml imports a build file imported.xml, located anywhere on the file system, and imported.xml reads a set of properties from imported.properties: <!-- importing.xml --> <project name="importing" basedir="." default="..."> <import file="${path_to_imported}/imported.xml"/> </project> <!-- imported.xml --> <project name="imported" basedir="." default="..."> <property file="imported.properties"/> </project> This snippet however will resolve imported.properties against the basedir of importing.xml, because the basedir of imported.xml is ignored by Ant. The right way to use imported.properties is: <!-- imported.xml --> <project name="imported" basedir="." default="..."> <dirname property="imported.basedir" file="${ant.file.imported}"/> <property file="${imported.basedir}/imported.properties"/> </project> As explained above ant.file.imported stores the path of the build script, that defines the project called imported, (in short it stores the path to imported.xml) and <dirname> takes its directory. This technique also allows imported.xml to be used as a standalone file (without being imported in other project). The above description only works for imported files that actually are imported from files and not from URLs. For files imported from URLs using resources relative to the imported file requires you to use tasks that can work on non-file resources in the first place. To create a relative resource you'd use something like: <loadproperties> <url baseUrl="${ant.file.imported}" relativePath="imported.properties"/> </loadproperties>

Attributes

AttributeTypeDescriptionRequired
:asStringSpecifies the prefix prepended to the target names.No; defaults to name attribute of the project tag of the imported file
:fileStringThe file to import. If this is a relative file name, the file name will be resolved relative to the importing file. Note: this is unlike most other Ant file attributes, where relative files are resolved relative to basedir.Yes or a nested resource collection
:optionalbooleanIf true, do not stop the build if the file does not exist.No; default is false
:prefixseparatorStringSpecifies the separator to be used between the prefix and the target name.No; defaults to.

Reference

https://ant.apache.org/manual/Tasks/import.html

Defined by

org.apache.tools.ant.taskdefs.ImportTask

Imports another build file into the current project. On execution it will select the
proper ProjectHelper to parse the imported file, using the same algorithm as the one
executed at startup. The selected ProjectHelper instance will then be responsible to
actually parse the imported file. Note as seen above, this task heavily relies on the
ProjectHelper implementation and doesn't really perform any work of its own. If you have
configured Apache Ant to use a ProjectHelper other than Ant's default, this task may or
may not work. In the common use case where only Ant's default project helper is used, it
basically works like the Entity Includes as explained in the Ant FAQ, as if the imported
file was contained in the importing file, minus the top <project> tag. The import task
may only be used as a top-level task. This means that it may not be used in a target.
There are two further functional aspects that pertain to this task and that are not
possible with entity includes: target overriding special properties Target overriding If
a target in the main file is also present in at least one of the imported files, the one
from the main file takes precedence. So if I import for example a docsbuild.xml file
containing a project named builddocs that contains a docs target, I can define a docs
target in my main buildfile and that is the one that will be called. This makes it easy
to keep the same target name, so that the overriding target is still called by any other
targets-in either the main or imported buildfile(s)-for which it is a dependency, with a
different implementation. The target from docsbuild.xml is made available by the name
builddocs.docs. This enables the new implementation to call the old target, thus
enhancing it with tasks called before or after it. If you use the as attribute of the
task, its value will be used to prefix the overridden target's name instead of the name
attribute of the project tag. Special properties Imported files are treated as they are
present in the main buildfile. This makes it easy to understand, but it makes it
impossible for them to reference files and resources relative to their path. Because of
this, for every imported file, Ant adds a property that contains the path to the
imported buildfile. With this path, the imported buildfile can keep resources and be
able to reference them relative to its position. So if I import for example a
docsbuild.xml file named builddocs, I can get its path as ant.file.builddocs, similarly
to the ant.file property of the main buildfile. Note that builddocs is not the filename,
but the name attribute present in the imported project tag. If the imported file does
not have a name attribute, the ant.file.projectname property will not be set. Since Ant
1.8.0, the task can also import resources from URLs or classpath resources (which are
URLs, really). If you need to know whether the current build file's source has been a
file or an URL you can consult the property ant.file.type.projectname (using the same
example as above ant.file.type.builddocs) which either have the value file or url.
Resolving files against the imported file Suppose your main build file called
importing.xml imports a build file imported.xml, located anywhere on the file system,
and imported.xml reads a set of properties from imported.properties: <!-- importing.xml
--> <project name="importing" basedir="." default="..."> <import
file="${path_to_imported}/imported.xml"/> </project> <!-- imported.xml --> <project
name="imported" basedir="." default="..."> <property file="imported.properties"/>
</project> This snippet however will resolve imported.properties against the basedir of
importing.xml, because the basedir of imported.xml is ignored by Ant. The right way to
use imported.properties is: <!-- imported.xml --> <project name="imported" basedir="."
default="..."> <dirname property="imported.basedir" file="${ant.file.imported}"/>
<property file="${imported.basedir}/imported.properties"/> </project> As explained above
ant.file.imported stores the path of the build script, that defines the project called
imported, (in short it stores the path to imported.xml) and <dirname> takes its
directory. This technique also allows imported.xml to be used as a standalone file
(without being imported in other project). The above description only works for imported
files that actually are imported from files and not from URLs. For files imported from
URLs using resources relative to the imported file requires you to use tasks that can
work on non-file resources in the first place. To create a relative resource you'd use
something like: <loadproperties> <url baseUrl="${ant.file.imported}"
relativePath="imported.properties"/> </loadproperties>

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:as` | `String` | Specifies the prefix prepended to the target names. | No; defaults to name attribute of the project tag of the imported file |
| `:file` | `String` | The file to import. If this is a relative file name, the file name will be resolved relative to the importing file. Note: this is unlike most other Ant file attributes, where relative files are resolved relative to basedir. | Yes or a nested resource collection |
| `:optional` | `boolean` | If true, do not stop the build if the file does not exist. | No; default is false |
| `:prefixseparator` | `String` | Specifies the separator to be used between the prefix and the target name. | No; defaults to. |

**Reference**

https://ant.apache.org/manual/Tasks/import.html

**Defined by**

`org.apache.tools.ant.taskdefs.ImportTask`
sourceraw docstring

includeclj

(include & args)

Include another build file into the current project. Note this task heavily relies on the ProjectHelper implementation and doesn't really perform any work of its own. If you have configured Ant to use a ProjectHelper other than Ant's default, this task may or may not work. On execution it will read another Ant file into the same project rewriting the included target names and depends lists. This is different from Entity Includes as explained in the Ant FAQ insofar as the target names get prefixed by the included project's name or as attribute and do not appear as if the file was contained in the including file. The include task may only be used as a top-level task. This means that it may not be used in a target. There are two further functional aspects that pertain to this task and that are not possible with entity includes: target rewriting special properties Target rewriting Any target in the included file will be renamed to prefix.name where name is the original target's name and prefix is either the value of the as attribute or the name attribute of the project tag of the included file. The depends attribute of all included targets is rewritten so that all target names are prefixed as well. This makes the included file self-contained. Note that prefixes nest, so if a build file includes a file with prefix q and the included file includes another file with prefix b, then the targets of that last build file will be prefixed by a.b.. <import> contribute to the prefix as well, but only if their as attribute has been specified. Special properties Included files are treated as they are present in the main buildfile. This makes it easy to understand, but it makes it impossible for them to reference files and resources relative to their path. Because of this, for every included file, Ant adds a property that contains the path to the included buildfile. With this path, the included buildfile can keep resources and be able to reference them relative to its position. So if I include for example a docsbuild.xml file named builddocs, I can get its path as ant.file.builddocs, similarly to the ant.file property of the main buildfile. Note that builddocs is not the filename, but the name attribute present in the included project tag. If the included file does not have a name attribute, the ant.file.projectname property will not be set. If you need to know whether the current build file's source has been a file or an URL you can consult the property ant.file.type.projectname (using the same example as above ant.file.type.builddocs) which either have the value file or url. Resolving files against the included file Suppose your main build file called including.xml includes a build file included.xml, located anywhere on the file system, and included.xml reads a set of properties from included.properties: <!-- including.xml --> <project name="including" basedir="." default="..."> <include file="${path_to_included}/included.xml"/> </project> <!-- included.xml --> <project name="included" basedir="." default="..."> <property file="included.properties"/> </project> This snippet however will resolve included.properties against the basedir of including.xml, because the basedir of included.xml is ignored by Ant. The right way to use included.properties is: <!-- included.xml --> <project name="included" basedir="." default="..."> <dirname property="included.basedir" file="${ant.file.included}"/> <property file="${included.basedir}/included.properties"/> </project> As explained above ant.file.included stores the path of the build script, that defines the project called included, (in short it stores the path to included.xml) and <dirname> takes its directory. This technique also allows included.xml to be used as a standalone file (without being included in other project). The above description only works for included files that actually are included from files and not from URLs. For files included from URLs using resources relative to the included file requires you to use tasks that can work on non-file resources in the first place. To create a relative resource you'd use something like: <loadproperties> <url baseUrl="${ant.file.included}" relativePath="included.properties"/> </loadproperties>

Attributes

AttributeTypeDescriptionRequired
:asStringSpecifies the prefix prepended to the target names.Yes, if the included file's project tag doesn't specify a name attribute (which is otherwise taken as default)
:fileStringThe file to include. If this is a relative file name, the file name will be resolved relative to the including file. Note, this is unlike most other ant file attributes, where relative files are resolved relative to ${basedir}.Yes or a nested resource collection
:optionalbooleanIf true, do not stop the build if the file does not exist.No; default is false
:prefixseparatorStringSpecifies the separator to be used between the prefix and the target name.No; defaults to.

Reference

https://ant.apache.org/manual/Tasks/include.html

Defined by

org.apache.tools.ant.taskdefs.ImportTask

Include another build file into the current project. Note this task heavily relies on
the ProjectHelper implementation and doesn't really perform any work of its own. If you
have configured Ant to use a ProjectHelper other than Ant's default, this task may or
may not work. On execution it will read another Ant file into the same project rewriting
the included target names and depends lists. This is different from Entity Includes as
explained in the Ant FAQ insofar as the target names get prefixed by the included
project's name or as attribute and do not appear as if the file was contained in the
including file. The include task may only be used as a top-level task. This means that
it may not be used in a target. There are two further functional aspects that pertain to
this task and that are not possible with entity includes: target rewriting special
properties Target rewriting Any target in the included file will be renamed to
prefix.name where name is the original target's name and prefix is either the value of
the as attribute or the name attribute of the project tag of the included file. The
depends attribute of all included targets is rewritten so that all target names are
prefixed as well. This makes the included file self-contained. Note that prefixes nest,
so if a build file includes a file with prefix q and the included file includes another
file with prefix b, then the targets of that last build file will be prefixed by a.b..
<import> contribute to the prefix as well, but only if their as attribute has been
specified. Special properties Included files are treated as they are present in the main
buildfile. This makes it easy to understand, but it makes it impossible for them to
reference files and resources relative to their path. Because of this, for every
included file, Ant adds a property that contains the path to the included buildfile.
With this path, the included buildfile can keep resources and be able to reference them
relative to its position. So if I include for example a docsbuild.xml file named
builddocs, I can get its path as ant.file.builddocs, similarly to the ant.file property
of the main buildfile. Note that builddocs is not the filename, but the name attribute
present in the included project tag. If the included file does not have a name
attribute, the ant.file.projectname property will not be set. If you need to know
whether the current build file's source has been a file or an URL you can consult the
property ant.file.type.projectname (using the same example as above
ant.file.type.builddocs) which either have the value file or url. Resolving files
against the included file Suppose your main build file called including.xml includes a
build file included.xml, located anywhere on the file system, and included.xml reads a
set of properties from included.properties: <!-- including.xml --> <project
name="including" basedir="." default="..."> <include
file="${path_to_included}/included.xml"/> </project> <!-- included.xml --> <project
name="included" basedir="." default="..."> <property file="included.properties"/>
</project> This snippet however will resolve included.properties against the basedir of
including.xml, because the basedir of included.xml is ignored by Ant. The right way to
use included.properties is: <!-- included.xml --> <project name="included" basedir="."
default="..."> <dirname property="included.basedir" file="${ant.file.included}"/>
<property file="${included.basedir}/included.properties"/> </project> As explained above
ant.file.included stores the path of the build script, that defines the project called
included, (in short it stores the path to included.xml) and <dirname> takes its
directory. This technique also allows included.xml to be used as a standalone file
(without being included in other project). The above description only works for included
files that actually are included from files and not from URLs. For files included from
URLs using resources relative to the included file requires you to use tasks that can
work on non-file resources in the first place. To create a relative resource you'd use
something like: <loadproperties> <url baseUrl="${ant.file.included}"
relativePath="included.properties"/> </loadproperties>

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:as` | `String` | Specifies the prefix prepended to the target names. | Yes, if the included file's project tag doesn't specify a name attribute (which is otherwise taken as default) |
| `:file` | `String` | The file to include. If this is a relative file name, the file name will be resolved relative to the including file. Note, this is unlike most other ant file attributes, where relative files are resolved relative to ${basedir}. | Yes or a nested resource collection |
| `:optional` | `boolean` | If true, do not stop the build if the file does not exist. | No; default is false |
| `:prefixseparator` | `String` | Specifies the separator to be used between the prefix and the target name. | No; defaults to. |

**Reference**

https://ant.apache.org/manual/Tasks/include.html

**Defined by**

`org.apache.tools.ant.taskdefs.ImportTask`
sourceraw docstring

includesfileclj

(includesfile & args)

Ant nested includesfile. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:ifObject
:nameString
:unlessObject

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PatternSet$NameEntry

Ant nested includesfile. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:if` | `Object` |  |  |
| `:name` | `String` |  |  |
| `:unless` | `Object` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PatternSet$NameEntry`
sourceraw docstring

indexjarsclj

(indexjars & args)

Ant nested indexjars. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested indexjars. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

indexjarsmapperclj

(indexjarsmapper & args)

Ant nested indexjarsmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:fromString
:refidReference
:toString
:typeMapperType

Nested elements

  • :classpath (Path)
  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Mapper

Ant nested indexjarsmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:from` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:to` | `String` |  |  |
| `:type` | `MapperType` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Mapper`
sourceraw docstring

inputclj

(input & args)

Allows user interaction during the build process by prompting for input. To do so, it uses the configured InputHandler. The prompt can be set via the message attribute or as character data nested into the element. Optionally a set of valid input arguments can be defined via the validargs attribute. Input task will not accept a value that doesn't match one of the predefined. Optionally a property can be created from the value entered by the user. This property can then be used during the following build run. Input then behaves as property task which means that existing properties cannot be overridden. Since Apache Ant 1.6, <input> will not prompt for input if a property should be set by the task that has already been set in the project (and the task wouldn't have any effect). Historically, a regular complaint about this task has been that it echoes characters to the console, this is a critical security defect, we must fix it immediately, etc, etc. This problem was due to the lack in early versions of Java of a (fully functional) facility for handling secure console input. In Java 6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 and 1.8 have added support for Java 6 secure console input feature (see handler type). IDE behaviour depends upon the IDE: some hang waiting for input, some let you type it in. For this situation, place the password in a (secured) property file and load in before the input task.

Attributes

AttributeTypeDescriptionRequired
:addpropertyStringthe name of a property to be created from input. Behaviour is equal to property task which means that existing properties cannot be overridden.No
:defaultvalueStringDefines the default value of the property to be created from input. Property value will be set to default if no input is received.No
:messageStringthe Message which gets displayed to the user during the build run.No
:validargsStringcomma separated String containing valid input arguments. If set, input task will reject any input not defined here. Comparison of input to validargs is case sensitive. If you want a and A to be accepted you will need to define both arguments within validargs.No

Nested elements

  • :handler (Handler)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/input.html

Defined by

org.apache.tools.ant.taskdefs.Input

Allows user interaction during the build process by prompting for input. To do so, it
uses the configured InputHandler. The prompt can be set via the message attribute or as
character data nested into the element. Optionally a set of valid input arguments can be
defined via the validargs attribute. Input task will not accept a value that doesn't
match one of the predefined. Optionally a property can be created from the value entered
by the user. This property can then be used during the following build run. Input then
behaves as property task which means that existing properties cannot be overridden.
Since Apache Ant 1.6, <input> will not prompt for input if a property should be set by
the task that has already been set in the project (and the task wouldn't have any
effect). Historically, a regular complaint about this task has been that it echoes
characters to the console, this is a critical security defect, we must fix it
immediately, etc, etc. This problem was due to the lack in early versions of Java of a
(fully functional) facility for handling secure console input. In Java 6 that
shortcoming in Java's API was addressed and Ant versions 1.7.1 and 1.8 have added
support for Java 6 secure console input feature (see handler type). IDE behaviour
depends upon the IDE: some hang waiting for input, some let you type it in. For this
situation, place the password in a (secured) property file and load in before the input
task.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addproperty` | `String` | the name of a property to be created from input. Behaviour is equal to property task which means that existing properties cannot be overridden. | No |
| `:defaultvalue` | `String` | Defines the default value of the property to be created from input. Property value will be set to default if no input is received. | No |
| `:message` | `String` | the Message which gets displayed to the user during the build run. | No |
| `:validargs` | `String` | comma separated String containing valid input arguments. If set, input task will reject any input not defined here. Comparison of input to validargs is case sensitive. If you want a and A to be accepted you will need to define both arguments within validargs. | No |

**Nested elements**

- `:handler` (`Handler`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/input.html

**Defined by**

`org.apache.tools.ant.taskdefs.Input`
sourceraw docstring

inputfilterchainclj

(inputfilterchain & args)

Ant nested inputfilterchain. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :classconstants (ClassConstants)
  • :containsregex (ContainsRegex)
  • :deletecharacters (DeleteCharacters)
  • :escapeunicode (EscapeUnicode)
  • :expandproperties (ExpandProperties)
  • :filterreader (AntFilterReader)
  • :headfilter (HeadFilter)
  • :ignoreblank (IgnoreBlank)
  • :linecontains (LineContains)
  • :linecontainsregexp (LineContainsRegExp)
  • :prefixlines (PrefixLines)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :replacetokens (ReplaceTokens)
  • :stripjavacomments (StripJavaComments)
  • :striplinebreaks (StripLineBreaks)
  • :striplinecomments (StripLineComments)
  • :suffixlines (SuffixLines)
  • :tabstospaces (TabsToSpaces)
  • :tailfilter (TailFilter)
  • :tokenfilter (TokenFilter)
  • :trim (Trim)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FilterChain

Ant nested inputfilterchain. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classconstants` (`ClassConstants`)
- `:containsregex` (`ContainsRegex`)
- `:deletecharacters` (`DeleteCharacters`)
- `:escapeunicode` (`EscapeUnicode`)
- `:expandproperties` (`ExpandProperties`)
- `:filterreader` (`AntFilterReader`)
- `:headfilter` (`HeadFilter`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linecontains` (`LineContains`)
- `:linecontainsregexp` (`LineContainsRegExp`)
- `:prefixlines` (`PrefixLines`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:replacetokens` (`ReplaceTokens`)
- `:stripjavacomments` (`StripJavaComments`)
- `:striplinebreaks` (`StripLineBreaks`)
- `:striplinecomments` (`StripLineComments`)
- `:suffixlines` (`SuffixLines`)
- `:tabstospaces` (`TabsToSpaces`)
- `:tailfilter` (`TailFilter`)
- `:tokenfilter` (`TokenFilter`)
- `:trim` (`Trim`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FilterChain`
sourceraw docstring

inputmapperclj

(inputmapper & args)

Ant nested inputmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:fromString
:refidReference
:toString
:typeMapperType

Nested elements

  • :classpath (Path)
  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Mapper

Ant nested inputmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:from` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:to` | `String` |  |  |
| `:type` | `MapperType` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Mapper`
sourceraw docstring

intersectclj

(intersect & args)

Ant type intersect. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

https://ant.apache.org/manual/Types/intersect.html

Defined by

org.apache.tools.ant.types.resources.Intersect

Ant type intersect. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/intersect.html

**Defined by**

`org.apache.tools.ant.types.resources.Intersect`
sourceraw docstring

invertclj

(invert & args)

Ant nested invert. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:excludesString
:excludesfileFile
:includesString
:includesfileFile
:refidReference

Nested elements

  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :invert (PatternSet)
  • :patternset (PatternSet)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PatternSet

Ant nested invert. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:invert` (`PatternSet`)
- `:patternset` (`PatternSet`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PatternSet`
sourceraw docstring

iplanetclj

(iplanet & args)

Ant nested iplanet. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:debugboolean
:destdirFile
:genericjarsuffixString
:iashomeFile
:keepgeneratedboolean
:suffixString

Nested elements

  • :classpath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool

Ant nested iplanet. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:debug` | `boolean` |  |  |
| `:destdir` | `File` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:iashome` | `File` |  |  |
| `:keepgenerated` | `boolean` |  |  |
| `:suffix` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool`
sourceraw docstring

iplanet-ejbcclj

(iplanet-ejbc & args)

Task to compile EJB stubs and skeletons for the iPlanet Application Server 6.0. Given a standard EJB 1.1 XML descriptor as well as an iAS-specific EJB descriptor, this task will generate the stubs and skeletons required to deploy the EJB to iAS. Since the XML descriptors can include multiple EJBs, this is a convenient way of specifying many EJBs in a single Ant task. For each EJB specified, the task will locate the three classes that comprise the EJB in the destination directory. If these class files cannot be located in the destination directory, the task will fail. The task will also attempt to locate the EJB stubs and skeletons in this directory. If found, the timestamps on the stubs and skeletons will be checked to ensure they are up to date. Only if these files cannot be found or if they are out of date will the iAS ejbc utility be called to generate new stubs and skeletons.

Attributes

AttributeTypeDescriptionRequired
:classpathPathThe classpath used when generating EJB stubs and skeletons. Nested classpath elements may also be used.No; defaults to the classpath specified when Ant was started
:debugbooleanIndicates whether or not the ejbc utility should log additional debugging statements to the standard output. If yes, the additional debugging statements will be generated.No; defaults to no
:destFileThe is the base directory where the RMI stubs and skeletons are written. In addition, the class files for each bean (home interface, remote interface, and EJB implementation) must be found in this directory.Yes
:ejbdescriptorFileStandard EJB 1.1 XML descriptor (typically titled ejb-jar.xml).Yes
:iasdescriptorFileiAS-specific EJB XML descriptor (typically titled ias-ejb-jar.xml).Yes
:iashomeFileMay be used to specify the "home" directory for this iAS installation. This is used to find the ejbc utility if it isn't included in the user's system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias directory.No; by default the ejbc utility must be on the user's system path
:keepgeneratedbooleanIndicates whether or not the Java source files which are generated by ejbc will be saved or automatically deleted. If yes, the source files will be retained.No; defaults to no

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/ejb.html#iplanet-ejbc

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask

Task to compile EJB stubs and skeletons for the iPlanet Application Server 6.0. Given a
standard EJB 1.1 XML descriptor as well as an iAS-specific EJB descriptor, this task
will generate the stubs and skeletons required to deploy the EJB to iAS. Since the XML
descriptors can include multiple EJBs, this is a convenient way of specifying many EJBs
in a single Ant task. For each EJB specified, the task will locate the three classes
that comprise the EJB in the destination directory. If these class files cannot be
located in the destination directory, the task will fail. The task will also attempt to
locate the EJB stubs and skeletons in this directory. If found, the timestamps on the
stubs and skeletons will be checked to ensure they are up to date. Only if these files
cannot be found or if they are out of date will the iAS ejbc utility be called to
generate new stubs and skeletons.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` | The classpath used when generating EJB stubs and skeletons. Nested classpath elements may also be used. | No; defaults to the classpath specified when Ant was started |
| `:debug` | `boolean` | Indicates whether or not the ejbc utility should log additional debugging statements to the standard output. If yes, the additional debugging statements will be generated. | No; defaults to no |
| `:dest` | `File` | The is the base directory where the RMI stubs and skeletons are written. In addition, the class files for each bean (home interface, remote interface, and EJB implementation) must be found in this directory. | Yes |
| `:ejbdescriptor` | `File` | Standard EJB 1.1 XML descriptor (typically titled ejb-jar.xml). | Yes |
| `:iasdescriptor` | `File` | iAS-specific EJB XML descriptor (typically titled ias-ejb-jar.xml). | Yes |
| `:iashome` | `File` | May be used to specify the "home" directory for this iAS installation. This is used to find the ejbc utility if it isn't included in the user's system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias directory. | No; by default the ejbc utility must be on the user's system path |
| `:keepgenerated` | `boolean` | Indicates whether or not the Java source files which are generated by ejbc will be saved or automatically deleted. If yes, the source files will be retained. | No; defaults to no |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/ejb.html#iplanet-ejbc

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask`
sourceraw docstring

isfalseclj

(isfalse & args)

Ant nested isfalse. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:valueboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.IsFalse

Ant nested isfalse. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:value` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.IsFalse`
sourceraw docstring

isfileselectedclj

(isfileselected & args)

Ant type isfileselected. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile
:fileFile
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/isfileselected.html

Defined by

org.apache.tools.ant.taskdefs.condition.IsFileSelected

Ant type isfileselected. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |
| `:file` | `File` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/isfileselected.html

**Defined by**

`org.apache.tools.ant.taskdefs.condition.IsFileSelected`
sourceraw docstring

isreferenceclj

(isreference & args)

Ant nested isreference. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference
:typeString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.IsReference

Ant nested isreference. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |
| `:type` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.IsReference`
sourceraw docstring

issetclj

(isset & args)

Ant nested isset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:propertyString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.IsSet

Ant nested isset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:property` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.IsSet`
sourceraw docstring

istrueclj

(istrue & args)

Ant nested istrue. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:valueboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.IsTrue

Ant nested istrue. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:value` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.IsTrue`
sourceraw docstring

jarclj

(jar & args)

Jars a set of files. The basedir attribute is the reference directory from where to jar. Note that file permissions will not be stored in the resulting jarfile. It is possible to refine the set of files that are being jarred. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements. You can also use nested file sets for more flexibility, and specify multiple ones to merge together different trees of files into one JAR. The extended fileset and groupfileset child elements from the zip task are also available in the jar task. See the Zip task for more details and examples. The update parameter controls what happens if the JAR file already exists. When set to yes, the JAR file is updated with the files specified. When set to no (the default) the JAR file is overwritten. An example use of this is provided in the Zip task documentation. Please note that ZIP files store file modification times with a granularity of 2 seconds. If a file is less than 2 seconds newer than the entry in the archive, Ant will not consider it newer. If the manifest is omitted, a simple one will be supplied by Apache Ant. The whenmanifestonly parameter controls what happens when no files, apart from the manifest file, or nested services, match. If skip, the JAR is not created and a warning is issued. If fail, the JAR is not created and the build is halted with an error. If create (default), an empty JAR file (only containing a manifest and services) is created. (The Jar task has a shortcut for specifying the manifest file of a JAR file. The same thing can be accomplished by using the fullpath attribute of a zipfileset in a Zip task. The one difference is that if the manifest attribute is not specified, the Jar task will include an empty one for you.) Manifests are processed by the Jar task according to the Jar file specification. Note in particular that this may result in manifest lines greater than 72 bytes being wrapped and continued on the next line. The Jar task checks whether you specified package information according to the versioning specification. Please note that the ZIP format allows multiple files of the same fully-qualified name to exist within a single archive. This has been documented as causing various problems for unsuspecting users. If you wish to avoid this behavior you must set the duplicate attribute to a value other than its default, add. To cryptographically sign your JAR file, use the SignJar task on the JAR that you create from this task. For creating a simple version of a JEP 238 multi-release jar, you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see in the JEP 238 example. If you want to tune this kind of jar, e.g. decreasing the size by deleting 'same' classes from the versions-branches, you have to do more ...

Attributes

AttributeTypeDescriptionRequired
:basedirFilethe directory from which to jar the files.No
:casesensitiveboolean
:commentString
:compressbooleanNot only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating.No; defaults to true
:createunicodeextrafieldsUnicodeExtraFieldWhether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot. See also the discussion in the zip task pageNo; defaults to never
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no)No; defaults to yes
:destfileFilethe JAR file to create.Yes
:duplicateDuplicatebehavior when a duplicate file is found. Valid values are add, preserve, and fail.No; defaults to add
:encodingStringThe character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task pageNo; defaults to UTF8
:excludesStringcomma- or space-separated list of patterns of files that must be excludedNo; defaults to default excludes or none if defaultexcludes is no
:excludesfileFileName of a file. Each line of this file is taken to be an exclude patternNo
:fallbacktoutf8booleanWhether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task pageNo; defaults to false
:fileFile
:filesetmanifestFilesetManifestConfigbehavior when a manifest is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests.No; defaults to skip
:filesonlybooleanStore only file entriesNo; defaults to false
:flattenattributesbooleanWhether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0.No; defaults to false
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be includedNo; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:indexbooleanwhether to create an index list to speed up classloading. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index.No; defaults to false
:indexmetainfbooleanwhether to include META-INF and its children in the index. Doesn't have any effect if index is false. Sun's jar implementation used to skip the META-INF directory and Ant followed that example. The behavior has been changed with Java 5. In order to avoid problems with Ant generated jars on Java 1.4 or earlier Ant will not include META-INF unless explicitly asked to. Since Ant 1.8.0No; defaults to false
:jarfileFile
:keepcompressionbooleanFor entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6No; defaults to false
:levelintNon-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7No
:manifestFilethe manifest file to use. This can be either the location of a manifest, or the name of a jar added through a fileset. If its the name of an added jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MFNo
:manifestencodingStringThe encoding used to read the JAR manifest, when a manifest file is specified. The task will always use UTF-8 when writing the manifest.No; defaults to default JVM character encoding
:mergeclasspathattributesbooleanWhether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true, this may result in manifests containing multiple Class-Path attributes which violates the manifest specification.No; defaults to false
:modificationtimeStringSet all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2.No
:preserve0permissionsbooleanwhen updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. since Ant 1.8.0No; defaults to false
:roundupbooleanWhether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2No; defaults to true
:strictStrictModeConfigures how to handle breaks of the packaging version specification: fail = throws a BuildException warn = logs a message on warn level ignore = logs a message on verbose level (default) Since Ant 1.7.1No; defaults to ignore
:updatebooleanindicates whether to update or overwrite the destination file if it already existsNo; defaults to false
:uselanguageencodingflagbooleanWhether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task pageNo; defaults to true
:whenemptyWhenEmpty
:whenmanifestonlyWhenEmptybehavior when no files match. Valid values are fail, skip, and create.No; defaults to create
:zip64modeZip64ModeAttributeWhen to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task pageNo; defaults to never
:zipfileFile

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :indexjars (Path)
  • :indexjarsmapper (Mapper)
  • :majority (MajoritySelector)
  • :manifest (Manifest)
  • :metainf (ZipFileSet)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :service (Service)
  • :size (SizeSelector)
  • :type (TypeSelector)
  • :zipfileset (ZipFileSet)
  • :zipgroupfileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/jar.html

Defined by

org.apache.tools.ant.taskdefs.Jar

Jars a set of files. The basedir attribute is the reference directory from where to jar.
Note that file permissions will not be stored in the resulting jarfile. It is possible
to refine the set of files that are being jarred. This can be done with the includes,
includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes
or includesfile attribute you specify the files you want to have included by using
patterns. The exclude or excludesfile attribute is used to specify the files you want to
have excluded. This is also done with patterns. And finally with the defaultexcludes
attribute, you can specify whether you want to use default exclusions or not. See the
section on directory based tasks, on how the inclusion/exclusion of files works, and how
to write patterns. This task forms an implicit FileSet and supports most attributes of
<fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and
<patternset> elements. You can also use nested file sets for more flexibility, and
specify multiple ones to merge together different trees of files into one JAR. The
extended fileset and groupfileset child elements from the zip task are also available in
the jar task. See the Zip task for more details and examples. The update parameter
controls what happens if the JAR file already exists. When set to yes, the JAR file is
updated with the files specified. When set to no (the default) the JAR file is
overwritten. An example use of this is provided in the Zip task documentation. Please
note that ZIP files store file modification times with a granularity of 2 seconds. If a
file is less than 2 seconds newer than the entry in the archive, Ant will not consider
it newer. If the manifest is omitted, a simple one will be supplied by Apache Ant. The
whenmanifestonly parameter controls what happens when no files, apart from the manifest
file, or nested services, match. If skip, the JAR is not created and a warning is
issued. If fail, the JAR is not created and the build is halted with an error. If create
(default), an empty JAR file (only containing a manifest and services) is created. (The
Jar task has a shortcut for specifying the manifest file of a JAR file. The same thing
can be accomplished by using the fullpath attribute of a zipfileset in a Zip task. The
one difference is that if the manifest attribute is not specified, the Jar task will
include an empty one for you.) Manifests are processed by the Jar task according to the
Jar file specification. Note in particular that this may result in manifest lines
greater than 72 bytes being wrapped and continued on the next line. The Jar task checks
whether you specified package information according to the versioning specification.
Please note that the ZIP format allows multiple files of the same fully-qualified name
to exist within a single archive. This has been documented as causing various problems
for unsuspecting users. If you wish to avoid this behavior you must set the duplicate
attribute to a value other than its default, add. To cryptographically sign your JAR
file, use the SignJar task on the JAR that you create from this task. For creating a
simple version of a JEP 238 multi-release jar, you don't need any special tools. Just
set the required manifest entry and place the files where required, as you could see in
the JEP 238 example. If you want to tune this kind of jar, e.g. decreasing the size by
deleting 'same' classes from the versions-branches, you have to do more ...

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | the directory from which to jar the files. | No |
| `:casesensitive` | `boolean` |  |  |
| `:comment` | `String` |  |  |
| `:compress` | `boolean` | Not only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating. | No; defaults to true |
| `:createunicodeextrafields` | `UnicodeExtraField` | Whether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot. See also the discussion in the zip task page | No; defaults to never |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no) | No; defaults to yes |
| `:destfile` | `File` | the JAR file to create. | Yes |
| `:duplicate` | `Duplicate` | behavior when a duplicate file is found. Valid values are add, preserve, and fail. | No; defaults to add |
| `:encoding` | `String` | The character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task page | No; defaults to UTF8 |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | Name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:fallbacktoutf8` | `boolean` | Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task page | No; defaults to false |
| `:file` | `File` |  |  |
| `:filesetmanifest` | `FilesetManifestConfig` | behavior when a manifest is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests. | No; defaults to skip |
| `:filesonly` | `boolean` | Store only file entries | No; defaults to false |
| `:flattenattributes` | `boolean` | Whether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0. | No; defaults to false |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:index` | `boolean` | whether to create an index list to speed up classloading. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index. | No; defaults to false |
| `:indexmetainf` | `boolean` | whether to include META-INF and its children in the index. Doesn't have any effect if index is false. Sun's jar implementation used to skip the META-INF directory and Ant followed that example. The behavior has been changed with Java 5. In order to avoid problems with Ant generated jars on Java 1.4 or earlier Ant will not include META-INF unless explicitly asked to. Since Ant 1.8.0 | No; defaults to false |
| `:jarfile` | `File` |  |  |
| `:keepcompression` | `boolean` | For entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6 | No; defaults to false |
| `:level` | `int` | Non-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7 | No |
| `:manifest` | `File` | the manifest file to use. This can be either the location of a manifest, or the name of a jar added through a fileset. If its the name of an added jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF | No |
| `:manifestencoding` | `String` | The encoding used to read the JAR manifest, when a manifest file is specified. The task will always use UTF-8 when writing the manifest. | No; defaults to default JVM character encoding |
| `:mergeclasspathattributes` | `boolean` | Whether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true, this may result in manifests containing multiple Class-Path attributes which violates the manifest specification. | No; defaults to false |
| `:modificationtime` | `String` | Set all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2. | No |
| `:preserve0permissions` | `boolean` | when updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. since Ant 1.8.0 | No; defaults to false |
| `:roundup` | `boolean` | Whether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2 | No; defaults to true |
| `:strict` | `StrictMode` | Configures how to handle breaks of the packaging version specification: fail = throws a BuildException warn = logs a message on warn level ignore = logs a message on verbose level (default) Since Ant 1.7.1 | No; defaults to ignore |
| `:update` | `boolean` | indicates whether to update or overwrite the destination file if it already exists | No; defaults to false |
| `:uselanguageencodingflag` | `boolean` | Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task page | No; defaults to true |
| `:whenempty` | `WhenEmpty` |  |  |
| `:whenmanifestonly` | `WhenEmpty` | behavior when no files match. Valid values are fail, skip, and create. | No; defaults to create |
| `:zip64mode` | `Zip64ModeAttribute` | When to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task page | No; defaults to never |
| `:zipfile` | `File` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:indexjars` (`Path`)
- `:indexjarsmapper` (`Mapper`)
- `:majority` (`MajoritySelector`)
- `:manifest` (`Manifest`)
- `:metainf` (`ZipFileSet`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:service` (`Service`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)
- `:zipfileset` (`ZipFileSet`)
- `:zipgroupfileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/jar.html

**Defined by**

`org.apache.tools.ant.taskdefs.Jar`
sourceraw docstring

jarlib-availableclj

(jarlib-available & args)

Check whether an extension is present in a fileset or an extensionSet. If the extension is present then a property is set. Note that this task works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or the online Extension and ExtensionSet documentation for further details.

Attributes

AttributeTypeDescriptionRequired
:fileFileThe file to check for extensionYes, unless a nested <extensionSet> or <fileset> is specified
:propertyStringThe name of property to set if extensions is availableYes

Nested elements

  • :extension (ExtensionAdapter)
  • :extensionset (ExtensionSet)

Reference

https://ant.apache.org/manual/Tasks/jarlib-available.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask

Check whether an extension is present in a fileset or an extensionSet. If the extension
is present then a property is set. Note that this task works with extensions as defined
by the "Optional Package" specification. For more information about optional packages,
see the document Optional Package Versioning in the documentation bundle for your Java
Standard Edition package, in file guide/extensions/versioning.html or the online
Extension and ExtensionSet documentation for further details.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | The file to check for extension | Yes, unless a nested <extensionSet> or <fileset> is specified |
| `:property` | `String` | The name of property to set if extensions is available | Yes |

**Nested elements**

- `:extension` (`ExtensionAdapter`)
- `:extensionset` (`ExtensionSet`)

**Reference**

https://ant.apache.org/manual/Tasks/jarlib-available.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask`
sourceraw docstring

jarlib-displayclj

(jarlib-display & args)

Display the "Optional Package" and "Package Specification" information contained within the specified jars. Note that this task works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or the online Extension and ExtensionSet documentation for further details.

Attributes

AttributeTypeDescriptionRequired
:fileFileThe file to display extension information aboutYes, unless a nested <fileset> is specified

Nested elements

  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/jarlib-display.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask

Display the "Optional Package" and "Package Specification" information contained within
the specified jars. Note that this task works with extensions as defined by the
"Optional Package" specification. For more information about optional packages, see the
document Optional Package Versioning in the documentation bundle for your Java Standard
Edition package, in file guide/extensions/versioning.html or the online Extension and
ExtensionSet documentation for further details.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | The file to display extension information about | Yes, unless a nested <fileset> is specified |

**Nested elements**

- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/jarlib-display.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask`
sourceraw docstring

jarlib-manifestclj

(jarlib-manifest & args)

Task to generate a manifest that declares all the dependencies in manifest. The dependencies are determined by looking in the specified path and searching for Extension / "Optional Package" specifications in the manifests of the jars. Note that this task works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or the online Extension and ExtensionSet documentation for further details.

Attributes

AttributeTypeDescriptionRequired
:destfileFileThe file to generate Manifest intoYes

Nested elements

  • :attribute (ExtraAttribute)
  • :depends (ExtensionSet)
  • :extension (ExtensionAdapter)
  • :options (ExtensionSet)

Reference

https://ant.apache.org/manual/Tasks/jarlib-manifest.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask

Task to generate a manifest that declares all the dependencies in manifest. The
dependencies are determined by looking in the specified path and searching for Extension
/ "Optional Package" specifications in the manifests of the jars. Note that this task
works with extensions as defined by the "Optional Package" specification. For more
information about optional packages, see the document Optional Package Versioning in the
documentation bundle for your Java Standard Edition package, in file
guide/extensions/versioning.html or the online Extension and ExtensionSet documentation
for further details.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:destfile` | `File` | The file to generate Manifest into | Yes |

**Nested elements**

- `:attribute` (`ExtraAttribute`)
- `:depends` (`ExtensionSet`)
- `:extension` (`ExtensionAdapter`)
- `:options` (`ExtensionSet`)

**Reference**

https://ant.apache.org/manual/Tasks/jarlib-manifest.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask`
sourceraw docstring

jarlib-resolveclj

(jarlib-resolve & args)

Try to locate a jar to satisfy an extension and place location of jar into property. The task allows you to add a number of resolvers that are capable of locating a library for a specific extension. Each resolver will be attempted in specified order until library is found or no resolvers are left. If no resolvers are left and failOnError is true then a BuildException will be thrown. Note that this task works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your Java Standard Edition package, in file guide/extensions/versioning.html or the online Extension and ExtensionSet documentation for further details.

Attributes

AttributeTypeDescriptionRequired
:checkextensionbooleantrue if libraries returned by nested resolvers should be checked to see if they supply extension.No; defaults to true
:failonerrorbooleantrue if failure to locate library should result in build exception.No; defaults to true
:propertyStringThe name of property to set to library location.Yes

Nested elements

  • :ant (AntResolver)
  • :extension (ExtensionAdapter)
  • :location (LocationResolver)
  • :url (URLResolver)

Reference

https://ant.apache.org/manual/Tasks/jarlib-resolve.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask

Try to locate a jar to satisfy an extension and place location of jar into property. The
task allows you to add a number of resolvers that are capable of locating a library for
a specific extension. Each resolver will be attempted in specified order until library
is found or no resolvers are left. If no resolvers are left and failOnError is true then
a BuildException will be thrown. Note that this task works with extensions as defined by
the "Optional Package" specification. For more information about optional packages, see
the document Optional Package Versioning in the documentation bundle for your Java
Standard Edition package, in file guide/extensions/versioning.html or the online
Extension and ExtensionSet documentation for further details.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:checkextension` | `boolean` | true if libraries returned by nested resolvers should be checked to see if they supply extension. | No; defaults to true |
| `:failonerror` | `boolean` | true if failure to locate library should result in build exception. | No; defaults to true |
| `:property` | `String` | The name of property to set to library location. | Yes |

**Nested elements**

- `:ant` (`AntResolver`)
- `:extension` (`ExtensionAdapter`)
- `:location` (`LocationResolver`)
- `:url` (`URLResolver`)

**Reference**

https://ant.apache.org/manual/Tasks/jarlib-resolve.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask`
sourceraw docstring

javaclj

(java & args)

Executes a Java class within the running (Apache Ant) JVM or forks another JVM if specified. If odd things go wrong when you run this task, set fork=true to use a new JVM. It is necessary to set fork=true, if the class being launched by this task or any libraries being used by that class, call APIs like java.lang.System.exit() or java.lang.Runtime.exit(). Since Ant 1.6.3, you can interact with a forked JVM, as well as sending input to it via the input and inputstring attributes. Running Ant as a background process on Unix(-like) systems If you run Ant as a background process (like ant &) and use the <java> task with spawn set to false and fork to true, you must provide explicit input to the forked process or Ant will be suspended because it tries to read from the standard input.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanWhether output and error files should be appended to or overwritten.No; defaults to false
:argsStringthe arguments for the class that is executed. Deprecated, use nested <arg> elements instead.No
:classnameStringthe Java class to execute.Exactly one of the four
:classpathPaththe classpath to use.No
:classpathrefReferencethe classpath to use, given as reference to a Path defined elsewhere.No
:clonevmbooleanIf set to true, then all system properties and the bootclasspath of the forked JVM will be the same as those of the JVM running Ant. since Ant 1.7No; default is false, ignored if fork is false
:dirFileThe directory to invoke the JVM in, ignored if fork is false.No
:discarderrorbooleanWhether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10No; defaults to false
:discardoutputbooleanWhether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10No; defaults to false
:errorFileThe file to which the standard error of the command should be redirected.No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored.No
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No; default is false (see note)
:forkbooleanif enabled triggers the class execution in another JVM.No; default is false
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attributeNo; default is to take standard input from console unless spawn is true
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute.No; default is to take standard input from console unless spawn is true)
:jarFilethe location of the jar file to execute (must have a Main-Class entry in the manifest). fork must be set to true if this option is selected. See notes below for more details.Exactly one of the four
:jvmStringthe command used to invoke JVM. The command is resolved by java.lang.Runtime.exec(). Ignored if fork is false.No, default is java
:jvmargsStringthe arguments to pass to the forked JVM, ignored if fork is disabled. Deprecated, use nested <jvmarg> elements instead.No
:jvmversionString
:logerrorbooleanThis attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect.No
:maxmemoryStringMax amount of memory to allocate to the forked JVM, ignored if fork is falseNo
:moduleStringThe initial or main module to resolve (must have a Main-Class entry in the manifest). fork must be set to true if this option is selected. since Ant 1.9.7Exactly one of the four
:modulepathPathSpecify where to find application modules. A list of directories of modules, module files or exploded modules. since Ant 1.9.7No
:modulepathrefReferenceThe modulepath to use, given as reference to a Path defined elsewhere. since Ant 1.9.7No
:newenvironmentbooleanDo not propagate old environment when new environment variables are specified.No; default is false, ignored if fork is false
:outputFileName of a file to which to write the output. If the error stream is not also redirected to a file or property, it will appear in this output.No
:outputpropertyStringThe name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output.No
:resultpropertyStringThe name of a property in which the return code of the command should be stored. Only of interest if failonerror is false and if fork is true.No
:sourcefileStringThe location of a ".java" file or a file containing shebang with Java source code. Set this attribute to run Java single file source programs, a feature introduced in Java 11. fork must be set to true if this option is selected. since Ant 1.10.5Exactly one of the four
:spawnbooleanif enabled allows to start a process which will outlive Ant. Requires that fork is true, and not compatible with timeout, input, output, error, result attributesNo; default is false
:timeoutLongStop the command if it doesn't finish within the specified time (given in milliseconds). It is highly recommended to use this feature only if fork is true.No

Nested elements

  • :arg (Argument)
  • :assertions (Assertions)
  • :bootclasspath (Path)
  • :classpath (Path)
  • :env (Variable)
  • :jvmarg (Argument)
  • :modulepath (Path)
  • :permissions (Permissions)
  • :redirector (RedirectorElement)
  • :sysproperty (Variable)
  • :syspropertyset (PropertySet)
  • :upgrademodulepath (Path)

Reference

https://ant.apache.org/manual/Tasks/java.html

Defined by

org.apache.tools.ant.taskdefs.Java

Executes a Java class within the running (Apache Ant) JVM or forks another JVM if
specified. If odd things go wrong when you run this task, set fork=true to use a new
JVM. It is necessary to set fork=true, if the class being launched by this task or any
libraries being used by that class, call APIs like java.lang.System.exit() or
java.lang.Runtime.exit(). Since Ant 1.6.3, you can interact with a forked JVM, as well
as sending input to it via the input and inputstring attributes. Running Ant as a
background process on Unix(-like) systems If you run Ant as a background process (like
ant &) and use the <java> task with spawn set to false and fork to true, you must
provide explicit input to the forked process or Ant will be suspended because it tries
to read from the standard input.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Whether output and error files should be appended to or overwritten. | No; defaults to false |
| `:args` | `String` | the arguments for the class that is executed. Deprecated, use nested <arg> elements instead. | No |
| `:classname` | `String` | the Java class to execute. | Exactly one of the four |
| `:classpath` | `Path` | the classpath to use. | No |
| `:classpathref` | `Reference` | the classpath to use, given as reference to a Path defined elsewhere. | No |
| `:clonevm` | `boolean` | If set to true, then all system properties and the bootclasspath of the forked JVM will be the same as those of the JVM running Ant. since Ant 1.7 | No; default is false, ignored if fork is false |
| `:dir` | `File` | The directory to invoke the JVM in, ignored if fork is false. | No |
| `:discarderror` | `boolean` | Whether error output should completely be discarded. This setting is incompatible with any setting that redirects error output to files or properties as well as logError. Since Ant 1.10.10 | No; defaults to false |
| `:discardoutput` | `boolean` | Whether output should completely be discarded. This setting is incompatible with any setting that redirects output to files or properties. If you set this to true error output will be discared as well unless you redirect error output to files, properties or enable logError. Since Ant 1.10.10 | No; defaults to false |
| `:error` | `File` | The file to which the standard error of the command should be redirected. | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. | No |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No; default is false (see note) |
| `:fork` | `boolean` | if enabled triggers the class execution in another JVM. | No; default is false |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute | No; default is to take standard input from console unless spawn is true |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. | No; default is to take standard input from console unless spawn is true) |
| `:jar` | `File` | the location of the jar file to execute (must have a Main-Class entry in the manifest). fork must be set to true if this option is selected. See notes below for more details. | Exactly one of the four |
| `:jvm` | `String` | the command used to invoke JVM. The command is resolved by java.lang.Runtime.exec(). Ignored if fork is false. | No, default is java |
| `:jvmargs` | `String` | the arguments to pass to the forked JVM, ignored if fork is disabled. Deprecated, use nested <jvmarg> elements instead. | No |
| `:jvmversion` | `String` |  |  |
| `:logerror` | `boolean` | This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the error or errorProperty attributes, this will have no effect. | No |
| `:maxmemory` | `String` | Max amount of memory to allocate to the forked JVM, ignored if fork is false | No |
| `:module` | `String` | The initial or main module to resolve (must have a Main-Class entry in the manifest). fork must be set to true if this option is selected. since Ant 1.9.7 | Exactly one of the four |
| `:modulepath` | `Path` | Specify where to find application modules. A list of directories of modules, module files or exploded modules. since Ant 1.9.7 | No |
| `:modulepathref` | `Reference` | The modulepath to use, given as reference to a Path defined elsewhere. since Ant 1.9.7 | No |
| `:newenvironment` | `boolean` | Do not propagate old environment when new environment variables are specified. | No; default is false, ignored if fork is false |
| `:output` | `File` | Name of a file to which to write the output. If the error stream is not also redirected to a file or property, it will appear in this output. | No |
| `:outputproperty` | `String` | The name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. | No |
| `:resultproperty` | `String` | The name of a property in which the return code of the command should be stored. Only of interest if failonerror is false and if fork is true. | No |
| `:sourcefile` | `String` | The location of a ".java" file or a file containing shebang with Java source code. Set this attribute to run Java single file source programs, a feature introduced in Java 11. fork must be set to true if this option is selected. since Ant 1.10.5 | Exactly one of the four |
| `:spawn` | `boolean` | if enabled allows to start a process which will outlive Ant. Requires that fork is true, and not compatible with timeout, input, output, error, result attributes | No; default is false |
| `:timeout` | `Long` | Stop the command if it doesn't finish within the specified time (given in milliseconds). It is highly recommended to use this feature only if fork is true. | No |

**Nested elements**

- `:arg` (`Argument`)
- `:assertions` (`Assertions`)
- `:bootclasspath` (`Path`)
- `:classpath` (`Path`)
- `:env` (`Variable`)
- `:jvmarg` (`Argument`)
- `:modulepath` (`Path`)
- `:permissions` (`Permissions`)
- `:redirector` (`RedirectorElement`)
- `:sysproperty` (`Variable`)
- `:syspropertyset` (`PropertySet`)
- `:upgrademodulepath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/java.html

**Defined by**

`org.apache.tools.ant.taskdefs.Java`
sourceraw docstring

javacclj

(javac & args)

Compiles a Java source tree. The source and destination directory will be recursively scanned for Java source files to compile. Only .java files that have no corresponding .class file or where the .class file is older than the .java file will be compiled. Note: Apache Ant uses only the names of the source and class files to find the classes that need a rebuild. It will not scan the source and therefore will have no knowledge about nested classes, classes that are named differently from the source file, and so on. See the <depend> task for dependency checking based on other than just existence/modification times. When the source files are part of a package, the directory structure of the source tree should follow the package hierarchy. It is possible to refine the set of files that are being compiled. This can be done with the includes, includesfile, excludes, and excludesfile attributes. With the includes or includesfile attribute, you specify the files you want to have included. The exclude or excludesfile attribute is used to specify the files you want to have excluded. In both cases, the list of files can be specified by either the filename, relative to the directory(s) specified in the srcdir attribute or nested <src> element(s), or by using wildcard patterns. See the section on directory-based tasks, for information on how the inclusion/exclusion of files works, and how to write wildcard patterns. It is possible to use different compilers. This can be specified by either setting the global build.compiler property, which will affect all <javac> tasks throughout the build, by setting the compiler attribute, specific to the current <javac> task or by using a nested element of any typedeffed or componentdeffed type that implements org.apache.tools.ant.taskdefs.compilers.CompilerAdapter. Valid values for either the build.compiler property or the compiler attribute are: classic (the standard compiler of JDK 1.1/1.2) - javac1.1 and javac1.2 can be used as aliases. modern (the standard compiler of JDK 1.3 and later) - javac1.3, javac1.4, javac1.5 and javac1.6, javac1.7 (since Ant 1.8.2), javac1.8 (since Ant 1.8.3), javac1.9 (since Ant 1.9.5), javac9 (since Ant 1.9.8) and javac10+ (since Ant 1.10.2) can be used as aliases. jikes (the Jikes compiler). jvc (the Command-Line Compiler from Microsoft's SDK for Java / Visual J++) - microsoft can be used as an alias. kjc (the kopi compiler). gcj (the gcj compiler from GCC). sj (Symantec Java compiler) - symantec can be used as an alias. extJavac (run either modern or classic in a JVM of its own). The default is javacX with X depending on the JDK version you use while you are running Ant. If you wish to use a different compiler interface than those supplied, you can write a class that implements the CompilerAdapter interface (package org.apache.tools.ant.taskdefs.compilers). Supply the full classname in the build.compiler property or the compiler attribute. The fork attribute overrides the build.compiler property or compiler attribute setting and expects a JDK 1.1 or higher to be set in JAVA_HOME. You can also use the compiler attribute to tell Ant which JDK version it shall assume when it puts together the command line switches-even if you set fork=true. This is useful if you want to run the compiler of JDK 1.1 while your current JDK is 1.2+. If you use compiler=javac1.1 and (for example) depend=true, Ant will use the command line switch -depend instead of -Xdepend. This task will drop all entries that point to non-existent files/directories from the classpath it passes to the compiler. The working directory for a forked executable (if any) is the project's base directory. Windows Note: When the modern compiler is used in unforked mode on Windows, it locks up the files present in the classpath of the <javac> task, and does not release them. The side effect of this is that you will not be able to delete or move those files later on in the build. The workaround is to fork when invoking the compiler. If your source contains native methods or fields annotated with the @Native annotation you can set the nativeheaderdir attribute in order to use the -h switch of javac to generate the native header files. Note that the logic Ant uses to determine which files to compile does not take native headers into account, i.e. if the .class is more recent than the corresponding .java file the file will not get compiled even if a native header file generated for it would be outdated.

Attributes

AttributeTypeDescriptionRequired
:bootclasspathPathLocation of bootstrap class files. (See below for using the -X and -J-X parameters for specifying the bootstrap classpath).No
:bootclasspathrefReferenceThe bootstrapclasspath to use, given as a reference to a path defined elsewhere.No
:casesensitiveboolean
:classpathPathThe classpath to use.No
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere.No
:compilerStringThe compiler implementation to use. See the above list of valid compilers.No; defaults to the value of the build.compiler property, if set, or default compiler for the current JDK otherwise
:createmissingpackageinfoclassbooleanSome package level annotations in package-info.java files don't create any package-info.class files so Ant would recompile the same file every time. Since Ant 1.8, an empty package-info.class is created for each package-info.java if there isn't one created by the compiler. In some setups this additional class causes problems and it can be suppressed by setting this attribute to false. Since Ant 1.8.3.No; default is true
:debugbooleanIndicates whether source should be compiled with debug information. If set to off, -g:none will be passed on the command line for compilers that support it (for other compilers, no command line argument will be used). If set to true, the value of the debuglevel attribute determines the command line argument.No; defaults to off
:debuglevelStringKeyword list to be appended to the -g command-line switch. Legal values are none or a comma-separated list of the following keywords: lines, vars, and source.No; ignored when debug is false or any implementation other than modern, javac1.2 and jikes; by default, nothing will be appended to -g
:defaultexcludesbooleanIndicates whether default excludes should be used or not (yes|no).No; defaults to yes
:dependbooleanEnables dependency tracking for compilers that support this (jikes and classic).No
:deprecationbooleanIndicates whether source should be compiled with deprecation information.No; defaults to off
:destdirFileLocation to store the class files.No
:encodingStringEncoding of source files. (Note: gcj doesn't support this option yet.)No
:errorpropertyStringThe property to set to true if compilation fails. Since Ant 1.7.1.No
:excludesStringComma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFileName of a file. Each line of this file is taken to be an exclude pattern.No
:executableStringComplete path to the javac executable to use in case of fork is yes. Since Ant 1.6 this attribute can also be used to specify the path to the executable when using jikes, jvc, gcj or sj.No; defaults to the compiler of current JDK, ignored if fork is no
:extdirsPathLocation of installed extensions.No
:failonerrorbooleanIndicates whether compilation errors will fail the build>.No; defaults to true
:followsymlinksboolean
:forkbooleanWhether to execute javac using the JDK compiler externally.No; defaults to no
:includeantruntimebooleanWhether to include the Ant run-time libraries in the classpath. It is usually best to set this to false so the script's behavior is not sensitive to the environment in which it is run.No; defaults to yes, unless build.sysclasspath property is set
:includedestclassesbooleanThis attribute controls whether to include the destination classes directory in the classpath given to the compiler. If set to true (default), previously compiled classes are on the classpath for the compiler. This means that "greedy" compilers will not recompile dependent classes that are already compiled. In general this is a good thing as it stops the compiler for doing unnecessary work. However, for some edge cases, involving generics, the javac compiler needs to compile the dependent classes to get the generics information. One example is documented in the bug report: Bug 40776 - a problem compiling a Java 5 project with generics. Setting the attribute to false will cause the compiler to recompile dependent classes. Since Ant 1.7.1.No; default is true
:includejavaruntimebooleanWhether to include the default run-time libraries from the executing JVM in the classpath. Note: In some setups the run-time libraries may be part of the "Ant run-time libraries" so you may need to explicitly set includeAntRuntime to false to ensure that the Java run-time libraries are not included.No; defaults to no
:includesStringComma- or space-separated list of patterns of files that must be included.No; defaults to all .java files
:includesfileFileName of a file. Each line of this file is taken to be an include pattern.No
:listfilesbooleanIndicates whether the source files to be compiled will be listed.No; defaults to no
:memoryinitialsizeStringThe initial size of the memory for the underlying JVM, if javac is run externally. (Examples: 83886080, 81920k, or 80m)No; defaults to the standard JVM memory setting, ignored if fork is no
:memorymaximumsizeStringThe maximum size of the memory for the underlying JVM, if javac is run externally; ignored otherwise. (Examples: 83886080, 81920k, or 80m)No; defaults to the standard JVM memory setting, ignored if fork is no
:modulepathPathSpecify where to find application modules. A list of directories of modules, module files or exploded modules. since Ant 1.9.7No
:modulepathrefReferenceThe modulepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7No
:modulesourcepathPathSpecify where to find input source files for multiple module compilation. since Ant 1.9.7Yes, unless srcdir attribute or nested <src> elements are present
:modulesourcepathrefReferenceThe modulesourcepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7No
:nativeheaderdirFileSpecify where to place generated native header files. Since Ant 1.9.8. No, ignored when compiling on JDK 7 or earlier
:nowarnbooleanIndicates whether the -nowarn switch should be passed to the compiler.No; defaults to off
:optimizebooleanIndicates whether source should be compiled with optimization. Note that this flag is just ignored by Sun's javac since JDK 1.3 (because compile-time optimization is unnecessary).No; defaults to off
:proceedboolean
:releaseStringSpecify the value for the --release switch. When set and running on JDK 9+ the source and target attributes as well as the bootclasspath will be ignored. Since Ant 1.9.8. No, ignored when compiling on JDK 8 or earlier
:sourceStringJava language features accepted by compiler, as specified by the -source command-line switch. Valid feature versions are 1.3, 1.4, 1.5 or 5, etc. The attribute will be ignored by all implementations prior to javac1.4 (or modern when Ant is not running in a JVM 1.3), gcj and jikes. If you use this attribute together with gcj or jikes, you must make sure that your version supports the -source (or -fsource for gcj) switch.No; by default, no -source argument will be used at all unless the magic ant.build.javac.source property is set Note that the default value depends on JDK that is running Ant. We highly recommend to always specify this attribute.
:sourcepathPathThe sourcepath to use. To suppress the sourcepath switch, use sourcepath=.No; defaults to srcdir unless nested <src> elements are specified
:sourcepathrefReferenceThe sourcepath to use, given as a reference to a path defined elsewhere.No
:srcdirPathLocation of the java files. (See the note below.)Yes, unless nested <src> elements or modulesourcepath attribute or corresponding elements are present
:targetStringGenerate class files for specific JVM version (cross-compile).No; by default, no -target argument will be used at all unless the magic ant.build.javac.target property is set Note that the default value depends on JDK that is running Ant and on source (see Cross-Compilation Options). We highly recommend to always specify this attribute.
:tempdirFileWhere Ant should place temporary files. This is only used if the task is forked and the command line args length exceeds 4 kB. Since Ant 1.6.No; default is java.io.tmpdir
:updatedpropertyStringThe property to set to true if compilation has taken place and has been successful. Since Ant 1.7.1.No
:upgrademodulepathPathSpecify the location of modules that replace upgradeable modules in the runtime image. since Ant 1.9.7No
:upgrademodulepathrefReferenceThe upgrademodulepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7No
:verbosebooleanAsks the compiler for verbose output.No; defaults to no

Nested elements

  • :and (AndSelector)
  • :bootclasspath (Path)
  • :classpath (Path)
  • :compilerarg (ImplementationSpecificArgument)
  • :compilerclasspath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :extdirs (Path)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :modulepath (Path)
  • :modulesourcepath (Path)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :sourcepath (Path)
  • :src (Path)
  • :type (TypeSelector)
  • :upgrademodulepath (Path)

Reference

https://ant.apache.org/manual/Tasks/javac.html

Defined by

org.apache.tools.ant.taskdefs.Javac

Compiles a Java source tree. The source and destination directory will be recursively
scanned for Java source files to compile. Only .java files that have no corresponding
.class file or where the .class file is older than the .java file will be compiled.
Note: Apache Ant uses only the names of the source and class files to find the classes
that need a rebuild. It will not scan the source and therefore will have no knowledge
about nested classes, classes that are named differently from the source file, and so
on. See the <depend> task for dependency checking based on other than just
existence/modification times. When the source files are part of a package, the directory
structure of the source tree should follow the package hierarchy. It is possible to
refine the set of files that are being compiled. This can be done with the includes,
includesfile, excludes, and excludesfile attributes. With the includes or includesfile
attribute, you specify the files you want to have included. The exclude or excludesfile
attribute is used to specify the files you want to have excluded. In both cases, the
list of files can be specified by either the filename, relative to the directory(s)
specified in the srcdir attribute or nested <src> element(s), or by using wildcard
patterns. See the section on directory-based tasks, for information on how the
inclusion/exclusion of files works, and how to write wildcard patterns. It is possible
to use different compilers. This can be specified by either setting the global
build.compiler property, which will affect all <javac> tasks throughout the build, by
setting the compiler attribute, specific to the current <javac> task or by using a
nested element of any typedeffed or componentdeffed type that implements
org.apache.tools.ant.taskdefs.compilers.CompilerAdapter. Valid values for either the
build.compiler property or the compiler attribute are: classic (the standard compiler of
JDK 1.1/1.2) - javac1.1 and javac1.2 can be used as aliases. modern (the standard
compiler of JDK 1.3 and later) - javac1.3, javac1.4, javac1.5 and javac1.6, javac1.7
(since Ant 1.8.2), javac1.8 (since Ant 1.8.3), javac1.9 (since Ant 1.9.5), javac9 (since
Ant 1.9.8) and javac10+ (since Ant 1.10.2) can be used as aliases. jikes (the Jikes
compiler). jvc (the Command-Line Compiler from Microsoft's SDK for Java / Visual J++) -
microsoft can be used as an alias. kjc (the kopi compiler). gcj (the gcj compiler from
GCC). sj (Symantec Java compiler) - symantec can be used as an alias. extJavac (run
either modern or classic in a JVM of its own). The default is javacX with X depending on
the JDK version you use while you are running Ant. If you wish to use a different
compiler interface than those supplied, you can write a class that implements the
CompilerAdapter interface (package org.apache.tools.ant.taskdefs.compilers). Supply the
full classname in the build.compiler property or the compiler attribute. The fork
attribute overrides the build.compiler property or compiler attribute setting and
expects a JDK 1.1 or higher to be set in JAVA_HOME. You can also use the compiler
attribute to tell Ant which JDK version it shall assume when it puts together the
command line switches-even if you set fork=true. This is useful if you want to run the
compiler of JDK 1.1 while your current JDK is 1.2+. If you use compiler=javac1.1 and
(for example) depend=true, Ant will use the command line switch -depend instead of
-Xdepend. This task will drop all entries that point to non-existent files/directories
from the classpath it passes to the compiler. The working directory for a forked
executable (if any) is the project's base directory. Windows Note: When the modern
compiler is used in unforked mode on Windows, it locks up the files present in the
classpath of the <javac> task, and does not release them. The side effect of this is
that you will not be able to delete or move those files later on in the build. The
workaround is to fork when invoking the compiler. If your source contains native methods
or fields annotated with the @Native annotation you can set the nativeheaderdir
attribute in order to use the -h switch of javac to generate the native header files.
Note that the logic Ant uses to determine which files to compile does not take native
headers into account, i.e. if the .class is more recent than the corresponding .java
file the file will not get compiled even if a native header file generated for it would
be outdated.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bootclasspath` | `Path` | Location of bootstrap class files. (See below for using the -X and -J-X parameters for specifying the bootstrap classpath). | No |
| `:bootclasspathref` | `Reference` | The bootstrapclasspath to use, given as a reference to a path defined elsewhere. | No |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | The classpath to use. | No |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. | No |
| `:compiler` | `String` | The compiler implementation to use. See the above list of valid compilers. | No; defaults to the value of the build.compiler property, if set, or default compiler for the current JDK otherwise |
| `:createmissingpackageinfoclass` | `boolean` | Some package level annotations in package-info.java files don't create any package-info.class files so Ant would recompile the same file every time. Since Ant 1.8, an empty package-info.class is created for each package-info.java if there isn't one created by the compiler. In some setups this additional class causes problems and it can be suppressed by setting this attribute to false. Since Ant 1.8.3. | No; default is true |
| `:debug` | `boolean` | Indicates whether source should be compiled with debug information. If set to off, -g:none will be passed on the command line for compilers that support it (for other compilers, no command line argument will be used). If set to true, the value of the debuglevel attribute determines the command line argument. | No; defaults to off |
| `:debuglevel` | `String` | Keyword list to be appended to the -g command-line switch. Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. | No; ignored when debug is false or any implementation other than modern, javac1.2 and jikes; by default, nothing will be appended to -g |
| `:defaultexcludes` | `boolean` | Indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:depend` | `boolean` | Enables dependency tracking for compilers that support this (jikes and classic). | No |
| `:deprecation` | `boolean` | Indicates whether source should be compiled with deprecation information. | No; defaults to off |
| `:destdir` | `File` | Location to store the class files. | No |
| `:encoding` | `String` | Encoding of source files. (Note: gcj doesn't support this option yet.) | No |
| `:errorproperty` | `String` | The property to set to true if compilation fails. Since Ant 1.7.1. | No |
| `:excludes` | `String` | Comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | Name of a file. Each line of this file is taken to be an exclude pattern. | No |
| `:executable` | `String` | Complete path to the javac executable to use in case of fork is yes. Since Ant 1.6 this attribute can also be used to specify the path to the executable when using jikes, jvc, gcj or sj. | No; defaults to the compiler of current JDK, ignored if fork is no |
| `:extdirs` | `Path` | Location of installed extensions. | No |
| `:failonerror` | `boolean` | Indicates whether compilation errors will fail the build>. | No; defaults to true |
| `:followsymlinks` | `boolean` |  |  |
| `:fork` | `boolean` | Whether to execute javac using the JDK compiler externally. | No; defaults to no |
| `:includeantruntime` | `boolean` | Whether to include the Ant run-time libraries in the classpath. It is usually best to set this to false so the script's behavior is not sensitive to the environment in which it is run. | No; defaults to yes, unless build.sysclasspath property is set |
| `:includedestclasses` | `boolean` | This attribute controls whether to include the destination classes directory in the classpath given to the compiler. If set to true (default), previously compiled classes are on the classpath for the compiler. This means that "greedy" compilers will not recompile dependent classes that are already compiled. In general this is a good thing as it stops the compiler for doing unnecessary work. However, for some edge cases, involving generics, the javac compiler needs to compile the dependent classes to get the generics information. One example is documented in the bug report: Bug 40776 - a problem compiling a Java 5 project with generics. Setting the attribute to false will cause the compiler to recompile dependent classes. Since Ant 1.7.1. | No; default is true |
| `:includejavaruntime` | `boolean` | Whether to include the default run-time libraries from the executing JVM in the classpath. Note: In some setups the run-time libraries may be part of the "Ant run-time libraries" so you may need to explicitly set includeAntRuntime to false to ensure that the Java run-time libraries are not included. | No; defaults to no |
| `:includes` | `String` | Comma- or space-separated list of patterns of files that must be included. | No; defaults to all .java files |
| `:includesfile` | `File` | Name of a file. Each line of this file is taken to be an include pattern. | No |
| `:listfiles` | `boolean` | Indicates whether the source files to be compiled will be listed. | No; defaults to no |
| `:memoryinitialsize` | `String` | The initial size of the memory for the underlying JVM, if javac is run externally. (Examples: 83886080, 81920k, or 80m) | No; defaults to the standard JVM memory setting, ignored if fork is no |
| `:memorymaximumsize` | `String` | The maximum size of the memory for the underlying JVM, if javac is run externally; ignored otherwise. (Examples: 83886080, 81920k, or 80m) | No; defaults to the standard JVM memory setting, ignored if fork is no |
| `:modulepath` | `Path` | Specify where to find application modules. A list of directories of modules, module files or exploded modules. since Ant 1.9.7 | No |
| `:modulepathref` | `Reference` | The modulepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7 | No |
| `:modulesourcepath` | `Path` | Specify where to find input source files for multiple module compilation. since Ant 1.9.7 | Yes, unless srcdir attribute or nested <src> elements are present |
| `:modulesourcepathref` | `Reference` | The modulesourcepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7 | No |
| `:nativeheaderdir` | `File` | Specify where to place generated native header files. Since Ant 1.9.8. No, ignored when compiling on JDK 7 or earlier |  |
| `:nowarn` | `boolean` | Indicates whether the -nowarn switch should be passed to the compiler. | No; defaults to off |
| `:optimize` | `boolean` | Indicates whether source should be compiled with optimization. Note that this flag is just ignored by Sun's javac since JDK 1.3 (because compile-time optimization is unnecessary). | No; defaults to off |
| `:proceed` | `boolean` |  |  |
| `:release` | `String` | Specify the value for the --release switch. When set and running on JDK 9+ the source and target attributes as well as the bootclasspath will be ignored. Since Ant 1.9.8. No, ignored when compiling on JDK 8 or earlier |  |
| `:source` | `String` | Java language features accepted by compiler, as specified by the -source command-line switch. Valid feature versions are 1.3, 1.4, 1.5 or 5, etc. The attribute will be ignored by all implementations prior to javac1.4 (or modern when Ant is not running in a JVM 1.3), gcj and jikes. If you use this attribute together with gcj or jikes, you must make sure that your version supports the -source (or -fsource for gcj) switch. | No; by default, no -source argument will be used at all unless the magic ant.build.javac.source property is set Note that the default value depends on JDK that is running Ant. We highly recommend to always specify this attribute. |
| `:sourcepath` | `Path` | The sourcepath to use. To suppress the sourcepath switch, use sourcepath=. | No; defaults to srcdir unless nested <src> elements are specified |
| `:sourcepathref` | `Reference` | The sourcepath to use, given as a reference to a path defined elsewhere. | No |
| `:srcdir` | `Path` | Location of the java files. (See the note below.) | Yes, unless nested <src> elements or modulesourcepath attribute or corresponding elements are present |
| `:target` | `String` | Generate class files for specific JVM version (cross-compile). | No; by default, no -target argument will be used at all unless the magic ant.build.javac.target property is set Note that the default value depends on JDK that is running Ant and on source (see Cross-Compilation Options). We highly recommend to always specify this attribute. |
| `:tempdir` | `File` | Where Ant should place temporary files. This is only used if the task is forked and the command line args length exceeds 4 kB. Since Ant 1.6. | No; default is java.io.tmpdir |
| `:updatedproperty` | `String` | The property to set to true if compilation has taken place and has been successful. Since Ant 1.7.1. | No |
| `:upgrademodulepath` | `Path` | Specify the location of modules that replace upgradeable modules in the runtime image. since Ant 1.9.7 | No |
| `:upgrademodulepathref` | `Reference` | The upgrademodulepath to use, given as reference to a path defined elsewhere. since Ant 1.9.7 | No |
| `:verbose` | `boolean` | Asks the compiler for verbose output. | No; defaults to no |

**Nested elements**

- `:and` (`AndSelector`)
- `:bootclasspath` (`Path`)
- `:classpath` (`Path`)
- `:compilerarg` (`ImplementationSpecificArgument`)
- `:compilerclasspath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:extdirs` (`Path`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:modulepath` (`Path`)
- `:modulesourcepath` (`Path`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:sourcepath` (`Path`)
- `:src` (`Path`)
- `:type` (`TypeSelector`)
- `:upgrademodulepath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/javac.html

**Defined by**

`org.apache.tools.ant.taskdefs.Javac`
sourceraw docstring

javaccclj

(javacc & args)

Invokes the JavaCC compiler compiler on a grammar file. To use the javacc task, set the target attribute to the name of the grammar file to process. You also need to specify the directory containing the JavaCC installation using the javacchome attribute, so that Apache Ant can find the JavaCC classes. Optionally, you can also set the outputdirectory to write the generated file to a specific directory. Otherwise JavaCC writes the generated files to the directory containing the grammar file. This task only invokes JavaCC if the grammar file is newer than the generated .java files. JavaCC assumes that the Java class name of the generated parser is the same as the name of the grammar file, ignoring the .jj. If this is not the case, the javacc task will still work, but it will always generate the output files.

Attributes

AttributeTypeDescriptionRequired
:buildparserbooleanSets the BUILD_PARSER grammar option. This is a boolean option.No
:buildtokenmanagerbooleanSets the BUILD_TOKEN_MANAGER grammar option. This is a boolean option.No
:cachetokensbooleanSets the CACHE_TOKENS grammar option. This is a boolean option.No
:choiceambiguitycheckintSets the CHOICE_AMBIGUITY_CHECK grammar option. This is an integer option.No
:commontokenactionbooleanSets the COMMON_TOKEN_ACTION grammar option. This is a boolean option.No
:debuglookaheadbooleanSets the DEBUG_LOOKAHEAD grammar option. This is a boolean option.No
:debugparserbooleanSets the DEBUG_PARSER grammar option. This is a boolean option.No
:debugtokenmanagerbooleanSets the DEBUG_TOKEN_MANAGER grammar option. This is a boolean option.No
:errorreportingbooleanSets the ERROR_REPORTING grammar option. This is a boolean option.No
:forcelacheckbooleanSets the FORCE_LA_CHECK grammar option. This is a boolean option.No
:ignorecasebooleanSets the IGNORE_CASE grammar option. This is a boolean option.No
:javacchomeFileThe directory containing the JavaCC distribution.Yes
:javaunicodeescapebooleanSets the JAVA_UNICODE_ESCAPE grammar option. This is a boolean option.No
:jdkversionStringSets the JDK_VERSION option. This is a string option.No
:keeplinecolumnbooleanSets the KEEP_LINE_COLUMN grammar option. This is a boolean option.No
:lookaheadintSets the LOOKAHEAD grammar option. This is an integer option.No
:maxmemoryStringMax amount of memory to allocate to the forked JVM. since Ant 1.8.3No
:optimizetokenmanagerbooleanSets the OPTIMIZE_TOKEN_MANAGER grammar option. This is a boolean option.No
:otherambiguitycheckintSets the OTHER_AMBIGUITY_CHECK grammar option. This is an integer option.No
:outputdirectoryFileThe directory to write the generated files to. If not set, the files are written to the directory containing the grammar file.No
:sanitycheckbooleanSets the SANITY_CHECK grammar option. This is a boolean option.No
:staticbooleanSets the STATIC grammar option. This is a boolean option.No
:targetFileThe grammar file to process.Yes
:unicodeinputbooleanSets the UNICODE_INPUT grammar option. This is a boolean option.No
:usercharstreambooleanSets the USER_CHAR_STREAM grammar option. This is a boolean option.No
:usertokenmanagerbooleanSets the USER_TOKEN_MANAGER grammar option. This is a boolean option.No

Reference

https://ant.apache.org/manual/Tasks/javacc.html

Defined by

org.apache.tools.ant.taskdefs.optional.javacc.JavaCC

Invokes the JavaCC compiler compiler on a grammar file. To use the javacc task, set the
target attribute to the name of the grammar file to process. You also need to specify
the directory containing the JavaCC installation using the javacchome attribute, so that
Apache Ant can find the JavaCC classes. Optionally, you can also set the outputdirectory
to write the generated file to a specific directory. Otherwise JavaCC writes the
generated files to the directory containing the grammar file. This task only invokes
JavaCC if the grammar file is newer than the generated .java files. JavaCC assumes that
the Java class name of the generated parser is the same as the name of the grammar file,
ignoring the .jj. If this is not the case, the javacc task will still work, but it will
always generate the output files.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:buildparser` | `boolean` | Sets the BUILD_PARSER grammar option. This is a boolean option. | No |
| `:buildtokenmanager` | `boolean` | Sets the BUILD_TOKEN_MANAGER grammar option. This is a boolean option. | No |
| `:cachetokens` | `boolean` | Sets the CACHE_TOKENS grammar option. This is a boolean option. | No |
| `:choiceambiguitycheck` | `int` | Sets the CHOICE_AMBIGUITY_CHECK grammar option. This is an integer option. | No |
| `:commontokenaction` | `boolean` | Sets the COMMON_TOKEN_ACTION grammar option. This is a boolean option. | No |
| `:debuglookahead` | `boolean` | Sets the DEBUG_LOOKAHEAD grammar option. This is a boolean option. | No |
| `:debugparser` | `boolean` | Sets the DEBUG_PARSER grammar option. This is a boolean option. | No |
| `:debugtokenmanager` | `boolean` | Sets the DEBUG_TOKEN_MANAGER grammar option. This is a boolean option. | No |
| `:errorreporting` | `boolean` | Sets the ERROR_REPORTING grammar option. This is a boolean option. | No |
| `:forcelacheck` | `boolean` | Sets the FORCE_LA_CHECK grammar option. This is a boolean option. | No |
| `:ignorecase` | `boolean` | Sets the IGNORE_CASE grammar option. This is a boolean option. | No |
| `:javacchome` | `File` | The directory containing the JavaCC distribution. | Yes |
| `:javaunicodeescape` | `boolean` | Sets the JAVA_UNICODE_ESCAPE grammar option. This is a boolean option. | No |
| `:jdkversion` | `String` | Sets the JDK_VERSION option. This is a string option. | No |
| `:keeplinecolumn` | `boolean` | Sets the KEEP_LINE_COLUMN grammar option. This is a boolean option. | No |
| `:lookahead` | `int` | Sets the LOOKAHEAD grammar option. This is an integer option. | No |
| `:maxmemory` | `String` | Max amount of memory to allocate to the forked JVM. since Ant 1.8.3 | No |
| `:optimizetokenmanager` | `boolean` | Sets the OPTIMIZE_TOKEN_MANAGER grammar option. This is a boolean option. | No |
| `:otherambiguitycheck` | `int` | Sets the OTHER_AMBIGUITY_CHECK grammar option. This is an integer option. | No |
| `:outputdirectory` | `File` | The directory to write the generated files to. If not set, the files are written to the directory containing the grammar file. | No |
| `:sanitycheck` | `boolean` | Sets the SANITY_CHECK grammar option. This is a boolean option. | No |
| `:static` | `boolean` | Sets the STATIC grammar option. This is a boolean option. | No |
| `:target` | `File` | The grammar file to process. | Yes |
| `:unicodeinput` | `boolean` | Sets the UNICODE_INPUT grammar option. This is a boolean option. | No |
| `:usercharstream` | `boolean` | Sets the USER_CHAR_STREAM grammar option. This is a boolean option. | No |
| `:usertokenmanager` | `boolean` | Sets the USER_TOKEN_MANAGER grammar option. This is a boolean option. | No |

**Reference**

https://ant.apache.org/manual/Tasks/javacc.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.javacc.JavaCC`
sourceraw docstring

javaconstantclj

(javaconstant & args)

Ant type javaconstant. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:directoryboolean
:existsboolean
:lastmodifiedlong
:loaderrefReference
:nameString
:parentfirstboolean
:refidReference
:sizelong

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Types/javaconstant.html

Defined by

org.apache.tools.ant.types.resources.JavaConstantResource

Ant type javaconstant. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:loaderref` | `Reference` |  |  |
| `:name` | `String` |  |  |
| `:parentfirst` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Types/javaconstant.html

**Defined by**

`org.apache.tools.ant.types.resources.JavaConstantResource`
sourceraw docstring

javadocclj

(javadoc & args)

Generates code documentation using the javadoc tool. The source directory will be recursively scanned for Java source files to process but only those matching the inclusion rules, and not matching the exclusions rules will be passed to the javadoc tool. This allows wildcards to be used to choose between package names, reducing verbosity and management costs over time. This task, however, has no notion of "changed" files, unlike the javac task. This means all packages will be processed each time this task is run. In general, however, this task is used much less frequently. Note: since javadoc calls System.exit(), javadoc cannot be run inside the same JVM as Apache Ant without breaking functionality. For this reason, this task always forks JVM. This overhead is not significant since javadoc is normally a heavy application and will be called infrequently. Note: the packagelist attribute allows you to specify the list of packages to document outside of the Ant file. It's a much better practice to include everything inside the build.xml file. This option was added in order to make it easier to migrate from regular makefiles, where you would use this option of javadoc. The packages listed in packagelist are not checked, so the task performs even if some packages are missing or broken. Use this option if you wish to convert from an existing makefile. Once things are running you should then switch to the regular notation. Note: When generating the JavaDocs for classes which contains annotations you maybe get a java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl. This is due bug 6442982. The cause is that javadoc cannot find the implementations of used annotations. The workaround is providing the jars with these implementations (like JAXBs @XmlType, ...) to <javadoc> using classpath, classpathref attributes or nested <classpath> element. Note: many problems with running javadoc stem from command lines that have become too long-even though the error message doesn't give the slightest hint this may be the problem. If you encounter problems with the task, try to set the useexternalfile attribute to true first. If you use multiple ways to specify where javadoc should be looking for sources, your result will be the union of all specified documentations. If you, e.g., specify a sourcepath attribute and also a nested packageset both pointing at the same directory your excludepackagenames attribute won't have any effect unless it agrees with the exclude patterns of the packageset (and vice versa).

Attributes

AttributeTypeDescriptionRequired
:accessAccessTypeAccess mode: one of public, protected, package, or privateNo; default is protected
:additionalparamStringLets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using "-see also the nested arg element.No
:authorbooleanInclude @author paragraphsNo
:bootclasspathPathOverride location of class files loaded by the bootstrap class loaderNo
:bootclasspathrefReferenceOverride location of class files loaded by the bootstrap class loader by reference to a bootclasspath defined elsewhere.No
:bottomStringInclude bottom text for each page (HTML code)No
:breakiteratorbooleanUse the new break iterator algorithm. since Ant 1.6. (yes|no).No; default is no
:charsetStringCharset for cross-platform viewing of generated documentationNo
:classpathPathSpecify where to find user class filesNo
:classpathrefReferenceSpecify where to find user class files by reference to a classpath defined elsewhere.No
:defaultexcludesbooleanindicates whether default excludes should be used (yes|no).No; defaults to yes
:destdirFileDestination directory for output filesYes, unless a doclet has been specified.
:docencodingStringOutput file encoding nameNo
:docfilessubdirsbooleanEnables deep-copying of doc-files subdirectories. since Ant 1.8.0.No; defaults to false
:docletStringSpecifies the class file that starts the doclet used in generating the documentation-see also the nested doclet element.No
:docletpathPathSpecifies the path to the doclet class file that is specified with the -doclet option.No
:docletpathrefReferenceSpecifies the path to the doclet class file that is specified with the -doclet option by reference to a path defined elsewhere.No
:doctitleStringInclude title for the package index (first) page (HTML code)No
:encodingStringSource file encoding nameNo
:excludedocfilessubdirStringColon-separated list of doc-files subdirectories to exclude if docfilessubdirs is true. since Ant 1.8.0.No
:excludepackagenamesStringcomma separated list of packages you don't want docs for-see also the nested excludepackage element.No
:executableStringSpecify a particular javadoc executable to use in place of the default binary (found in the same JDK as Ant is running in). since Ant 1.6.3. Note: It is up to you to ensure that this command supports the attributes you wish to use.No
:extdirsPathOverride location of installed extensionsNo
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No
:failonwarningbooleanStop the build process if a warning is emitted-i.e. if javadoc's output contains the word warning. since Ant 1.9.4No
:footerStringInclude footer text for each page (HTML code)No
:groupStringGroup specified packages together in overview page. The format is as described below-see also the nested group element.No
:headerStringInclude header text for each page (HTML code)No
:helpfileFileSpecifies the HTML help file to useNo
:includenosourcepackagesbooleanIf set to true, packages that don't contain Java source but a package.html will get documented as well. since Ant 1.6.3.No; default is false
:linkStringCreate links to javadoc output at the given URL-see also the nested link element.No
:linkofflineStringLink to docs at url using package list at alt-url by specifying a value url alt-url (space as separator). A shorthand for the nested link element with offline=true.No
:linksourcebooleanGenerate hyperlinks to source files. since Ant 1.6. (yes|no).No; default is no
:localeStringLocale to be used, e.g. en_US or en_US_WINNo
:maxmemoryStringMax amount of memory to allocate to the javadoc JVMNo
:modulenamesStringComma separated list of module names -- see also the nested module element. since Ant 1.10.6At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:modulepathPathSpecify where to find module files since Ant 1.10.6No
:modulepathrefReferenceSpecify where to find module files by reference to a PATH defined elsewhere. since Ant 1.10.6No
:modulesourcepathPathSpecify where to find module source files since Ant 1.10.6No
:modulesourcepathrefReferenceSpecify where to find module source files by reference to a PATH defined elsewhere. since Ant 1.10.6No
:nodeprecatedbooleanDo not include @deprecated informationNo
:nodeprecatedlistbooleanDo not generate deprecated listNo
:nohelpbooleanDo not generate help linkNo
:noindexbooleanDo not generate indexNo
:nonavbarbooleanDo not generate navigation barNo
:noqualifierStringEnables the -noqualifier argument-must be all or a colon separated list of packages. since Ant 1.6.No
:notreebooleanDo not generate class hierarchyNo
:oldbooleanGenerate output using JDK 1.1 emulating doclet. Note: This attribute has no effect unless you're using an pre jdk 1.4 external javadocNo
:overviewFileRead overview documentation from HTML fileNo
:packagebooleanShow package/protected/public classes and membersNo
:packagelistStringThe name of a file containing the packages to processNo
:packagenamesStringComma separated list of package files (with terminating wildcard)-see also the nested package element.No
:postprocessgeneratedjavadocsbooleanWhether to post-process the generated javadocs in order to mitigate CVE-2013-1571. Since Ant 1.9.2 There is a frame injection attack possible in javadocs generated by Oracle JDKs prior to Java 7 update 25 (details). When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them.No; defaults to true
:privatebooleanShow all classes and membersNo
:protectedbooleanShow protected/public classes and members (default)No
:publicbooleanShow only public classes and membersNo
:serialwarnbooleanGenerate warning about @serial tagNo
:sourceStringEnable javadoc to handle Java language features. Set this to 1.4 to document code that compiles using javac -source 1.4, etc.No; default can be provided using the magic ant.build.javac.source property.
:sourcefilesStringComma separated list of source files-see also the nested source element.At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:sourcepathPathSpecify where to find source filesAt least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:sourcepathrefReferenceSpecify where to find source files by reference to a sourcepath defined elsewhere.At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:splitindexbooleanSplit index into one file per letterNo
:stylesheetfileFileSpecifies the CSS stylesheet to useNo
:usebooleanCreate class and package usage pagesNo
:useexternalfilebooleanindicates whether the source file names specified in srcfiles or as nested source elements should be written to a temporary file to make the command line shorter. Also applies to the package names specified via the packagenames attribute or nested package elements. Since Ant 1.7.0, also applies to all the other command line options. (yes|no). If enabled, the file will be written to the temporary directory.No; default is no
:verbosebooleanOutput messages about what javadoc is doingNo
:versionbooleanInclude @version paragraphsNo
:windowtitleStringBrowser window title for the documentation (text)No

Nested elements

  • :arg (Argument)
  • :bootclasspath (Path)
  • :bottom (Html)
  • :classpath (Path)
  • :doclet (DocletInfo)
  • :doctitle (Html)
  • :excludepackage (PackageName)
  • :fileset (FileSet)
  • :footer (Html)
  • :group (GroupArgument)
  • :header (Html)
  • :link (LinkArgument)
  • :module (PackageName)
  • :modulepath (Path)
  • :modulesourcepath (Path)
  • :package (PackageName)
  • :packageset (DirSet)
  • :source (SourceFile)
  • :sourcefiles (ResourceCollectionContainer)
  • :sourcepath (Path)
  • :tag (TagArgument)
  • :taglet (ExtensionInfo)

Reference

https://ant.apache.org/manual/Tasks/javadoc.html

Defined by

org.apache.tools.ant.taskdefs.Javadoc

Generates code documentation using the javadoc tool. The source directory will be
recursively scanned for Java source files to process but only those matching the
inclusion rules, and not matching the exclusions rules will be passed to the javadoc
tool. This allows wildcards to be used to choose between package names, reducing
verbosity and management costs over time. This task, however, has no notion of "changed"
files, unlike the javac task. This means all packages will be processed each time this
task is run. In general, however, this task is used much less frequently. Note: since
javadoc calls System.exit(), javadoc cannot be run inside the same JVM as Apache Ant
without breaking functionality. For this reason, this task always forks JVM. This
overhead is not significant since javadoc is normally a heavy application and will be
called infrequently. Note: the packagelist attribute allows you to specify the list of
packages to document outside of the Ant file. It's a much better practice to include
everything inside the build.xml file. This option was added in order to make it easier
to migrate from regular makefiles, where you would use this option of javadoc. The
packages listed in packagelist are not checked, so the task performs even if some
packages are missing or broken. Use this option if you wish to convert from an existing
makefile. Once things are running you should then switch to the regular notation. Note:
When generating the JavaDocs for classes which contains annotations you maybe get a
java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl. This is due bug
6442982. The cause is that javadoc cannot find the implementations of used annotations.
The workaround is providing the jars with these implementations (like JAXBs @XmlType,
...) to <javadoc> using classpath, classpathref attributes or nested <classpath>
element. Note: many problems with running javadoc stem from command lines that have
become too long-even though the error message doesn't give the slightest hint this may
be the problem. If you encounter problems with the task, try to set the useexternalfile
attribute to true first. If you use multiple ways to specify where javadoc should be
looking for sources, your result will be the union of all specified documentations. If
you, e.g., specify a sourcepath attribute and also a nested packageset both pointing at
the same directory your excludepackagenames attribute won't have any effect unless it
agrees with the exclude patterns of the packageset (and vice versa).

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:access` | `AccessType` | Access mode: one of public, protected, package, or private | No; default is protected |
| `:additionalparam` | `String` | Lets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using &quot;-see also the nested arg element. | No |
| `:author` | `boolean` | Include @author paragraphs | No |
| `:bootclasspath` | `Path` | Override location of class files loaded by the bootstrap class loader | No |
| `:bootclasspathref` | `Reference` | Override location of class files loaded by the bootstrap class loader by reference to a bootclasspath defined elsewhere. | No |
| `:bottom` | `String` | Include bottom text for each page (HTML code) | No |
| `:breakiterator` | `boolean` | Use the new break iterator algorithm. since Ant 1.6. (yes\|no). | No; default is no |
| `:charset` | `String` | Charset for cross-platform viewing of generated documentation | No |
| `:classpath` | `Path` | Specify where to find user class files | No |
| `:classpathref` | `Reference` | Specify where to find user class files by reference to a classpath defined elsewhere. | No |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | Destination directory for output files | Yes, unless a doclet has been specified. |
| `:docencoding` | `String` | Output file encoding name | No |
| `:docfilessubdirs` | `boolean` | Enables deep-copying of doc-files subdirectories. since Ant 1.8.0. | No; defaults to false |
| `:doclet` | `String` | Specifies the class file that starts the doclet used in generating the documentation-see also the nested doclet element. | No |
| `:docletpath` | `Path` | Specifies the path to the doclet class file that is specified with the -doclet option. | No |
| `:docletpathref` | `Reference` | Specifies the path to the doclet class file that is specified with the -doclet option by reference to a path defined elsewhere. | No |
| `:doctitle` | `String` | Include title for the package index (first) page (HTML code) | No |
| `:encoding` | `String` | Source file encoding name | No |
| `:excludedocfilessubdir` | `String` | Colon-separated list of doc-files subdirectories to exclude if docfilessubdirs is true. since Ant 1.8.0. | No |
| `:excludepackagenames` | `String` | comma separated list of packages you don't want docs for-see also the nested excludepackage element. | No |
| `:executable` | `String` | Specify a particular javadoc executable to use in place of the default binary (found in the same JDK as Ant is running in). since Ant 1.6.3. Note: It is up to you to ensure that this command supports the attributes you wish to use. | No |
| `:extdirs` | `Path` | Override location of installed extensions | No |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No |
| `:failonwarning` | `boolean` | Stop the build process if a warning is emitted-i.e. if javadoc's output contains the word warning. since Ant 1.9.4 | No |
| `:footer` | `String` | Include footer text for each page (HTML code) | No |
| `:group` | `String` | Group specified packages together in overview page. The format is as described below-see also the nested group element. | No |
| `:header` | `String` | Include header text for each page (HTML code) | No |
| `:helpfile` | `File` | Specifies the HTML help file to use | No |
| `:includenosourcepackages` | `boolean` | If set to true, packages that don't contain Java source but a package.html will get documented as well. since Ant 1.6.3. | No; default is false |
| `:link` | `String` | Create links to javadoc output at the given URL-see also the nested link element. | No |
| `:linkoffline` | `String` | Link to docs at url using package list at alt-url by specifying a value url alt-url (space as separator). A shorthand for the nested link element with offline=true. | No |
| `:linksource` | `boolean` | Generate hyperlinks to source files. since Ant 1.6. (yes\|no). | No; default is no |
| `:locale` | `String` | Locale to be used, e.g. en_US or en_US_WIN | No |
| `:maxmemory` | `String` | Max amount of memory to allocate to the javadoc JVM | No |
| `:modulenames` | `String` | Comma separated list of module names -- see also the nested module element. since Ant 1.10.6 | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:modulepath` | `Path` | Specify where to find module files since Ant 1.10.6 | No |
| `:modulepathref` | `Reference` | Specify where to find module files by reference to a PATH defined elsewhere. since Ant 1.10.6 | No |
| `:modulesourcepath` | `Path` | Specify where to find module source files since Ant 1.10.6 | No |
| `:modulesourcepathref` | `Reference` | Specify where to find module source files by reference to a PATH defined elsewhere. since Ant 1.10.6 | No |
| `:nodeprecated` | `boolean` | Do not include @deprecated information | No |
| `:nodeprecatedlist` | `boolean` | Do not generate deprecated list | No |
| `:nohelp` | `boolean` | Do not generate help link | No |
| `:noindex` | `boolean` | Do not generate index | No |
| `:nonavbar` | `boolean` | Do not generate navigation bar | No |
| `:noqualifier` | `String` | Enables the -noqualifier argument-must be all or a colon separated list of packages. since Ant 1.6. | No |
| `:notree` | `boolean` | Do not generate class hierarchy | No |
| `:old` | `boolean` | Generate output using JDK 1.1 emulating doclet. Note: This attribute has no effect unless you're using an pre jdk 1.4 external javadoc | No |
| `:overview` | `File` | Read overview documentation from HTML file | No |
| `:package` | `boolean` | Show package/protected/public classes and members | No |
| `:packagelist` | `String` | The name of a file containing the packages to process | No |
| `:packagenames` | `String` | Comma separated list of package files (with terminating wildcard)-see also the nested package element. | No |
| `:postprocessgeneratedjavadocs` | `boolean` | Whether to post-process the generated javadocs in order to mitigate CVE-2013-1571. Since Ant 1.9.2 There is a frame injection attack possible in javadocs generated by Oracle JDKs prior to Java 7 update 25 (details). When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them. | No; defaults to true |
| `:private` | `boolean` | Show all classes and members | No |
| `:protected` | `boolean` | Show protected/public classes and members (default) | No |
| `:public` | `boolean` | Show only public classes and members | No |
| `:serialwarn` | `boolean` | Generate warning about @serial tag | No |
| `:source` | `String` | Enable javadoc to handle Java language features. Set this to 1.4 to document code that compiles using javac -source 1.4, etc. | No; default can be provided using the magic ant.build.javac.source property. |
| `:sourcefiles` | `String` | Comma separated list of source files-see also the nested source element. | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:sourcepath` | `Path` | Specify where to find source files | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:sourcepathref` | `Reference` | Specify where to find source files by reference to a sourcepath defined elsewhere. | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:splitindex` | `boolean` | Split index into one file per letter | No |
| `:stylesheetfile` | `File` | Specifies the CSS stylesheet to use | No |
| `:use` | `boolean` | Create class and package usage pages | No |
| `:useexternalfile` | `boolean` | indicates whether the source file names specified in srcfiles or as nested source elements should be written to a temporary file to make the command line shorter. Also applies to the package names specified via the packagenames attribute or nested package elements. Since Ant 1.7.0, also applies to all the other command line options. (yes\|no). If enabled, the file will be written to the temporary directory. | No; default is no |
| `:verbose` | `boolean` | Output messages about what javadoc is doing | No |
| `:version` | `boolean` | Include @version paragraphs | No |
| `:windowtitle` | `String` | Browser window title for the documentation (text) | No |

**Nested elements**

- `:arg` (`Argument`)
- `:bootclasspath` (`Path`)
- `:bottom` (`Html`)
- `:classpath` (`Path`)
- `:doclet` (`DocletInfo`)
- `:doctitle` (`Html`)
- `:excludepackage` (`PackageName`)
- `:fileset` (`FileSet`)
- `:footer` (`Html`)
- `:group` (`GroupArgument`)
- `:header` (`Html`)
- `:link` (`LinkArgument`)
- `:module` (`PackageName`)
- `:modulepath` (`Path`)
- `:modulesourcepath` (`Path`)
- `:package` (`PackageName`)
- `:packageset` (`DirSet`)
- `:source` (`SourceFile`)
- `:sourcefiles` (`ResourceCollectionContainer`)
- `:sourcepath` (`Path`)
- `:tag` (`TagArgument`)
- `:taglet` (`ExtensionInfo`)

**Reference**

https://ant.apache.org/manual/Tasks/javadoc.html

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc`
sourceraw docstring

javadoc2clj

(javadoc2 & args)

Generates code documentation using the javadoc tool. The source directory will be recursively scanned for Java source files to process but only those matching the inclusion rules, and not matching the exclusions rules will be passed to the javadoc tool. This allows wildcards to be used to choose between package names, reducing verbosity and management costs over time. This task, however, has no notion of "changed" files, unlike the javac task. This means all packages will be processed each time this task is run. In general, however, this task is used much less frequently. Note: since javadoc calls System.exit(), javadoc cannot be run inside the same JVM as Apache Ant without breaking functionality. For this reason, this task always forks JVM. This overhead is not significant since javadoc is normally a heavy application and will be called infrequently. Note: the packagelist attribute allows you to specify the list of packages to document outside of the Ant file. It's a much better practice to include everything inside the build.xml file. This option was added in order to make it easier to migrate from regular makefiles, where you would use this option of javadoc. The packages listed in packagelist are not checked, so the task performs even if some packages are missing or broken. Use this option if you wish to convert from an existing makefile. Once things are running you should then switch to the regular notation. Note: When generating the JavaDocs for classes which contains annotations you maybe get a java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl. This is due bug 6442982. The cause is that javadoc cannot find the implementations of used annotations. The workaround is providing the jars with these implementations (like JAXBs @XmlType, ...) to <javadoc> using classpath, classpathref attributes or nested <classpath> element. Note: many problems with running javadoc stem from command lines that have become too long-even though the error message doesn't give the slightest hint this may be the problem. If you encounter problems with the task, try to set the useexternalfile attribute to true first. If you use multiple ways to specify where javadoc should be looking for sources, your result will be the union of all specified documentations. If you, e.g., specify a sourcepath attribute and also a nested packageset both pointing at the same directory your excludepackagenames attribute won't have any effect unless it agrees with the exclude patterns of the packageset (and vice versa).

Attributes

AttributeTypeDescriptionRequired
:accessAccessTypeAccess mode: one of public, protected, package, or privateNo; default is protected
:additionalparamStringLets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using "-see also the nested arg element.No
:authorbooleanInclude @author paragraphsNo
:bootclasspathPathOverride location of class files loaded by the bootstrap class loaderNo
:bootclasspathrefReferenceOverride location of class files loaded by the bootstrap class loader by reference to a bootclasspath defined elsewhere.No
:bottomStringInclude bottom text for each page (HTML code)No
:breakiteratorbooleanUse the new break iterator algorithm. since Ant 1.6. (yes|no).No; default is no
:charsetStringCharset for cross-platform viewing of generated documentationNo
:classpathPathSpecify where to find user class filesNo
:classpathrefReferenceSpecify where to find user class files by reference to a classpath defined elsewhere.No
:defaultexcludesbooleanindicates whether default excludes should be used (yes|no).No; defaults to yes
:destdirFileDestination directory for output filesYes, unless a doclet has been specified.
:docencodingStringOutput file encoding nameNo
:docfilessubdirsbooleanEnables deep-copying of doc-files subdirectories. since Ant 1.8.0.No; defaults to false
:docletStringSpecifies the class file that starts the doclet used in generating the documentation-see also the nested doclet element.No
:docletpathPathSpecifies the path to the doclet class file that is specified with the -doclet option.No
:docletpathrefReferenceSpecifies the path to the doclet class file that is specified with the -doclet option by reference to a path defined elsewhere.No
:doctitleStringInclude title for the package index (first) page (HTML code)No
:encodingStringSource file encoding nameNo
:excludedocfilessubdirStringColon-separated list of doc-files subdirectories to exclude if docfilessubdirs is true. since Ant 1.8.0.No
:excludepackagenamesStringcomma separated list of packages you don't want docs for-see also the nested excludepackage element.No
:executableStringSpecify a particular javadoc executable to use in place of the default binary (found in the same JDK as Ant is running in). since Ant 1.6.3. Note: It is up to you to ensure that this command supports the attributes you wish to use.No
:extdirsPathOverride location of installed extensionsNo
:failonerrorbooleanStop the build process if the command exits with a return code other than 0.No
:failonwarningbooleanStop the build process if a warning is emitted-i.e. if javadoc's output contains the word warning. since Ant 1.9.4No
:footerStringInclude footer text for each page (HTML code)No
:groupStringGroup specified packages together in overview page. The format is as described below-see also the nested group element.No
:headerStringInclude header text for each page (HTML code)No
:helpfileFileSpecifies the HTML help file to useNo
:includenosourcepackagesbooleanIf set to true, packages that don't contain Java source but a package.html will get documented as well. since Ant 1.6.3.No; default is false
:linkStringCreate links to javadoc output at the given URL-see also the nested link element.No
:linkofflineStringLink to docs at url using package list at alt-url by specifying a value url alt-url (space as separator). A shorthand for the nested link element with offline=true.No
:linksourcebooleanGenerate hyperlinks to source files. since Ant 1.6. (yes|no).No; default is no
:localeStringLocale to be used, e.g. en_US or en_US_WINNo
:maxmemoryStringMax amount of memory to allocate to the javadoc JVMNo
:modulenamesStringComma separated list of module names -- see also the nested module element. since Ant 1.10.6At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:modulepathPathSpecify where to find module files since Ant 1.10.6No
:modulepathrefReferenceSpecify where to find module files by reference to a PATH defined elsewhere. since Ant 1.10.6No
:modulesourcepathPathSpecify where to find module source files since Ant 1.10.6No
:modulesourcepathrefReferenceSpecify where to find module source files by reference to a PATH defined elsewhere. since Ant 1.10.6No
:nodeprecatedbooleanDo not include @deprecated informationNo
:nodeprecatedlistbooleanDo not generate deprecated listNo
:nohelpbooleanDo not generate help linkNo
:noindexbooleanDo not generate indexNo
:nonavbarbooleanDo not generate navigation barNo
:noqualifierStringEnables the -noqualifier argument-must be all or a colon separated list of packages. since Ant 1.6.No
:notreebooleanDo not generate class hierarchyNo
:oldbooleanGenerate output using JDK 1.1 emulating doclet. Note: This attribute has no effect unless you're using an pre jdk 1.4 external javadocNo
:overviewFileRead overview documentation from HTML fileNo
:packagebooleanShow package/protected/public classes and membersNo
:packagelistStringThe name of a file containing the packages to processNo
:packagenamesStringComma separated list of package files (with terminating wildcard)-see also the nested package element.No
:postprocessgeneratedjavadocsbooleanWhether to post-process the generated javadocs in order to mitigate CVE-2013-1571. Since Ant 1.9.2 There is a frame injection attack possible in javadocs generated by Oracle JDKs prior to Java 7 update 25 (details). When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them.No; defaults to true
:privatebooleanShow all classes and membersNo
:protectedbooleanShow protected/public classes and members (default)No
:publicbooleanShow only public classes and membersNo
:serialwarnbooleanGenerate warning about @serial tagNo
:sourceStringEnable javadoc to handle Java language features. Set this to 1.4 to document code that compiles using javac -source 1.4, etc.No; default can be provided using the magic ant.build.javac.source property.
:sourcefilesStringComma separated list of source files-see also the nested source element.At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:sourcepathPathSpecify where to find source filesAt least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:sourcepathrefReferenceSpecify where to find source files by reference to a sourcepath defined elsewhere.At least one of the four or nested <sourcepath>, <fileset>, module or <packageset>
:splitindexbooleanSplit index into one file per letterNo
:stylesheetfileFileSpecifies the CSS stylesheet to useNo
:usebooleanCreate class and package usage pagesNo
:useexternalfilebooleanindicates whether the source file names specified in srcfiles or as nested source elements should be written to a temporary file to make the command line shorter. Also applies to the package names specified via the packagenames attribute or nested package elements. Since Ant 1.7.0, also applies to all the other command line options. (yes|no). If enabled, the file will be written to the temporary directory.No; default is no
:verbosebooleanOutput messages about what javadoc is doingNo
:versionbooleanInclude @version paragraphsNo
:windowtitleStringBrowser window title for the documentation (text)No

Nested elements

  • :arg (Argument)
  • :bootclasspath (Path)
  • :bottom (Html)
  • :classpath (Path)
  • :doclet (DocletInfo)
  • :doctitle (Html)
  • :excludepackage (PackageName)
  • :fileset (FileSet)
  • :footer (Html)
  • :group (GroupArgument)
  • :header (Html)
  • :link (LinkArgument)
  • :module (PackageName)
  • :modulepath (Path)
  • :modulesourcepath (Path)
  • :package (PackageName)
  • :packageset (DirSet)
  • :source (SourceFile)
  • :sourcefiles (ResourceCollectionContainer)
  • :sourcepath (Path)
  • :tag (TagArgument)
  • :taglet (ExtensionInfo)

Reference

https://ant.apache.org/manual/Tasks/javadoc.html

Defined by

org.apache.tools.ant.taskdefs.Javadoc

Generates code documentation using the javadoc tool. The source directory will be
recursively scanned for Java source files to process but only those matching the
inclusion rules, and not matching the exclusions rules will be passed to the javadoc
tool. This allows wildcards to be used to choose between package names, reducing
verbosity and management costs over time. This task, however, has no notion of "changed"
files, unlike the javac task. This means all packages will be processed each time this
task is run. In general, however, this task is used much less frequently. Note: since
javadoc calls System.exit(), javadoc cannot be run inside the same JVM as Apache Ant
without breaking functionality. For this reason, this task always forks JVM. This
overhead is not significant since javadoc is normally a heavy application and will be
called infrequently. Note: the packagelist attribute allows you to specify the list of
packages to document outside of the Ant file. It's a much better practice to include
everything inside the build.xml file. This option was added in order to make it easier
to migrate from regular makefiles, where you would use this option of javadoc. The
packages listed in packagelist are not checked, so the task performs even if some
packages are missing or broken. Use this option if you wish to convert from an existing
makefile. Once things are running you should then switch to the regular notation. Note:
When generating the JavaDocs for classes which contains annotations you maybe get a
java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl. This is due bug
6442982. The cause is that javadoc cannot find the implementations of used annotations.
The workaround is providing the jars with these implementations (like JAXBs @XmlType,
...) to <javadoc> using classpath, classpathref attributes or nested <classpath>
element. Note: many problems with running javadoc stem from command lines that have
become too long-even though the error message doesn't give the slightest hint this may
be the problem. If you encounter problems with the task, try to set the useexternalfile
attribute to true first. If you use multiple ways to specify where javadoc should be
looking for sources, your result will be the union of all specified documentations. If
you, e.g., specify a sourcepath attribute and also a nested packageset both pointing at
the same directory your excludepackagenames attribute won't have any effect unless it
agrees with the exclude patterns of the packageset (and vice versa).

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:access` | `AccessType` | Access mode: one of public, protected, package, or private | No; default is protected |
| `:additionalparam` | `String` | Lets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using &quot;-see also the nested arg element. | No |
| `:author` | `boolean` | Include @author paragraphs | No |
| `:bootclasspath` | `Path` | Override location of class files loaded by the bootstrap class loader | No |
| `:bootclasspathref` | `Reference` | Override location of class files loaded by the bootstrap class loader by reference to a bootclasspath defined elsewhere. | No |
| `:bottom` | `String` | Include bottom text for each page (HTML code) | No |
| `:breakiterator` | `boolean` | Use the new break iterator algorithm. since Ant 1.6. (yes\|no). | No; default is no |
| `:charset` | `String` | Charset for cross-platform viewing of generated documentation | No |
| `:classpath` | `Path` | Specify where to find user class files | No |
| `:classpathref` | `Reference` | Specify where to find user class files by reference to a classpath defined elsewhere. | No |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | Destination directory for output files | Yes, unless a doclet has been specified. |
| `:docencoding` | `String` | Output file encoding name | No |
| `:docfilessubdirs` | `boolean` | Enables deep-copying of doc-files subdirectories. since Ant 1.8.0. | No; defaults to false |
| `:doclet` | `String` | Specifies the class file that starts the doclet used in generating the documentation-see also the nested doclet element. | No |
| `:docletpath` | `Path` | Specifies the path to the doclet class file that is specified with the -doclet option. | No |
| `:docletpathref` | `Reference` | Specifies the path to the doclet class file that is specified with the -doclet option by reference to a path defined elsewhere. | No |
| `:doctitle` | `String` | Include title for the package index (first) page (HTML code) | No |
| `:encoding` | `String` | Source file encoding name | No |
| `:excludedocfilessubdir` | `String` | Colon-separated list of doc-files subdirectories to exclude if docfilessubdirs is true. since Ant 1.8.0. | No |
| `:excludepackagenames` | `String` | comma separated list of packages you don't want docs for-see also the nested excludepackage element. | No |
| `:executable` | `String` | Specify a particular javadoc executable to use in place of the default binary (found in the same JDK as Ant is running in). since Ant 1.6.3. Note: It is up to you to ensure that this command supports the attributes you wish to use. | No |
| `:extdirs` | `Path` | Override location of installed extensions | No |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code other than 0. | No |
| `:failonwarning` | `boolean` | Stop the build process if a warning is emitted-i.e. if javadoc's output contains the word warning. since Ant 1.9.4 | No |
| `:footer` | `String` | Include footer text for each page (HTML code) | No |
| `:group` | `String` | Group specified packages together in overview page. The format is as described below-see also the nested group element. | No |
| `:header` | `String` | Include header text for each page (HTML code) | No |
| `:helpfile` | `File` | Specifies the HTML help file to use | No |
| `:includenosourcepackages` | `boolean` | If set to true, packages that don't contain Java source but a package.html will get documented as well. since Ant 1.6.3. | No; default is false |
| `:link` | `String` | Create links to javadoc output at the given URL-see also the nested link element. | No |
| `:linkoffline` | `String` | Link to docs at url using package list at alt-url by specifying a value url alt-url (space as separator). A shorthand for the nested link element with offline=true. | No |
| `:linksource` | `boolean` | Generate hyperlinks to source files. since Ant 1.6. (yes\|no). | No; default is no |
| `:locale` | `String` | Locale to be used, e.g. en_US or en_US_WIN | No |
| `:maxmemory` | `String` | Max amount of memory to allocate to the javadoc JVM | No |
| `:modulenames` | `String` | Comma separated list of module names -- see also the nested module element. since Ant 1.10.6 | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:modulepath` | `Path` | Specify where to find module files since Ant 1.10.6 | No |
| `:modulepathref` | `Reference` | Specify where to find module files by reference to a PATH defined elsewhere. since Ant 1.10.6 | No |
| `:modulesourcepath` | `Path` | Specify where to find module source files since Ant 1.10.6 | No |
| `:modulesourcepathref` | `Reference` | Specify where to find module source files by reference to a PATH defined elsewhere. since Ant 1.10.6 | No |
| `:nodeprecated` | `boolean` | Do not include @deprecated information | No |
| `:nodeprecatedlist` | `boolean` | Do not generate deprecated list | No |
| `:nohelp` | `boolean` | Do not generate help link | No |
| `:noindex` | `boolean` | Do not generate index | No |
| `:nonavbar` | `boolean` | Do not generate navigation bar | No |
| `:noqualifier` | `String` | Enables the -noqualifier argument-must be all or a colon separated list of packages. since Ant 1.6. | No |
| `:notree` | `boolean` | Do not generate class hierarchy | No |
| `:old` | `boolean` | Generate output using JDK 1.1 emulating doclet. Note: This attribute has no effect unless you're using an pre jdk 1.4 external javadoc | No |
| `:overview` | `File` | Read overview documentation from HTML file | No |
| `:package` | `boolean` | Show package/protected/public classes and members | No |
| `:packagelist` | `String` | The name of a file containing the packages to process | No |
| `:packagenames` | `String` | Comma separated list of package files (with terminating wildcard)-see also the nested package element. | No |
| `:postprocessgeneratedjavadocs` | `boolean` | Whether to post-process the generated javadocs in order to mitigate CVE-2013-1571. Since Ant 1.9.2 There is a frame injection attack possible in javadocs generated by Oracle JDKs prior to Java 7 update 25 (details). When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them. | No; defaults to true |
| `:private` | `boolean` | Show all classes and members | No |
| `:protected` | `boolean` | Show protected/public classes and members (default) | No |
| `:public` | `boolean` | Show only public classes and members | No |
| `:serialwarn` | `boolean` | Generate warning about @serial tag | No |
| `:source` | `String` | Enable javadoc to handle Java language features. Set this to 1.4 to document code that compiles using javac -source 1.4, etc. | No; default can be provided using the magic ant.build.javac.source property. |
| `:sourcefiles` | `String` | Comma separated list of source files-see also the nested source element. | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:sourcepath` | `Path` | Specify where to find source files | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:sourcepathref` | `Reference` | Specify where to find source files by reference to a sourcepath defined elsewhere. | At least one of the four or nested <sourcepath>, <fileset>, module or <packageset> |
| `:splitindex` | `boolean` | Split index into one file per letter | No |
| `:stylesheetfile` | `File` | Specifies the CSS stylesheet to use | No |
| `:use` | `boolean` | Create class and package usage pages | No |
| `:useexternalfile` | `boolean` | indicates whether the source file names specified in srcfiles or as nested source elements should be written to a temporary file to make the command line shorter. Also applies to the package names specified via the packagenames attribute or nested package elements. Since Ant 1.7.0, also applies to all the other command line options. (yes\|no). If enabled, the file will be written to the temporary directory. | No; default is no |
| `:verbose` | `boolean` | Output messages about what javadoc is doing | No |
| `:version` | `boolean` | Include @version paragraphs | No |
| `:windowtitle` | `String` | Browser window title for the documentation (text) | No |

**Nested elements**

- `:arg` (`Argument`)
- `:bootclasspath` (`Path`)
- `:bottom` (`Html`)
- `:classpath` (`Path`)
- `:doclet` (`DocletInfo`)
- `:doctitle` (`Html`)
- `:excludepackage` (`PackageName`)
- `:fileset` (`FileSet`)
- `:footer` (`Html`)
- `:group` (`GroupArgument`)
- `:header` (`Html`)
- `:link` (`LinkArgument`)
- `:module` (`PackageName`)
- `:modulepath` (`Path`)
- `:modulesourcepath` (`Path`)
- `:package` (`PackageName`)
- `:packageset` (`DirSet`)
- `:source` (`SourceFile`)
- `:sourcefiles` (`ResourceCollectionContainer`)
- `:sourcepath` (`Path`)
- `:tag` (`TagArgument`)
- `:taglet` (`ExtensionInfo`)

**Reference**

https://ant.apache.org/manual/Tasks/javadoc.html

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc`
sourceraw docstring

javahclj

(javah & args)

Generates JNI headers from a Java class. When this task executes, it will generate the C header and source files that are needed to implement native methods. If you are building with Java 8 or above consider using javac's nativeheaderdir attribute instead which allows you to compile the classes and generate the native header files in a single step. Note: javah has been deprecated in Java 9 and removed in Java 10. Attempts to use it with Java 10 will fail. It is possible to use different compilers. This can be selected with the implementation attribute or a nested element. Here are the choices of the attribute: default-the default compiler for the platform. sun-the standard compiler of the JDK. kaffeh-the native standard compiler of Kaffe. gcjh-the native standard compiler of gcj and gij. Since Apache Ant 1.8.2 forking-runs the javah executable via its command line interface in a separate process. Default when not running on Kaffe or gcj/gij since Ant 1.9.8 Note: if you are using this task to work on multiple files the command line may become too long on some operating systems. Unfortunately the javah command doesn't support command argument files the way javac (for example) does, so all that can be done is breaking the amount of classes to compile into smaller chunks.

Attributes

AttributeTypeDescriptionRequired
:bootclasspathPathlocation of bootstrap class filesNo
:bootclasspathrefReference
:classStringthe fully-qualified name of the class (or classes, separated by commas)Yes
:classpathPaththe classpath to useNo
:classpathrefReference
:destdirFilesets the directory where javah saves the header files or the stub files.Exactly one of the two
:forcebooleanspecifies that output files should always be written (only when using an external javah of JDK 1.2)No
:implementationStringThe compiler implementation to use. (See the above list of valid compilers.)No; defaults to default compiler for the current JDK
:oldbooleanspecifies that old JDK 1.0-style header files should be generated (otherwise output file contain JNI-style native method function prototypes) (only when using an external javah of JDK 1.2)No
:outputfileFileconcatenates the resulting header or source files for all the classes listed into this fileExactly one of the two
:stubsbooleangenerate C declarations from the Java object file (used with old)No
:verbosebooleancauses javah to print a message concerning the status of the generated filesNo

Nested elements

  • :arg (ImplementationSpecificArgument)
  • :bootclasspath (Path)
  • :class (ClassArgument)
  • :classpath (Path)
  • :fileset (FileSet)
  • :implementationclasspath (Path)

Reference

https://ant.apache.org/manual/Tasks/javah.html

Defined by

org.apache.tools.ant.taskdefs.optional.Javah

Generates JNI headers from a Java class. When this task executes, it will generate the C
header and source files that are needed to implement native methods. If you are building
with Java 8 or above consider using javac's nativeheaderdir attribute instead which
allows you to compile the classes and generate the native header files in a single step.
Note: javah has been deprecated in Java 9 and removed in Java 10. Attempts to use it
with Java 10 will fail. It is possible to use different compilers. This can be selected
with the implementation attribute or a nested element. Here are the choices of the
attribute: default-the default compiler for the platform. sun-the standard compiler of
the JDK. kaffeh-the native standard compiler of Kaffe. gcjh-the native standard compiler
of gcj and gij. Since Apache Ant 1.8.2 forking-runs the javah executable via its command
line interface in a separate process. Default when not running on Kaffe or gcj/gij since
Ant 1.9.8 Note: if you are using this task to work on multiple files the command line
may become too long on some operating systems. Unfortunately the javah command doesn't
support command argument files the way javac (for example) does, so all that can be done
is breaking the amount of classes to compile into smaller chunks.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bootclasspath` | `Path` | location of bootstrap class files | No |
| `:bootclasspathref` | `Reference` |  |  |
| `:class` | `String` | the fully-qualified name of the class (or classes, separated by commas) | Yes |
| `:classpath` | `Path` | the classpath to use | No |
| `:classpathref` | `Reference` |  |  |
| `:destdir` | `File` | sets the directory where javah saves the header files or the stub files. | Exactly one of the two |
| `:force` | `boolean` | specifies that output files should always be written (only when using an external javah of JDK 1.2) | No |
| `:implementation` | `String` | The compiler implementation to use. (See the above list of valid compilers.) | No; defaults to default compiler for the current JDK |
| `:old` | `boolean` | specifies that old JDK 1.0-style header files should be generated (otherwise output file contain JNI-style native method function prototypes) (only when using an external javah of JDK 1.2) | No |
| `:outputfile` | `File` | concatenates the resulting header or source files for all the classes listed into this file | Exactly one of the two |
| `:stubs` | `boolean` | generate C declarations from the Java object file (used with old) | No |
| `:verbose` | `boolean` | causes javah to print a message concerning the status of the generated files | No |

**Nested elements**

- `:arg` (`ImplementationSpecificArgument`)
- `:bootclasspath` (`Path`)
- `:class` (`ClassArgument`)
- `:classpath` (`Path`)
- `:fileset` (`FileSet`)
- `:implementationclasspath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/javah.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Javah`
sourceraw docstring

javaresourceclj

(javaresource & args)

Ant type javaresource. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:directoryboolean
:existsboolean
:lastmodifiedlong
:loaderrefReference
:nameString
:parentfirstboolean
:refidReference
:sizelong

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Types/javaresource.html

Defined by

org.apache.tools.ant.types.resources.JavaResource

Ant type javaresource. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:loaderref` | `Reference` |  |  |
| `:name` | `String` |  |  |
| `:parentfirst` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Types/javaresource.html

**Defined by**

`org.apache.tools.ant.types.resources.JavaResource`
sourceraw docstring

jbossclj

(jboss & args)

Ant nested jboss. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:destdirFile
:genericjarsuffixString
:suffixString

Nested elements

  • :classpath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool

Ant nested jboss. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:destdir` | `File` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:suffix` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool`
sourceraw docstring

jjdocclj

(jjdoc & args)

Invokes the JJDoc preprocessor for the JavaCC compiler compiler. It takes a JavaCC parser specification and produces documentation for the BNF grammar. It can operate in three modes, determined by command line options. To use the jjdoc task, set the target attribute to the name of the JavaCC grammar file to process. You also need to specify the directory containing the JavaCC installation using the javacchome attribute, so that Ant can find the JavaCC classes. Optionally, you can also set the outputfile to write the generated BNF documentation file to a specific (directory and) file. Otherwise jjdoc writes the generated BNF documentation file as the JavaCC grammar file with a suffix .txt or .html. This task only invokes JJDoc if the grammar file is newer than the generated BNF documentation file.

Attributes

AttributeTypeDescriptionRequired
:javacchomeFileThe directory containing the JavaCC distribution.Yes
:maxmemoryStringMax amount of memory to allocate to the forked JVM. since Ant 1.8.3No
:onetablebooleanSets the ONE_TABLE BNF documentation option. This is a boolean option.No
:outputfileStringThe file to write the generated BNF documentation file to. If not set, the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txtNo
:targetFileThe JavaCC grammar file to process.Yes
:textbooleanSets the TEXT BNF documentation option. This is a boolean option.No

Reference

https://ant.apache.org/manual/Tasks/jjdoc.html

Defined by

org.apache.tools.ant.taskdefs.optional.javacc.JJDoc

Invokes the JJDoc preprocessor for the JavaCC compiler compiler. It takes a JavaCC
parser specification and produces documentation for the BNF grammar. It can operate in
three modes, determined by command line options. To use the jjdoc task, set the target
attribute to the name of the JavaCC grammar file to process. You also need to specify
the directory containing the JavaCC installation using the javacchome attribute, so that
Ant can find the JavaCC classes. Optionally, you can also set the outputfile to write
the generated BNF documentation file to a specific (directory and) file. Otherwise jjdoc
writes the generated BNF documentation file as the JavaCC grammar file with a suffix
.txt or .html. This task only invokes JJDoc if the grammar file is newer than the
generated BNF documentation file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:javacchome` | `File` | The directory containing the JavaCC distribution. | Yes |
| `:maxmemory` | `String` | Max amount of memory to allocate to the forked JVM. since Ant 1.8.3 | No |
| `:onetable` | `boolean` | Sets the ONE_TABLE BNF documentation option. This is a boolean option. | No |
| `:outputfile` | `String` | The file to write the generated BNF documentation file to. If not set, the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt | No |
| `:target` | `File` | The JavaCC grammar file to process. | Yes |
| `:text` | `boolean` | Sets the TEXT BNF documentation option. This is a boolean option. | No |

**Reference**

https://ant.apache.org/manual/Tasks/jjdoc.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.javacc.JJDoc`
sourceraw docstring

jjtreeclj

(jjtree & args)

Invokes the JJTree preprocessor for the JavaCC compiler compiler. It inserts parse tree building actions at various places in the JavaCC source that it generates. The output of JJTree is run through JavaCC to create the parser. To use the jjtree task, set the target attribute to the name of the JJTree grammar file to process. You also need to specify the directory containing the JavaCC installation using the javacchome attribute, so that Ant can find the JavaCC classes. Optionally, you can also set the outputdirectory to write the generated JavaCC grammar and node files to a specific directory. Otherwise jjtree writes the generated JavaCC grammar and node files to the directory containing the JJTree grammar file. As an extra option, you can also set the outputfile to write the generated JavaCC grammar file to a specific (directory and) file. Otherwise jjtree writes the generated JavaCC grammar file as the JJTree grammar file with a suffix .jj. This task only invokes JJTree if the grammar file is newer than the generated JavaCC file.

Attributes

AttributeTypeDescriptionRequired
:buildnodefilesbooleanSets the BUILD_NODE_FILES grammar option. This is a boolean option.No
:javacchomeFileThe directory containing the JavaCC distribution.Yes
:maxmemoryStringMax amount of memory to allocate to the forked JVM. since Ant 1.8.3No
:multibooleanSets the MULTI grammar option. This is a boolean option.No
:nodedefaultvoidbooleanSets the NODE_DEFAULT_VOID grammar option. This is a boolean option.No
:nodefactorybooleanSets the NODE_FACTORY grammar option. This is boolean option.No
:nodepackageStringSets the NODE_PACKAGE grammar option. This is a string option.No
:nodeprefixStringSets the NODE_PREFIX grammar option. This is a string option.No
:nodescopehookbooleanSets the NODE_SCOPE_HOOK grammar option. This is a boolean option.No
:nodeusesparserbooleanSets the NODE_USES_PARSER grammar option. This is a boolean option.No
:outputdirectoryFileThe directory to write the generated JavaCC grammar and node files to. If not set, the files are written to the directory containing the grammar file.No
:outputfileStringThe file to write the generated JavaCC grammar file to. If not set, the file is written with the same name as the JJTree grammar file but with a the suffix .jj. This is a filename relative to outputdirectory if specified, the project's basedir.No
:staticbooleanSets the STATIC grammar option. This is a boolean option.No
:targetFileThe JJTree grammar file to process.Yes
:visitorbooleanSets the VISITOR grammar option. This is a boolean option.No
:visitorexceptionStringSets the VISITOR_EXCEPTION grammar option. This is a string option.No

Reference

https://ant.apache.org/manual/Tasks/jjtree.html

Defined by

org.apache.tools.ant.taskdefs.optional.javacc.JJTree

Invokes the JJTree preprocessor for the JavaCC compiler compiler. It inserts parse tree
building actions at various places in the JavaCC source that it generates. The output of
JJTree is run through JavaCC to create the parser. To use the jjtree task, set the
target attribute to the name of the JJTree grammar file to process. You also need to
specify the directory containing the JavaCC installation using the javacchome attribute,
so that Ant can find the JavaCC classes. Optionally, you can also set the
outputdirectory to write the generated JavaCC grammar and node files to a specific
directory. Otherwise jjtree writes the generated JavaCC grammar and node files to the
directory containing the JJTree grammar file. As an extra option, you can also set the
outputfile to write the generated JavaCC grammar file to a specific (directory and)
file. Otherwise jjtree writes the generated JavaCC grammar file as the JJTree grammar
file with a suffix .jj. This task only invokes JJTree if the grammar file is newer than
the generated JavaCC file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:buildnodefiles` | `boolean` | Sets the BUILD_NODE_FILES grammar option. This is a boolean option. | No |
| `:javacchome` | `File` | The directory containing the JavaCC distribution. | Yes |
| `:maxmemory` | `String` | Max amount of memory to allocate to the forked JVM. since Ant 1.8.3 | No |
| `:multi` | `boolean` | Sets the MULTI grammar option. This is a boolean option. | No |
| `:nodedefaultvoid` | `boolean` | Sets the NODE_DEFAULT_VOID grammar option. This is a boolean option. | No |
| `:nodefactory` | `boolean` | Sets the NODE_FACTORY grammar option. This is boolean option. | No |
| `:nodepackage` | `String` | Sets the NODE_PACKAGE grammar option. This is a string option. | No |
| `:nodeprefix` | `String` | Sets the NODE_PREFIX grammar option. This is a string option. | No |
| `:nodescopehook` | `boolean` | Sets the NODE_SCOPE_HOOK grammar option. This is a boolean option. | No |
| `:nodeusesparser` | `boolean` | Sets the NODE_USES_PARSER grammar option. This is a boolean option. | No |
| `:outputdirectory` | `File` | The directory to write the generated JavaCC grammar and node files to. If not set, the files are written to the directory containing the grammar file. | No |
| `:outputfile` | `String` | The file to write the generated JavaCC grammar file to. If not set, the file is written with the same name as the JJTree grammar file but with a the suffix .jj. This is a filename relative to outputdirectory if specified, the project's basedir. | No |
| `:static` | `boolean` | Sets the STATIC grammar option. This is a boolean option. | No |
| `:target` | `File` | The JJTree grammar file to process. | Yes |
| `:visitor` | `boolean` | Sets the VISITOR grammar option. This is a boolean option. | No |
| `:visitorexception` | `String` | Sets the VISITOR_EXCEPTION grammar option. This is a string option. | No |

**Reference**

https://ant.apache.org/manual/Tasks/jjtree.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.javacc.JJTree`
sourceraw docstring

(jlink & args)

For a task based on the JDK's jlink tool, see Link. This task is for something else entirely. Links entries from sub-builds and libraries. The jlink task can be used to build jar and zip files, similar to the jar task. However, jlink provides options for controlling the way entries from input files are added to the output file. Specifically, capabilities for merging entries from multiple zip or jar files is available. If a mergefile is specified directly (eg. at the top level of a mergefiles pathelement) and the mergefile ends in .zip or .jar, entries in the mergefile will be merged into the outfile. A file with any other extension will be added to the output file, even if it is specified in the mergefiles element. Directories specified in either the mergefiles or addfiles element are added to the output file as you would expect: all files in subdirectories are recursively added to the output file with appropriate prefixes in the output file (without merging). In the case where duplicate entries and/or files are found among the files to be merged or added, jlink merges or adds the first entry and ignores all subsequent entries. jlink ignores META-INF directories in mergefiles. Users should supply their own manifest information for the output file. It is possible to refine the set of files that are being jlinked. This can be done with the includes, includesfile, excludes, excludesfile, and defaultexcludes attributes on the addfiles and mergefiles nested elements. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. The patterns are relative to the base directory.

Attributes

AttributeTypeDescriptionRequired
:addfilesPathfiles to be added to the output.Exactly one of the two
:casesensitiveboolean
:compressbooleanwhether or not the output should be compressed. true, yes, or on result in compressed output.No; defaults to uncompressed (inflated) output
:defaultexcludesboolean
:excludesString
:excludesfileFile
:followsymlinksboolean
:includesString
:includesfileFile
:mergefilesPathfiles to be merged into the output, if possible.Exactly one of the two
:outfileFilethe path of the output file.Yes

Nested elements

  • :addfiles (Path)
  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :mergefiles (Path)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/jlink.html

Defined by

org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask

For a task based on the JDK's jlink tool, see Link. This task is for something else
entirely. Links entries from sub-builds and libraries. The jlink task can be used to
build jar and zip files, similar to the jar task. However, jlink provides options for
controlling the way entries from input files are added to the output file. Specifically,
capabilities for merging entries from multiple zip or jar files is available. If a
mergefile is specified directly (eg. at the top level of a mergefiles pathelement) and
the mergefile ends in .zip or .jar, entries in the mergefile will be merged into the
outfile. A file with any other extension will be added to the output file, even if it is
specified in the mergefiles element. Directories specified in either the mergefiles or
addfiles element are added to the output file as you would expect: all files in
subdirectories are recursively added to the output file with appropriate prefixes in the
output file (without merging). In the case where duplicate entries and/or files are
found among the files to be merged or added, jlink merges or adds the first entry and
ignores all subsequent entries. jlink ignores META-INF directories in mergefiles. Users
should supply their own manifest information for the output file. It is possible to
refine the set of files that are being jlinked. This can be done with the includes,
includesfile, excludes, excludesfile, and defaultexcludes attributes on the addfiles and
mergefiles nested elements. With the includes or includesfile attribute you specify the
files you want to have included by using patterns. The exclude or excludesfile attribute
is used to specify the files you want to have excluded. This is also done with patterns.
And finally with the defaultexcludes attribute, you can specify whether you want to use
default exclusions or not. See the section on directory based tasks, on how the
inclusion/exclusion of files works, and how to write patterns. The patterns are relative
to the base directory.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:addfiles` | `Path` | files to be added to the output. | Exactly one of the two |
| `:casesensitive` | `boolean` |  |  |
| `:compress` | `boolean` | whether or not the output should be compressed. true, yes, or on result in compressed output. | No; defaults to uncompressed (inflated) output |
| `:defaultexcludes` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:mergefiles` | `Path` | files to be merged into the output, if possible. | Exactly one of the two |
| `:outfile` | `File` | the path of the output file. | Yes |

**Nested elements**

- `:addfiles` (`Path`)
- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:mergefiles` (`Path`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/jlink.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask`
sourceraw docstring

jmodclj

(jmod & args)

Creates a linkable jmod file from a modular jar file, and optionally from other application files such as native libraries and license documents. Equivalent to the JDK's jmod tool. Requires Java 9 or later.

Attributes

AttributeTypeDescriptionRequired
:classpathPathFiles to be placed in the jmod file. Usually a single module.One of these is required, unless a nested <classpath> is present.
:classpathrefReferenceFiles to be placed in the jmod file, given as a reference to a path defined elsewhere.One of these is required, unless a nested <classpath> is present.
:commandpathPathDirectories containing native commands to include in jmod.No
:commandpathrefReferenceDirectories containing native commands to include in jmod, given as a reference to a path defined elsewhere.No
:configpathPathDirectories containing user-editable configuration files to include in jmod.No
:configpathrefReferenceDirectories containing user-editable configuration files to include in jmod, given as a reference to a path defined elsewhere.No
:destfileFilejmod file to create.Yes
:hashmodulespatternStringRegular expression for names of modules in the module path which depend on the jmod being created, and which should have hashes generated for them and included in the new jmod.No
:headerpathPathDirectories containing header files to include in jmod.No
:headerpathrefReferenceDirectories containing header files to include in jmod, given as a reference to a path defined elsewhere.No
:legalpathPathDirectories containing legal licenses and notices to include in jmod.No
:legalpathrefReferenceDirectories containing legal licenses and notices to include in jmod, given as a reference to a path defined elsewhere.No
:mainclassStringClass that acts as executable entry point of module.No
:manpathPathDirectories containing man pages to include in jmod.No
:manpathrefReferenceDirectories containing man pages to include in jmod, given as a reference to a path defined elsewhere.No
:modulepathPathLocations of modules on which classpath modules depend.No
:modulepathrefReferenceLocations of modules on which classpath modules depend, given as a reference to a path defined elsewhere.No
:modulewarningsStringWhether to emit warnings when resolving modules which are not recommended for use. Comma-separated list of one of more of the following: deprecated Warn if module is deprecated leaving Warn if module is deprecated for removal incubating Warn if module is an incubating (not yet official) moduleNo, default is no warnings.
:nativelibpathPathDirectories containing native libraries to include in jmod.No
:nativelibpathrefReferenceDirectories containing native libraries to include in jmod, given as a reference to a path defined elsewhere.No
:platformStringThe target platform for the jmod. Typically takes the form OS-architecture. A particular JDK's platform can be seen by running a command like jmod describe $JDK_HOME/jmods/java.base.jmod | grep -i platformNo
:resolvebydefaultbooleanBoolean indicating whether the jmod should be one of the default resolved modules when it is in a module path searched by tools and applications.No. Default is true.
:versionStringModule version of jmod.No

Nested elements

  • :classpath (Path)
  • :commandpath (Path)
  • :configpath (Path)
  • :headerpath (Path)
  • :legalpath (Path)
  • :manpath (Path)
  • :modulepath (Path)
  • :modulewarning (ResolutionWarningSpec)
  • :nativelibpath (Path)
  • :version (ModuleVersion)

Reference

https://ant.apache.org/manual/Tasks/jmod.html

Defined by

org.apache.tools.ant.taskdefs.modules.Jmod

Creates a linkable jmod file from a modular jar file, and optionally from other
application files such as native libraries and license documents. Equivalent to the
JDK's jmod tool. Requires Java 9 or later.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` | Files to be placed in the jmod file. Usually a single module. | One of these is required, unless a nested <classpath> is present. |
| `:classpathref` | `Reference` | Files to be placed in the jmod file, given as a reference to a path defined elsewhere. | One of these is required, unless a nested <classpath> is present. |
| `:commandpath` | `Path` | Directories containing native commands to include in jmod. | No |
| `:commandpathref` | `Reference` | Directories containing native commands to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:configpath` | `Path` | Directories containing user-editable configuration files to include in jmod. | No |
| `:configpathref` | `Reference` | Directories containing user-editable configuration files to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:destfile` | `File` | jmod file to create. | Yes |
| `:hashmodulespattern` | `String` | Regular expression for names of modules in the module path which depend on the jmod being created, and which should have hashes generated for them and included in the new jmod. | No |
| `:headerpath` | `Path` | Directories containing header files to include in jmod. | No |
| `:headerpathref` | `Reference` | Directories containing header files to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:legalpath` | `Path` | Directories containing legal licenses and notices to include in jmod. | No |
| `:legalpathref` | `Reference` | Directories containing legal licenses and notices to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:mainclass` | `String` | Class that acts as executable entry point of module. | No |
| `:manpath` | `Path` | Directories containing man pages to include in jmod. | No |
| `:manpathref` | `Reference` | Directories containing man pages to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:modulepath` | `Path` | Locations of modules on which classpath modules depend. | No |
| `:modulepathref` | `Reference` | Locations of modules on which classpath modules depend, given as a reference to a path defined elsewhere. | No |
| `:modulewarnings` | `String` | Whether to emit warnings when resolving modules which are not recommended for use. Comma-separated list of one of more of the following: deprecated Warn if module is deprecated leaving Warn if module is deprecated for removal incubating Warn if module is an incubating (not yet official) module | No, default is no warnings. |
| `:nativelibpath` | `Path` | Directories containing native libraries to include in jmod. | No |
| `:nativelibpathref` | `Reference` | Directories containing native libraries to include in jmod, given as a reference to a path defined elsewhere. | No |
| `:platform` | `String` | The target platform for the jmod. Typically takes the form OS-architecture. A particular JDK's platform can be seen by running a command like jmod describe $JDK_HOME/jmods/java.base.jmod \| grep -i platform | No |
| `:resolvebydefault` | `boolean` | Boolean indicating whether the jmod should be one of the default resolved modules when it is in a module path searched by tools and applications. | No. Default is true. |
| `:version` | `String` | Module version of jmod. | No |

**Nested elements**

- `:classpath` (`Path`)
- `:commandpath` (`Path`)
- `:configpath` (`Path`)
- `:headerpath` (`Path`)
- `:legalpath` (`Path`)
- `:manpath` (`Path`)
- `:modulepath` (`Path`)
- `:modulewarning` (`ResolutionWarningSpec`)
- `:nativelibpath` (`Path`)
- `:version` (`ModuleVersion`)

**Reference**

https://ant.apache.org/manual/Tasks/jmod.html

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Jmod`
sourceraw docstring

jonasclj

(jonas & args)

Ant nested jonas. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:additionalargsString
:classpathPath
:destdirFile
:genericjarsuffixString
:jarsuffixString
:javacString
:javacoptsString
:jonasrootFile
:keepgeneratedboolean
:keepgenericboolean
:nocompilboolean
:nogenicboolean
:novalidationboolean
:orbString
:rmicoptsString
:secpropagboolean
:verboseboolean

Nested elements

  • :classpath (Path)

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool

Ant nested jonas. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:additionalargs` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:destdir` | `File` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:jarsuffix` | `String` |  |  |
| `:javac` | `String` |  |  |
| `:javacopts` | `String` |  |  |
| `:jonasroot` | `File` |  |  |
| `:keepgenerated` | `boolean` |  |  |
| `:keepgeneric` | `boolean` |  |  |
| `:nocompil` | `boolean` |  |  |
| `:nogenic` | `boolean` |  |  |
| `:novalidation` | `boolean` |  |  |
| `:orb` | `String` |  |  |
| `:rmicopts` | `String` |  |  |
| `:secpropag` | `boolean` |  |  |
| `:verbose` | `boolean` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool`
sourceraw docstring

jspcclj

(jspc & args)

Apache Ant task to run the JSP compiler and turn JSP pages into Java source files. This task can be used to precompile JSP pages for fast initial invocation of JSP pages, deployment on a server without the full JDK installed, or simply to syntax check the pages without deploying them. In most cases, a javac task is usually the next stage in the build process. The task does basic dependency checking to prevent unnecessary recompilation-this checking compares source and destination timestamps, and does not factor in class or taglib dependencies, or jsp:include references. By default the task uses the Jasper JSP compiler. This means the task needs jasper.jar and jasper-runtime.jar, which come with builds of Tomcat 4/Catalina from the Apache Tomcat project, and any other jar files which may be needed in future versions (it changes). We recommend (in March 2003) Tomcat version 4.1.x for the most robust version of Jasper. There are many limitations with this task which partially stem from the many versions of Jasper, others from implementation 'issues' in the task (i.e. nobody's willingness to radically change large bits of it to work around Jasper). Because of this and the fact that JSP pages do not have to be portable across implementations-or versions of implementations-this task is better used for validating JSP pages before deployment, rather than precompiling them. For the latter, just deploy and run your HttpUnit JUnit tests after deployment to compile and test your pages, all in one go.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:classpathPathThe classpath to use to run the JSP compiler.No, but it seems to work better when used; can also be specified by the nested element classpath
:classpathrefReferenceA Reference. As per classpath.No
:compilerStringClass name of JSP compiler adapter to use.No; defaults to the standard adapter for Jasper
:compilerclasspathPathThe classpath used to find the compiler adapter specified by the compiler attribute.No
:defaultexcludesboolean
:destdirFileWhere to place the generated files. They are located under here according to the given package name.Yes
:excludesString
:excludesfileFile
:failonerrorbooleanflag to control action on compile failures.No; default yes
:followsymlinksboolean
:iepluginStringJava Plugin classid for Internet Explorer.No
:includesString
:includesfileFile
:mappedboolean(boolean) Generate separate write() calls for each HTML line in the JSP.No
:packageStringName of the destination package for generated Java classes.No
:srcdirPathWhere to look for source JSP files.Yes
:uribaseFileThe context of relative URI references in JSP.No; derived from the location of the file relative to the declared or derived value of uriroot
:urirootFileThe root directory that URIs should be resolved against.No
:verboseintThe verbosity integer to pass to the compiler.No; default 0
:webincFileOutput file name for the fraction of web.xml that lists servlets.No
:webxmlFileFile name for web.xml to be generatedNo

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :compilerclasspath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)
  • :webapp (WebAppParameter)

Reference

https://ant.apache.org/manual/Tasks/jspc.html

Defined by

org.apache.tools.ant.taskdefs.optional.jsp.JspC

Apache Ant task to run the JSP compiler and turn JSP pages into Java source files. This
task can be used to precompile JSP pages for fast initial invocation of JSP pages,
deployment on a server without the full JDK installed, or simply to syntax check the
pages without deploying them. In most cases, a javac task is usually the next stage in
the build process. The task does basic dependency checking to prevent unnecessary
recompilation-this checking compares source and destination timestamps, and does not
factor in class or taglib dependencies, or <jsp:include> references. By default the task
uses the Jasper JSP compiler. This means the task needs jasper.jar and
jasper-runtime.jar, which come with builds of Tomcat 4/Catalina from the Apache Tomcat
project, and any other jar files which may be needed in future versions (it changes). We
recommend (in March 2003) Tomcat version 4.1.x for the most robust version of Jasper.
There are many limitations with this task which partially stem from the many versions of
Jasper, others from implementation 'issues' in the task (i.e. nobody's willingness to
radically change large bits of it to work around Jasper). Because of this and the fact
that JSP pages do not have to be portable across implementations-or versions of
implementations-this task is better used for validating JSP pages before deployment,
rather than precompiling them. For the latter, just deploy and run your HttpUnit JUnit
tests after deployment to compile and test your pages, all in one go.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | The classpath to use to run the JSP compiler. | No, but it seems to work better when used; can also be specified by the nested element classpath |
| `:classpathref` | `Reference` | A Reference. As per classpath. | No |
| `:compiler` | `String` | Class name of JSP compiler adapter to use. | No; defaults to the standard adapter for Jasper |
| `:compilerclasspath` | `Path` | The classpath used to find the compiler adapter specified by the compiler attribute. | No |
| `:defaultexcludes` | `boolean` |  |  |
| `:destdir` | `File` | Where to place the generated files. They are located under here according to the given package name. | Yes |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:failonerror` | `boolean` | flag to control action on compile failures. | No; default yes |
| `:followsymlinks` | `boolean` |  |  |
| `:ieplugin` | `String` | Java Plugin classid for Internet Explorer. | No |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:mapped` | `boolean` | (boolean) Generate separate write() calls for each HTML line in the JSP. | No |
| `:package` | `String` | Name of the destination package for generated Java classes. | No |
| `:srcdir` | `Path` | Where to look for source JSP files. | Yes |
| `:uribase` | `File` | The context of relative URI references in JSP. | No; derived from the location of the file relative to the declared or derived value of uriroot |
| `:uriroot` | `File` | The root directory that URIs should be resolved against. | No |
| `:verbose` | `int` | The verbosity integer to pass to the compiler. | No; default 0 |
| `:webinc` | `File` | Output file name for the fraction of web.xml that lists servlets. | No |
| `:webxml` | `File` | File name for web.xml to be generated | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:compilerclasspath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)
- `:webapp` (`WebAppParameter`)

**Reference**

https://ant.apache.org/manual/Tasks/jspc.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.jsp.JspC`
sourceraw docstring

jvmargclj

(jvmarg & args)

Ant nested jvmarg. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:lineString
:pathPath
:pathrefReference
:prefixString
:suffixString
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Argument

Ant nested jvmarg. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:line` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Argument`
sourceraw docstring

lastclj

(last & args)

Ant type last. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:countint
:refidReference

Reference

https://ant.apache.org/manual/Types/last.html

Defined by

org.apache.tools.ant.types.resources.Last

Ant type last. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:count` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/last.html

**Defined by**

`org.apache.tools.ant.types.resources.Last`
sourceraw docstring

launcherclj

(launcher & args)

Ant nested launcher. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:mainclassString
:moduleString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$Launcher

Ant nested launcher. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:mainclass` | `String` |  |  |
| `:module` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$Launcher`
sourceraw docstring

legalpathclj

(legalpath & args)

Ant nested legalpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested legalpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

lengthclj

(length & args)

Display or set a property containing length information for a string, a file, or one or more nested resource collections. Can also be used as a condition.

Attributes

AttributeTypeDescriptionRequired
:fileFileSingle file whose length to report.One of these, or one or more nested filesets
:lengthlongComparison length.Ignored
:modeFileModeFile length mode; when all the resulting value is the sum of all included resources' lengths; when each the task outputs the absolute path and length of each included resource, one per line.No; default is all
:propertyStringThe property to set.No; by default, output value to the log
:resourceResourceSingle resource whose length to report (using extended properties handling). Since Ant 1.8.1One of these, or one or more nested filesets
:stringStringThe string whose length to report.One of these, or one or more nested filesets
:trimbooleanWhether to trim when operating on a string.No; default is false, ignored unless string is set
:whenWhenComparison type: equal, eq, greater, gt, less, lt, ge (greater or equal), ne (not equal), le (less or equal).No; default is equal

Reference

https://ant.apache.org/manual/Tasks/length.html

Defined by

org.apache.tools.ant.taskdefs.Length

Display or set a property containing length information for a string, a file, or one or
more nested resource collections. Can also be used as a condition.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | Single file whose length to report. | One of these, or one or more nested filesets |
| `:length` | `long` | Comparison length. | Ignored |
| `:mode` | `FileMode` | File length mode; when all the resulting value is the sum of all included resources' lengths; when each the task outputs the absolute path and length of each included resource, one per line. | No; default is all |
| `:property` | `String` | The property to set. | No; by default, output value to the log |
| `:resource` | `Resource` | Single resource whose length to report (using extended properties handling). Since Ant 1.8.1 | One of these, or one or more nested filesets |
| `:string` | `String` | The string whose length to report. | One of these, or one or more nested filesets |
| `:trim` | `boolean` | Whether to trim when operating on a string. | No; default is false, ignored unless string is set |
| `:when` | `When` | Comparison type: equal, eq, greater, gt, less, lt, ge (greater or equal), ne (not equal), le (less or equal). | No; default is equal |

**Reference**

https://ant.apache.org/manual/Tasks/length.html

**Defined by**

`org.apache.tools.ant.taskdefs.Length`
sourceraw docstring

libclj

(lib & args)

Ant nested lib. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeString
:encodingString
:erroronmissingarchiveboolean
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeString
:followsymlinksboolean
:fullpathString
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixString
:refidReference
:srcFile
:srcresourceResource

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ZipFileSet

Ant nested lib. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` |  |  |
| `:encoding` | `String` |  |  |
| `:erroronmissingarchive` | `boolean` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:src` | `File` |  |  |
| `:srcresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ZipFileSet`
sourceraw docstring

libfilesetclj

(libfileset & args)

Ant type libfileset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includeimplboolean
:includesString
:includesfileFile
:includeurlboolean
:maxlevelsofsymlinksint
:refidReference
:urlbaseString

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/libfileset.html

Defined by

org.apache.tools.ant.taskdefs.optional.extension.LibFileSet

Ant type libfileset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includeimpl` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:includeurl` | `boolean` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |
| `:urlbase` | `String` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/libfileset.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.LibFileSet`
sourceraw docstring

linecontainsclj

(linecontains & args)

Ant nested linecontains. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:matchanyboolean
:negateboolean

Nested elements

  • :contains (Contains)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.LineContains

Ant nested linecontains. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:matchany` | `boolean` |  |  |
| `:negate` | `boolean` |  |  |

**Nested elements**

- `:contains` (`Contains`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.LineContains`
sourceraw docstring

linecontainsregexpclj

(linecontainsregexp & args)

Ant nested linecontainsregexp. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:negateboolean
:regexpString

Nested elements

  • :regexp (RegularExpression)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.LineContainsRegExp

Ant nested linecontainsregexp. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:negate` | `boolean` |  |  |
| `:regexp` | `String` |  |  |

**Nested elements**

- `:regexp` (`RegularExpression`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.LineContainsRegExp`
sourceraw docstring

linetokenizerclj

(linetokenizer & args)

Ant type linetokenizer. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:includedelimsboolean

Reference

https://ant.apache.org/manual/Types/linetokenizer.html

Defined by

org.apache.tools.ant.util.LineTokenizer

Ant type linetokenizer. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:includedelims` | `boolean` |  |  |

**Reference**

https://ant.apache.org/manual/Types/linetokenizer.html

**Defined by**

`org.apache.tools.ant.util.LineTokenizer`
sourceraw docstring

(link & args)

Assembles jmod files into an executable image. Equivalent to the JDK's jlink tool. Requires Java 9 or later.

Attributes

AttributeTypeDescriptionRequired
:bindservicesbooleanBoolean, whether to include in linked image any service providers found in module path corresponding to service provider interfaces used by explicitly linked modules.No, default is false
:checkduplicatelegalbooleanBoolean. When merging legal notices from different modules because they have the same name, verify that their contents are identical.No, default is false, which means any license files with the same name are assumed to have the same content, and no checking is done.
:compressCompressionLevelCompression level of linked image. One of: 0 or none no compression (default) 1 or strings constant string sharing 2 or zip zip compressionNo, default is no compression
:debugbooleanBoolean, whether to include debug information.No, default is true
:destdirFileRoot directory of created image.Yes
:endiannessEndiannessByte order of linked image, must be little or big No, default is native byte order
:excludefilesStringComma-separated list of patterns specifying files to exclude from linked image. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one file name per line.No
:excluderesourcesStringComma-separated list of patterns specifying resources to exclude from source jmods. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one resource name per line.No
:ignoresigningbooleanBoolean, whether to allow signed jar files. (Note: As of Java 11, this is ignored and is always treated as true.)No, default is false
:includeheadersbooleanBoolean, whether to include header files in linked image.No, default is true
:includemanpagesbooleanBoolean, whether to include man pages in linked image.No, default is true
:includenativecommandsbooleanBoolean, whether to include native executables in linked image.No, default is true
:launchersStringComma-separated list of commands, each of the form name=module or name=module/mainclassNo
:localesStringComma-separated list of extra locales, or wildcard patterns matching multiple locale names, to include. Requires jdk.localedata module.No
:modulepathPathPath-like sequence of jmod files to link in order to create image.One of these is required, unless a nested <modulepath> is present.
:modulepathrefReferencePath-like sequence of jmod files to link in order to create image, given as a reference to a path defined elsewhere.One of these is required, unless a nested <modulepath> is present.
:modulesStringComma-separated list of modules to place in the linked image.Yes, unless one or more nested <module> elements are present.
:observablemodulesStringComma-separated list of explicit modules that comprise "universe" visible to link tool while linking.No
:resourceorderStringComma-separated list of patterns specifying resource search order. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one resource name per line.No
:verboselevelLogLevelIf set, the linker will produce verbose output, which will be logged at the specified Ant log level (DEBUG, VERBOSE, INFO, WARN, or ERR).No, default is no verbose output
:vmtypeVMTypeHotspot VM in image. One of: client server minimal allNo, default is all

Nested elements

  • :compress (Compression)
  • :excludefiles (PatternListEntry)
  • :excluderesources (PatternListEntry)
  • :launcher (Launcher)
  • :locale (LocaleSpec)
  • :module (ModuleSpec)
  • :modulepath (Path)
  • :observablemodule (ModuleSpec)
  • :releaseinfo (ReleaseInfo)
  • :resourceorder (PatternListEntry)

Reference

https://ant.apache.org/manual/Tasks/link.html

Defined by

org.apache.tools.ant.taskdefs.modules.Link

Assembles jmod files into an executable image. Equivalent to the JDK's jlink tool.
Requires Java 9 or later.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bindservices` | `boolean` | Boolean, whether to include in linked image any service providers found in module path corresponding to service provider interfaces used by explicitly linked modules. | No, default is false |
| `:checkduplicatelegal` | `boolean` | Boolean. When merging legal notices from different modules because they have the same name, verify that their contents are identical. | No, default is false, which means any license files with the same name are assumed to have the same content, and no checking is done. |
| `:compress` | `CompressionLevel` | Compression level of linked image. One of: 0 or none no compression (default) 1 or strings constant string sharing 2 or zip zip compression | No, default is no compression |
| `:debug` | `boolean` | Boolean, whether to include debug information. | No, default is true |
| `:destdir` | `File` | Root directory of created image. | Yes |
| `:endianness` | `Endianness` | Byte order of linked image, must be little or big No, default is native byte order |  |
| `:excludefiles` | `String` | Comma-separated list of patterns specifying files to exclude from linked image. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one file name per line. | No |
| `:excluderesources` | `String` | Comma-separated list of patterns specifying resources to exclude from source jmods. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one resource name per line. | No |
| `:ignoresigning` | `boolean` | Boolean, whether to allow signed jar files. (Note: As of Java 11, this is ignored and is always treated as true.) | No, default is false |
| `:includeheaders` | `boolean` | Boolean, whether to include header files in linked image. | No, default is true |
| `:includemanpages` | `boolean` | Boolean, whether to include man pages in linked image. | No, default is true |
| `:includenativecommands` | `boolean` | Boolean, whether to include native executables in linked image. | No, default is true |
| `:launchers` | `String` | Comma-separated list of commands, each of the form name=module or name=module/mainclass | No |
| `:locales` | `String` | Comma-separated list of extra locales, or wildcard patterns matching multiple locale names, to include. Requires jdk.localedata module. | No |
| `:modulepath` | `Path` | Path-like sequence of jmod files to link in order to create image. | One of these is required, unless a nested <modulepath> is present. |
| `:modulepathref` | `Reference` | Path-like sequence of jmod files to link in order to create image, given as a reference to a path defined elsewhere. | One of these is required, unless a nested <modulepath> is present. |
| `:modules` | `String` | Comma-separated list of modules to place in the linked image. | Yes, unless one or more nested <module> elements are present. |
| `:observablemodules` | `String` | Comma-separated list of explicit modules that comprise "universe" visible to link tool while linking. | No |
| `:resourceorder` | `String` | Comma-separated list of patterns specifying resource search order. Each is either a standard PathMatcher pattern or @filename, indicating a text file with one resource name per line. | No |
| `:verboselevel` | `LogLevel` | If set, the linker will produce verbose output, which will be logged at the specified Ant log level (DEBUG, VERBOSE, INFO, WARN, or ERR). | No, default is no verbose output |
| `:vmtype` | `VMType` | Hotspot VM in image. One of: client server minimal all | No, default is all |

**Nested elements**

- `:compress` (`Compression`)
- `:excludefiles` (`PatternListEntry`)
- `:excluderesources` (`PatternListEntry`)
- `:launcher` (`Launcher`)
- `:locale` (`LocaleSpec`)
- `:module` (`ModuleSpec`)
- `:modulepath` (`Path`)
- `:observablemodule` (`ModuleSpec`)
- `:releaseinfo` (`ReleaseInfo`)
- `:resourceorder` (`PatternListEntry`)

**Reference**

https://ant.apache.org/manual/Tasks/link.html

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link`
sourceraw docstring

loadfileclj

(loadfile & args)

Specialization of loadresource that works on files exclusively and provides a srcFile attribute for convenience. Unless an encoding is specified, the encoding of the current locale is used. If the resource content is empty (maybe after processing a filterchain) the property is not set.

Attributes

AttributeTypeDescriptionRequired
:encodingStringencoding to use when loading the fileNo
:failonerrorbooleanWhether to halt the build on failureNo; default true
:propertyStringproperty to save toYes
:quietbooleanDo not display a diagnostic message (unless Apache Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. Setting this to true implies setting failonerror to false. Since Ant 1.7.0.No; default false
:srcfileFilesource fileYes

Nested elements

  • :filterchain (FilterChain)

Reference

https://ant.apache.org/manual/Tasks/loadfile.html

Defined by

org.apache.tools.ant.taskdefs.LoadFile

Specialization of loadresource that works on files exclusively and provides a srcFile
attribute for convenience. Unless an encoding is specified, the encoding of the current
locale is used. If the resource content is empty (maybe after processing a filterchain)
the property is not set.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:encoding` | `String` | encoding to use when loading the file | No |
| `:failonerror` | `boolean` | Whether to halt the build on failure | No; default true |
| `:property` | `String` | property to save to | Yes |
| `:quiet` | `boolean` | Do not display a diagnostic message (unless Apache Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. Setting this to true implies setting failonerror to false. Since Ant 1.7.0. | No; default false |
| `:srcfile` | `File` | source file | Yes |

**Nested elements**

- `:filterchain` (`FilterChain`)

**Reference**

https://ant.apache.org/manual/Tasks/loadfile.html

**Defined by**

`org.apache.tools.ant.taskdefs.LoadFile`
sourceraw docstring

loadpropertiesclj

(loadproperties & args)

Load a file's contents as Apache Ant properties. This is equivalent to <property file|resource=.../> except that it supports nested <filterchain> elements. Also if the file is missing, the build is halted with an error, rather than a warning being printed. Note: the default value of this task's prefixValues attribute is different from the default value of the same attribute in the <property> task.

Attributes

AttributeTypeDescriptionRequired
:classpathPaththe classpath to use when looking up a resource.No
:classpathrefReferencethe classpath to use when looking up a resource, given as reference to a <path> defined elsewhere.No
:encodingStringencoding to use when loading the fileNo
:prefixStringPrefix to apply to loaded properties. Since Ant 1.8.1No; default is.
:prefixvaluesbooleanWhether to apply the prefix when expanding the right hand side of the properties. Since Ant 1.8.2No; default is true
:resourceStringthe resource name of the property fileOne of these or a nested resource
:srcfileFilesource fileOne of these or a nested resource

Nested elements

  • :classpath (Path)
  • :filterchain (FilterChain)

Reference

https://ant.apache.org/manual/Tasks/loadproperties.html

Defined by

org.apache.tools.ant.taskdefs.LoadProperties

Load a file's contents as Apache Ant properties. This is equivalent to <property
file|resource=.../> except that it supports nested <filterchain> elements. Also if the
file is missing, the build is halted with an error, rather than a warning being printed.
Note: the default value of this task's prefixValues attribute is different from the
default value of the same attribute in the <property> task.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` | the classpath to use when looking up a resource. | No |
| `:classpathref` | `Reference` | the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere. | No |
| `:encoding` | `String` | encoding to use when loading the file | No |
| `:prefix` | `String` | Prefix to apply to loaded properties. Since Ant 1.8.1 | No; default is. |
| `:prefixvalues` | `boolean` | Whether to apply the prefix when expanding the right hand side of the properties. Since Ant 1.8.2 | No; default is true |
| `:resource` | `String` | the resource name of the property file | One of these or a nested resource |
| `:srcfile` | `File` | source file | One of these or a nested resource |

**Nested elements**

- `:classpath` (`Path`)
- `:filterchain` (`FilterChain`)

**Reference**

https://ant.apache.org/manual/Tasks/loadproperties.html

**Defined by**

`org.apache.tools.ant.taskdefs.LoadProperties`
sourceraw docstring

loadresourceclj

(loadresource & args)

Load a text resource into a single property. Unless an encoding is specified, the encoding of the current locale is used. Resources to load are specified as nested resource elements or single element resource collections. If the resource content is empty (maybe after processing a filterchain) the property is not set. Since properties are immutable, the task will not change the value of an existing property.

Attributes

AttributeTypeDescriptionRequired
:encodingStringencoding to use when loading the resourceNo
:failonerrorbooleanWhether to halt the build on failureNo; default is true
:propertyStringproperty to save toYes
:quietbooleanDo not display a diagnostic message (unless Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. Setting this to true implies setting failonerror to false.No; default is false

Nested elements

  • :filterchain (FilterChain)

Reference

https://ant.apache.org/manual/Tasks/loadresource.html

Defined by

org.apache.tools.ant.taskdefs.LoadResource

Load a text resource into a single property. Unless an encoding is specified, the
encoding of the current locale is used. Resources to load are specified as nested
resource elements or single element resource collections. If the resource content is
empty (maybe after processing a filterchain) the property is not set. Since properties
are immutable, the task will not change the value of an existing property.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:encoding` | `String` | encoding to use when loading the resource | No |
| `:failonerror` | `boolean` | Whether to halt the build on failure | No; default is true |
| `:property` | `String` | property to save to | Yes |
| `:quiet` | `boolean` | Do not display a diagnostic message (unless Ant has been invoked with the -verbose or -debug switches) or modify the exit status to reflect an error. Setting this to true implies setting failonerror to false. | No; default is false |

**Nested elements**

- `:filterchain` (`FilterChain`)

**Reference**

https://ant.apache.org/manual/Tasks/loadresource.html

**Defined by**

`org.apache.tools.ant.taskdefs.LoadResource`
sourceraw docstring

localclj

(local & args)

Adds a local property to the current scope. Property scopes exist at Apache Ant's various "block" levels. These include targets as well as the Parallel and Sequential task containers (including Macrodef bodies). A local property at a given scope "shadows" properties of the same name at higher scopes, including the global scope. Note that using the Local task at the global level effectively makes the property local to the "anonymous target" in which top-level operations are carried out; it will not be defined for other targets in the buildfile. A property is made local if the <local> task precedes its definition. See the examples section.

Attributes

AttributeTypeDescriptionRequired
:nameStringThe property to declare in the current scopeYes

Nested elements

  • :name (Name)

Reference

https://ant.apache.org/manual/Tasks/local.html

Defined by

org.apache.tools.ant.taskdefs.Local

Adds a local property to the current scope. Property scopes exist at Apache Ant's
various "block" levels. These include targets as well as the Parallel and Sequential
task containers (including Macrodef bodies). A local property at a given scope "shadows"
properties of the same name at higher scopes, including the global scope. Note that
using the Local task at the global level effectively makes the property local to the
"anonymous target" in which top-level operations are carried out; it will not be defined
for other targets in the buildfile. A property is made local if the <local> task
precedes its definition. See the examples section.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` | The property to declare in the current scope | Yes |

**Nested elements**

- `:name` (`Name`)

**Reference**

https://ant.apache.org/manual/Tasks/local.html

**Defined by**

`org.apache.tools.ant.taskdefs.Local`
sourceraw docstring

localeclj

(locale & args)

Ant nested locale. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$LocaleSpec

Ant nested locale. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$LocaleSpec`
sourceraw docstring

localtunnelclj

(localtunnel & args)

Ant nested localtunnel. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:lportint
:rhostString
:rportint

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ssh.SSHSession$LocalTunnel

Ant nested localtunnel. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:lport` | `int` |  |  |
| `:rhost` | `String` |  |  |
| `:rport` | `int` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ssh.SSHSession$LocalTunnel`
sourceraw docstring

locationclj

(location & args)

Ant nested location. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver

Ant nested location. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver`
sourceraw docstring

macrodefclj

(macrodef & args)

This defines a new task using a <sequential> nested task as a template. Nested elements <attribute> and <element> are used to specify attributes and elements of the new task. These get substituted into the <sequential> task when the new task is run.

Attributes

AttributeTypeDescriptionRequired
:backtracebooleanThis controls the error traceback if there is an error detected when running the macro. If this is set to true, there will be an error trackback, if false there will be none. Since Ant 1.7.No; default true
:nameStringThe name of the new definition.Yes
:uriStringThe uri that this definition should live in.No

Nested elements

  • :attribute (Attribute)
  • :element (TemplateElement)
  • :sequential (NestedSequential)
  • :text (Text)

Reference

https://ant.apache.org/manual/Tasks/macrodef.html

Defined by

org.apache.tools.ant.taskdefs.MacroDef

This defines a new task using a <sequential> nested task as a template. Nested elements
<attribute> and <element> are used to specify attributes and elements of the new task.
These get substituted into the <sequential> task when the new task is run.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:backtrace` | `boolean` | This controls the error traceback if there is an error detected when running the macro. If this is set to true, there will be an error trackback, if false there will be none. Since Ant 1.7. | No; default true |
| `:name` | `String` | The name of the new definition. | Yes |
| `:uri` | `String` | The uri that this definition should live in. | No |

**Nested elements**

- `:attribute` (`Attribute`)
- `:element` (`TemplateElement`)
- `:sequential` (`NestedSequential`)
- `:text` (`Text`)

**Reference**

https://ant.apache.org/manual/Tasks/macrodef.html

**Defined by**

`org.apache.tools.ant.taskdefs.MacroDef`
sourceraw docstring

mailclj

(mail & args)

A task to send SMTP email. This task can send mail using either plain text, UU encoding, or MIME format mail, depending on what is available. SMTP auth and SSL/TLS require JavaMail or JakartaMail and are only available in MIME format. Attachments may be sent using nested <attachments> elements, which are path-like structures. This means any filesystem based resource or resource collection can be used to point to attachments. Prior to Apache Ant 1.7 only <fileset> has been supported as a nested element, you can still use this directly without an <attachments> container. Note: This task may depend on external libraries that are not included in the Ant distribution. See Library Dependencies for more information. Starting with Ant 1.10.13 Ant supports either the modern jakarta.mail as well as the older javax.mail implementations and will prefer jakarta.mail if both are available.

Attributes

AttributeTypeDescriptionRequired
:bcclistStringComma-separated list of recipients to blind carbon copyAt least one of these, or the equivalent nested elements
:cclistStringComma-separated list of recipients to carbon copyAt least one of these, or the equivalent nested elements
:charsetStringCharacter set of the email. You can also set the charset in the message nested element. These options are mutually exclusive.No
:checkserveridentityboolean(boolean) Whether the server's identity shall be verified during TLS handshake. Ignored unless ssl or enableStartTLS is true. Requires JavaMail. Since Ant 1.10.16No; default is true
:enablestarttlsboolean(boolean) Whether the STARTTLS command used to switch to an encrypted connection for authentication should be supported. Requires JavaMail. Since Ant 1.8.0No
:encodingEncodingSpecifies the encoding to use for the content of the email. Values are mime, uu, plain, or auto. uu or plain are not compatible with SMTP authNo; default is auto
:failonerrorbooleanflag to indicate whether to halt the build on any error.No; default is true
:filesStringFiles to send as attachments to the email. Separate multiple file names using a comma or space. You can also use <fileset> elements to specify files.No
:fromStringEmail address of sender.Either a from attribute, or a <from> element.
:ignoreinvalidrecipientsboolean(boolean) Whether the task should try to send the message to as many recipients as possible and should only fail if neither is reachable. Since Ant 1.8.0.No; default is false
:includefilenamesbooleanInclude filename(s) before file contents.No; default is false, ignored unless plain encoding is used
:mailhostStringHost name of the SMTP server.No; default is localhost
:mailportintTCP port of the SMTP server.No; default is 25
:messageStringMessage to send in the body of the email.One of these or a <message> element.
:messagefileFileFile to send as the body of the email. Property values in the file will be expanded.One of these or a <message> element.
:messagefileinputencodingStringSpecifies the encoding of the input file. Please see Supported Encodings for a list of possible values. Since Ant 1.9.4No; defaults to default JVM character encoding
:messagemimetypeStringThe content type of the message.No; default is text/plain
:passwordStringpassword for SMTP authYes, if SMTP auth is required on your SMTP server; the email message will be then sent using MIME and requires JavaMail
:replytoStringReply-to email address.No
:requirestarttlsboolean(boolean) Whether the STARTTLS command used to switch to an encrypted connection for authentication should be required. Implicitly sets enableStartTLS to true if enabled. Requires JavaMail. Since Ant 1.10.16No; default is false
:sslbooleantrue, on, or yes accepted here indicates whether you need TLS/SSLNo
:subjectStringEmail subject line.No
:tolistStringComma-separated list of recipients.At least one of these, or the equivalent nested elements
:userStringuser name for SMTP authYes, if SMTP auth is required on your SMTP server; the email message will be then sent using MIME and requires JavaMail

Nested elements

  • :attachments (Path)
  • :bcc (EmailAddress)
  • :cc (EmailAddress)
  • :fileset (FileSet)
  • :from (EmailAddress)
  • :header (Header)
  • :message (Message)
  • :replyto (EmailAddress)
  • :to (EmailAddress)

Reference

https://ant.apache.org/manual/Tasks/mail.html

Defined by

org.apache.tools.ant.taskdefs.email.EmailTask

A task to send SMTP email. This task can send mail using either plain text, UU encoding,
or MIME format mail, depending on what is available. SMTP auth and SSL/TLS require
JavaMail or JakartaMail and are only available in MIME format. Attachments may be sent
using nested <attachments> elements, which are path-like structures. This means any
filesystem based resource or resource collection can be used to point to attachments.
Prior to Apache Ant 1.7 only <fileset> has been supported as a nested element, you can
still use this directly without an <attachments> container. Note: This task may depend
on external libraries that are not included in the Ant distribution. See Library
Dependencies for more information. Starting with Ant 1.10.13 Ant supports either the
modern jakarta.mail as well as the older javax.mail implementations and will prefer
jakarta.mail if both are available.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bcclist` | `String` | Comma-separated list of recipients to blind carbon copy | At least one of these, or the equivalent nested elements |
| `:cclist` | `String` | Comma-separated list of recipients to carbon copy | At least one of these, or the equivalent nested elements |
| `:charset` | `String` | Character set of the email. You can also set the charset in the message nested element. These options are mutually exclusive. | No |
| `:checkserveridentity` | `boolean` | (boolean) Whether the server's identity shall be verified during TLS handshake. Ignored unless ssl or enableStartTLS is true. Requires JavaMail. Since Ant 1.10.16 | No; default is true |
| `:enablestarttls` | `boolean` | (boolean) Whether the STARTTLS command used to switch to an encrypted connection for authentication should be supported. Requires JavaMail. Since Ant 1.8.0 | No |
| `:encoding` | `Encoding` | Specifies the encoding to use for the content of the email. Values are mime, uu, plain, or auto. uu or plain are not compatible with SMTP auth | No; default is auto |
| `:failonerror` | `boolean` | flag to indicate whether to halt the build on any error. | No; default is true |
| `:files` | `String` | Files to send as attachments to the email. Separate multiple file names using a comma or space. You can also use <fileset> elements to specify files. | No |
| `:from` | `String` | Email address of sender. | Either a from attribute, or a <from> element. |
| `:ignoreinvalidrecipients` | `boolean` | (boolean) Whether the task should try to send the message to as many recipients as possible and should only fail if neither is reachable. Since Ant 1.8.0. | No; default is false |
| `:includefilenames` | `boolean` | Include filename(s) before file contents. | No; default is false, ignored unless plain encoding is used |
| `:mailhost` | `String` | Host name of the SMTP server. | No; default is localhost |
| `:mailport` | `int` | TCP port of the SMTP server. | No; default is 25 |
| `:message` | `String` | Message to send in the body of the email. | One of these or a <message> element. |
| `:messagefile` | `File` | File to send as the body of the email. Property values in the file will be expanded. | One of these or a <message> element. |
| `:messagefileinputencoding` | `String` | Specifies the encoding of the input file. Please see Supported Encodings for a list of possible values. Since Ant 1.9.4 | No; defaults to default JVM character encoding |
| `:messagemimetype` | `String` | The content type of the message. | No; default is text/plain |
| `:password` | `String` | password for SMTP auth | Yes, if SMTP auth is required on your SMTP server; the email message will be then sent using MIME and requires JavaMail |
| `:replyto` | `String` | Reply-to email address. | No |
| `:requirestarttls` | `boolean` | (boolean) Whether the STARTTLS command used to switch to an encrypted connection for authentication should be required. Implicitly sets enableStartTLS to true if enabled. Requires JavaMail. Since Ant 1.10.16 | No; default is false |
| `:ssl` | `boolean` | true, on, or yes accepted here indicates whether you need TLS/SSL | No |
| `:subject` | `String` | Email subject line. | No |
| `:tolist` | `String` | Comma-separated list of recipients. | At least one of these, or the equivalent nested elements |
| `:user` | `String` | user name for SMTP auth | Yes, if SMTP auth is required on your SMTP server; the email message will be then sent using MIME and requires JavaMail |

**Nested elements**

- `:attachments` (`Path`)
- `:bcc` (`EmailAddress`)
- `:cc` (`EmailAddress`)
- `:fileset` (`FileSet`)
- `:from` (`EmailAddress`)
- `:header` (`Header`)
- `:message` (`Message`)
- `:replyto` (`EmailAddress`)
- `:to` (`EmailAddress`)

**Reference**

https://ant.apache.org/manual/Tasks/mail.html

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailTask`
sourceraw docstring

majorityclj

(majority & args)

Ant nested majority. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:allowtieboolean
:errorString
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.MajoritySelector

Ant nested majority. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:allowtie` | `boolean` |  |  |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.MajoritySelector`
sourceraw docstring

makeurlclj

(makeurl & args)

This task takes one or more filenames and turns them into URLs, which it then assigns to a property. Useful when setting up RMI or JNLP codebases, for example. Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them.

Attributes

AttributeTypeDescriptionRequired
:fileFilename of a file to be converted into a URLFile
:propertyStringname of a property to set to the URLString
:separatorStringseparator for the multi-URL optionString
:validatebooleanvalidate that every named file existsboolean

Nested elements

  • :fileset (FileSet)
  • :path (Path)

Reference

https://ant.apache.org/manual/Tasks/makeurl.html

Defined by

org.apache.tools.ant.taskdefs.MakeUrl

This task takes one or more filenames and turns them into URLs, which it then assigns to
a property. Useful when setting up RMI or JNLP codebases, for example. Nested filesets
are supported; if present, these are turned into the URLs with the supplied separator
between them.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` | name of a file to be converted into a URL | File |
| `:property` | `String` | name of a property to set to the URL | String |
| `:separator` | `String` | separator for the multi-URL option | String |
| `:validate` | `boolean` | validate that every named file exists | boolean |

**Nested elements**

- `:fileset` (`FileSet`)
- `:path` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/makeurl.html

**Defined by**

`org.apache.tools.ant.taskdefs.MakeUrl`
sourceraw docstring

manifestclj

(manifest & args)

Creates a manifest file. This task can be used to write a Manifest file, optionally replacing or updating an existing file. Manifests are processed according to the Jar file specification. Specifically, a manifest element consists of a set of attributes and sections. These sections in turn may contain attributes. Note in particular that this may result in manifest lines greater than 72 bytes being wrapped and continued on the next line. The Apache Ant team regularly gets complaints that this task in generating invalid manifests. By and large, this is not the case: we believe that we are following the specification to the letter. The usual problem is that some third party manifest reader is not following the same specification as well as they think they should; we cannot generate invalid manifest files just because one single application is broken. Java ME runtimes appear to be particularly troublesome. If you find that Ant generates manifests incompatible with your runtime, take a manifest it has built, fix it up however you need and switch to using the zip task to create the JAR, feeding in the hand-crafted manifest.

Attributes

AttributeTypeDescriptionRequired
:encodingStringThe encoding used to read the existing manifest when updating. The task will always use UTF-8 when writing the manifest.No; defaults to UTF-8 encoding
:fileFilethe manifest-file to create/update.Yes
:flattenattributesbooleanWhether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0.No; default is false
:mergeclasspathattributesbooleanWhether to merge the Class-Path attributes found in different manifests (if updating). If false, only the attribute of the most recent manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification.No; default is false
:modeModeOne of update or replace.No; default is replace

Nested elements

  • :attribute (Attribute)
  • :section (Section)

Reference

https://ant.apache.org/manual/Tasks/manifest.html

Defined by

org.apache.tools.ant.taskdefs.ManifestTask

Creates a manifest file. This task can be used to write a Manifest file, optionally
replacing or updating an existing file. Manifests are processed according to the Jar
file specification. Specifically, a manifest element consists of a set of attributes and
sections. These sections in turn may contain attributes. Note in particular that this
may result in manifest lines greater than 72 bytes being wrapped and continued on the
next line. The Apache Ant team regularly gets complaints that this task in generating
invalid manifests. By and large, this is not the case: we believe that we are following
the specification to the letter. The usual problem is that some third party manifest
reader is not following the same specification as well as they think they should; we
cannot generate invalid manifest files just because one single application is broken.
Java ME runtimes appear to be particularly troublesome. If you find that Ant generates
manifests incompatible with your runtime, take a manifest it has built, fix it up
however you need and switch to using the zip task to create the JAR, feeding in the
hand-crafted manifest.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:encoding` | `String` | The encoding used to read the existing manifest when updating. The task will always use UTF-8 when writing the manifest. | No; defaults to UTF-8 encoding |
| `:file` | `File` | the manifest-file to create/update. | Yes |
| `:flattenattributes` | `boolean` | Whether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0. | No; default is false |
| `:mergeclasspathattributes` | `boolean` | Whether to merge the Class-Path attributes found in different manifests (if updating). If false, only the attribute of the most recent manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification. | No; default is false |
| `:mode` | `Mode` | One of update or replace. | No; default is replace |

**Nested elements**

- `:attribute` (`Attribute`)
- `:section` (`Section`)

**Reference**

https://ant.apache.org/manual/Tasks/manifest.html

**Defined by**

`org.apache.tools.ant.taskdefs.ManifestTask`
sourceraw docstring

manifestclasspathclj

(manifestclasspath & args)

Converts a Path into a property whose value is appropriate for a Manifest's Class-Path attribute. This task is often used to work around command line limitations on Windows when using very long class paths when launching an application. The long class path normally specified on the command line is replaced by a single (possibly empty) jar file which an in-manifest Class-Path attribute whose value lists all the jar and zip files the classpath should contain. The files referenced from this attribute must be found relatively to the jar file itself, usually in the same directory. JVM automatically uses all file entries listed in the Class-Path attributes of a jar to locate/load classes. Note though that it silently ignores entries for which it cannot find any corresponding file. Note that the property value created may be longer than a manifest's maximum 72 characters per line, but will be properly wrapped as per the Jar specification by the <manifest> element, where the defined property is re-referenced. For this task to work properly the relative path from the file given in the jarfile attribute to the elements of the nested classpath must be the same as you expect them to be when deploying the jar.

Attributes

AttributeTypeDescriptionRequired
:jarfileFilethe filename for the Jar which will contain the manifest that will use the property this task will set. This file need not exist yet, but its parent directory must exist.Yes
:maxparentlevelsintThe maximum number of parent directories one is allowed to traverse to navigate from the jar file to the path entry. Put differently, the maximum number of .. which is allowed in the relative path from the jar file to a given class path entry. Specify 0 to enforce a path entry to be in the same directory (or one of its sub-directories) as the jar file itself.No; defaults to 2
:propertyStringthe name of the property to set. This property must not already be set.Yes

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/manifestclasspath.html

Defined by

org.apache.tools.ant.taskdefs.ManifestClassPath

Converts a Path into a property whose value is appropriate for a Manifest's Class-Path
attribute. This task is often used to work around command line limitations on Windows
when using very long class paths when launching an application. The long class path
normally specified on the command line is replaced by a single (possibly empty) jar file
which an in-manifest Class-Path attribute whose value lists all the jar and zip files
the classpath should contain. The files referenced from this attribute must be found
relatively to the jar file itself, usually in the same directory. JVM automatically uses
all file entries listed in the Class-Path attributes of a jar to locate/load classes.
Note though that it silently ignores entries for which it cannot find any corresponding
file. Note that the property value created may be longer than a manifest's maximum 72
characters per line, but will be properly wrapped as per the Jar specification by the
<manifest> element, where the defined property is re-referenced. For this task to work
properly the relative path from the file given in the jarfile attribute to the elements
of the nested classpath must be the same as you expect them to be when deploying the
jar.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:jarfile` | `File` | the filename for the Jar which will contain the manifest that will use the property this task will set. This file need not exist yet, but its parent directory must exist. | Yes |
| `:maxparentlevels` | `int` | The maximum number of parent directories one is allowed to traverse to navigate from the jar file to the path entry. Put differently, the maximum number of .. which is allowed in the relative path from the jar file to a given class path entry. Specify 0 to enforce a path entry to be in the same directory (or one of its sub-directories) as the jar file itself. | No; defaults to 2 |
| `:property` | `String` | the name of the property to set. This property must not already be set. | Yes |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/manifestclasspath.html

**Defined by**

`org.apache.tools.ant.taskdefs.ManifestClassPath`
sourceraw docstring

manpathclj

(manpath & args)

Ant nested manpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested manpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

mapclj

(map & args)

Ant nested map. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.PathConvert$MapEntry

Ant nested map. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.PathConvert$MapEntry`
sourceraw docstring

mappedresourcesclj

(mappedresources & args)

Ant type mappedresources. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:enablemultiplemappingsboolean
:refidReference

Nested elements

  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Types/mappedresources.html

Defined by

org.apache.tools.ant.types.resources.MappedResourceCollection

Ant type mappedresources. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:enablemultiplemappings` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/mappedresources.html

**Defined by**

`org.apache.tools.ant.types.resources.MappedResourceCollection`
sourceraw docstring

mapperclj

(mapper & args)

Some tasks take source files and create target files. Depending on the task, it may be quite obvious which name a target file will have (using javac, you know there will be .class files for your .java files)-in other cases you may want to specify the target files, either to help Apache Ant or to get an extra bit of functionality. While source files are usually specified as filesets, you don't specify target files directly-instead, you tell Ant how to find the target file(s) for one source file. An instance of org.apache.tools.ant.util.FileNameMapper is responsible for this. It constructs target file names based on rules that can be parameterized with from and to attributes-the exact meaning of which is implementation-dependent. These instances are defined in <mapper> elements with the following attributes:

Attributes

AttributeTypeDescriptionRequired
:classnameStringspecifies the implementation by class name.Exactly one of these
:classpathPaththe classpath to use when looking up classname.No
:classpathrefReferencethe classpath to use, given as reference to a path defined elsewhere.No
:fromStringthe from attribute for the given implementation.Depends on implementation
:refidReferenceMakes this mapper a reference to a mapper defined elsewhere. If specified no other attributes or nested elements are allowed.No
:toStringthe to attribute for the given implementation.Depends on implementation
:typeMapperTypespecifies one of the built-in implementations.Exactly one of these

Nested elements

  • :classpath (Path)
  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Types/mapper.html

Defined by

org.apache.tools.ant.types.Mapper

Some tasks take source files and create target files. Depending on the task, it may be
quite obvious which name a target file will have (using javac, you know there will be
.class files for your .java files)-in other cases you may want to specify the target
files, either to help Apache Ant or to get an extra bit of functionality. While source
files are usually specified as filesets, you don't specify target files
directly-instead, you tell Ant how to find the target file(s) for one source file. An
instance of org.apache.tools.ant.util.FileNameMapper is responsible for this. It
constructs target file names based on rules that can be parameterized with from and to
attributes-the exact meaning of which is implementation-dependent. These instances are
defined in <mapper> elements with the following attributes:

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` | specifies the implementation by class name. | Exactly one of these |
| `:classpath` | `Path` | the classpath to use when looking up classname. | No |
| `:classpathref` | `Reference` | the classpath to use, given as reference to a path defined elsewhere. | No |
| `:from` | `String` | the from attribute for the given implementation. | Depends on implementation |
| `:refid` | `Reference` | Makes this mapper a reference to a mapper defined elsewhere. If specified no other attributes or nested elements are allowed. | No |
| `:to` | `String` | the to attribute for the given implementation. | Depends on implementation |
| `:type` | `MapperType` | specifies one of the built-in implementations. | Exactly one of these |

**Nested elements**

- `:classpath` (`Path`)
- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/mapper.html

**Defined by**

`org.apache.tools.ant.types.Mapper`
sourceraw docstring

markerclj

(marker & args)

Ant nested marker. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:prefixString
:suffixString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Marker

Ant nested marker. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Marker`
sourceraw docstring

mergefilesclj

(mergefiles & args)

Ant nested mergefiles. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested mergefiles. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

mergemapperclj

(mergemapper & args)

Ant type mergemapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fromString
:toString

Reference

https://ant.apache.org/manual/Types/mergemapper.html

Defined by

org.apache.tools.ant.util.MergingMapper

Ant type mergemapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/mergemapper.html

**Defined by**

`org.apache.tools.ant.util.MergingMapper`
sourceraw docstring

messageclj

(message & args)

Ant nested message. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:charsetString
:inputencodingString
:mimetypeString
:srcFile

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.Message

Ant nested message. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:charset` | `String` |  |  |
| `:inputencoding` | `String` |  |  |
| `:mimetype` | `String` |  |  |
| `:src` | `File` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.Message`
sourceraw docstring

metainfclj

(metainf & args)

Ant nested metainf. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeString
:encodingString
:erroronmissingarchiveboolean
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeString
:followsymlinksboolean
:fullpathString
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixString
:refidReference
:srcFile
:srcresourceResource

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ZipFileSet

Ant nested metainf. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` |  |  |
| `:encoding` | `String` |  |  |
| `:erroronmissingarchive` | `boolean` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:src` | `File` |  |  |
| `:srcresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ZipFileSet`
sourceraw docstring

mimemailclj

(mimemail & args)

Sends SMTP mail with MIME attachments. Jakarta Mail and Jakarta Activation are required for this task. The Java Activation Framework is part of the standard class library for Java 6 to Java 10 but the java.activation module has been deprecated in Java 9 and must be enabled explicitly when running on Java 10. Alternatively it can be provided as an external library. Javamail has become Jakarta Mail and the Java activation Framework has become Jakarta Activation and both are part of the Jakarta effort at Eclipse. Multiple files can be attached using FileSets.

Attributes

AttributeTypeDescriptionRequired
:bcclistStringComma-separated list of BCC: recipientsYes, at least one of these
:cclistStringComma-separated list of CC: recipientsYes, at least one of these
:charsetString
:checkserveridentityboolean
:enablestarttlsboolean
:encodingEncoding
:failonerrorbooleanStop the build process if an error occurs sending the e-mail.No; default to true
:filesString
:fromStringEmail address of sender.Yes
:ignoreinvalidrecipientsboolean
:includefilenamesboolean
:mailhostStringHost name of the mail server.No; default to localhost
:mailportint
:messageStringThe message bodyExactly one of these, or a nested fileset
:messagefileFileA filename to read and used as the message bodyExactly one of these, or a nested fileset
:messagefileinputencodingString
:messagemimetypeStringMIME type to use for message or messageFile when attached.No; defaults to text/plain
:passwordString
:replytoString
:requirestarttlsboolean
:sslboolean
:subjectStringEmail subject line.No
:tolistStringComma-separated list of To: recipientsYes, at least one of these
:userString

Nested elements

  • :attachments (Path)
  • :bcc (EmailAddress)
  • :cc (EmailAddress)
  • :fileset (FileSet)
  • :from (EmailAddress)
  • :header (Header)
  • :message (Message)
  • :replyto (EmailAddress)
  • :to (EmailAddress)

Reference

https://ant.apache.org/manual/Tasks/mimemail.html

Defined by

org.apache.tools.ant.taskdefs.optional.net.MimeMail

Sends SMTP mail with MIME attachments. Jakarta Mail and Jakarta Activation are required
for this task. The Java Activation Framework is part of the standard class library for
Java 6 to Java 10 but the java.activation module has been deprecated in Java 9 and must
be enabled explicitly when running on Java 10. Alternatively it can be provided as an
external library. Javamail has become Jakarta Mail and the Java activation Framework has
become Jakarta Activation and both are part of the Jakarta effort at Eclipse. Multiple
files can be attached using FileSets.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bcclist` | `String` | Comma-separated list of BCC: recipients | Yes, at least one of these |
| `:cclist` | `String` | Comma-separated list of CC: recipients | Yes, at least one of these |
| `:charset` | `String` |  |  |
| `:checkserveridentity` | `boolean` |  |  |
| `:enablestarttls` | `boolean` |  |  |
| `:encoding` | `Encoding` |  |  |
| `:failonerror` | `boolean` | Stop the build process if an error occurs sending the e-mail. | No; default to true |
| `:files` | `String` |  |  |
| `:from` | `String` | Email address of sender. | Yes |
| `:ignoreinvalidrecipients` | `boolean` |  |  |
| `:includefilenames` | `boolean` |  |  |
| `:mailhost` | `String` | Host name of the mail server. | No; default to localhost |
| `:mailport` | `int` |  |  |
| `:message` | `String` | The message body | Exactly one of these, or a nested fileset |
| `:messagefile` | `File` | A filename to read and used as the message body | Exactly one of these, or a nested fileset |
| `:messagefileinputencoding` | `String` |  |  |
| `:messagemimetype` | `String` | MIME type to use for message or messageFile when attached. | No; defaults to text/plain |
| `:password` | `String` |  |  |
| `:replyto` | `String` |  |  |
| `:requirestarttls` | `boolean` |  |  |
| `:ssl` | `boolean` |  |  |
| `:subject` | `String` | Email subject line. | No |
| `:tolist` | `String` | Comma-separated list of To: recipients | Yes, at least one of these |
| `:user` | `String` |  |  |

**Nested elements**

- `:attachments` (`Path`)
- `:bcc` (`EmailAddress`)
- `:cc` (`EmailAddress`)
- `:fileset` (`FileSet`)
- `:from` (`EmailAddress`)
- `:header` (`Header`)
- `:message` (`Message`)
- `:replyto` (`EmailAddress`)
- `:to` (`EmailAddress`)

**Reference**

https://ant.apache.org/manual/Tasks/mimemail.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.net.MimeMail`
sourceraw docstring

mkdirclj

(mkdir & args)

Creates a directory. Also non-existent parent directories are created, when necessary. Does nothing if the directory already exists.

Attributes

AttributeTypeDescriptionRequired
:dirFilethe directory to create.Yes

Reference

https://ant.apache.org/manual/Tasks/mkdir.html

Defined by

org.apache.tools.ant.taskdefs.Mkdir

Creates a directory. Also non-existent parent directories are created, when necessary.
Does nothing if the directory already exists.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dir` | `File` | the directory to create. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/mkdir.html

**Defined by**

`org.apache.tools.ant.taskdefs.Mkdir`
sourceraw docstring

(mklink & args)

Creates hardlinks, junctions and symbolic links on the windows platform. The task is just a wrapper around mklink and performs a few sanity checks but will not catch all restrictions like hardlinks or junctions not crossing volume boundaries. In order to create symbolic links you need the "create symbolic link" permission - this can be achieved by enabling developer mode on the machine running Ant, running Ant with elevated permissions (which sounds like a bad idea) or enable the permission explicitly for your user.

Attributes

AttributeTypeDescriptionRequired
:linkFileThe name of the link to be created, will be resolved relative to the project's basedir.Yes
:linktypeLinkTypeThe type of link to create, may be file-symlink, dir-symlink, hardlink or junction.Yes unless targetFile is given in which case it defaults to file-symlink or dir-symlink depending on whether the target is a plain file or a directory.
:overwritebooleanOverwrite existing files or not. If overwrite is set to true, then any existing file, specified by the link attribute, will be overwritten irrespective of whether or not the existing file is a link. otherwise any existing file is considered an error and make the task fail.No; defaults to false
:targetfileFileThe resource the link should point to, will be resolved relative to the project's basedir.Exactly one of targetFile and targetText must be given.
:targettextStringThe resource the link should point to. This will be passed to mklink verbatim.Exactly one of targetFile and targetText must be given.

Reference

https://ant.apache.org/manual/Tasks/mklink.html

Defined by

org.apache.tools.ant.taskdefs.optional.windows.Mklink

Creates hardlinks, junctions and symbolic links on the windows platform. The task is
just a wrapper around mklink and performs a few sanity checks but will not catch all
restrictions like hardlinks or junctions not crossing volume boundaries. In order to
create symbolic links you need the "create symbolic link" permission - this can be
achieved by enabling developer mode on the machine running Ant, running Ant with
elevated permissions (which sounds like a bad idea) or enable the permission explicitly
for your user.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:link` | `File` | The name of the link to be created, will be resolved relative to the project's basedir. | Yes |
| `:linktype` | `LinkType` | The type of link to create, may be file-symlink, dir-symlink, hardlink or junction. | Yes unless targetFile is given in which case it defaults to file-symlink or dir-symlink depending on whether the target is a plain file or a directory. |
| `:overwrite` | `boolean` | Overwrite existing files or not. If overwrite is set to true, then any existing file, specified by the link attribute, will be overwritten irrespective of whether or not the existing file is a link. otherwise any existing file is considered an error and make the task fail. | No; defaults to false |
| `:targetfile` | `File` | The resource the link should point to, will be resolved relative to the project's basedir. | Exactly one of targetFile and targetText must be given. |
| `:targettext` | `String` | The resource the link should point to. This will be passed to mklink verbatim. | Exactly one of targetFile and targetText must be given. |

**Reference**

https://ant.apache.org/manual/Tasks/mklink.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.windows.Mklink`
sourceraw docstring

modifiedclj

(modified & args)

Ant nested modified. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:algorithmAlgorithmName
:algorithmclassString
:cacheCacheName
:cacheclassString
:comparatorComparatorName
:comparatorclassString
:delayupdateboolean
:errorString
:modifiedint
:refidReference
:seldirsboolean
:selresboolean
:updateboolean

Nested elements

  • :classpath (Path)
  • :param (Parameter)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector

Ant nested modified. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:algorithm` | `AlgorithmName` |  |  |
| `:algorithmclass` | `String` |  |  |
| `:cache` | `CacheName` |  |  |
| `:cacheclass` | `String` |  |  |
| `:comparator` | `ComparatorName` |  |  |
| `:comparatorclass` | `String` |  |  |
| `:delayupdate` | `boolean` |  |  |
| `:error` | `String` |  |  |
| `:modified` | `int` |  |  |
| `:refid` | `Reference` |  |  |
| `:seldirs` | `boolean` |  |  |
| `:selres` | `boolean` |  |  |
| `:update` | `boolean` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:param` (`Parameter`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector`
sourceraw docstring

moduleclj

(module & args)

Ant nested module. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.Javadoc$PackageName
  • org.apache.tools.ant.taskdefs.modules.Link$ModuleSpec

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.AbstractCvsTask$Module

Ant nested module. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.Javadoc$PackageName`
- `org.apache.tools.ant.taskdefs.modules.Link$ModuleSpec`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.AbstractCvsTask$Module`
sourceraw docstring

modulepathclj

(modulepath & args)

Ant nested modulepath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested modulepath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

modulesourcepathclj

(modulesourcepath & args)

Ant nested modulesourcepath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested modulesourcepath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

modulewarningclj

(modulewarning & args)

Ant nested modulewarning. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:reasonResolutionWarningReason

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Jmod$ResolutionWarningSpec

Ant nested modulewarning. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:reason` | `ResolutionWarningReason` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Jmod$ResolutionWarningSpec`
sourceraw docstring

moveclj

(move & args)

Moves a file to a new file or directory, or collections of files to a new directory. By default, the destination file is overwritten if it already exists. When overwrite is turned off, then files are only moved if the source file is newer than the destination file, or when the destination file does not exist - please see the granularity attribute for Ant's idea of newer. Resource collections are used to select a group of files to move. Only file system based resource collections are supported, this includes filesets, filelist and path. Prior to Apache Ant 1.7 only <fileset> has been supported as a nested element. To use a resource collection, the todir attribute must be set. Since Ant 1.6.3, the file attribute may be used to move (rename) an entire directory. If tofile denotes an existing file, or there is a directory by the same name in todir, the action will fail.

Attributes

AttributeTypeDescriptionRequired
:enablemultiplemappingsbooleanIf true the task will process to all the mappings for a given source path. If false the task will only process the first file or directory. This attribute is only relevant if there is a mapper subelement. since Ant 1.6.No; defaults to false
:encodingStringThe encoding to assume when filter-copying the files. since Ant 1.5.No; defaults to default JVM character encoding
:failonerrorbooleanIf false, log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while moving.No; defaults to true
:fileFilethe file or directory to moveOne of file or at least one nested resource collection element
:filteringbooleanindicates whether token filtering should take place during the move. See the filter task for a description of how filters work.No
:flattenbooleanignore directory structure of source directory, copy all files into a single directory, specified by the todir attribute. Note that you can achieve the same effect by using a flatten mapperNo; defaults to false
:forcebooleanOverwrite read-only destination files. since Ant 1.8.2No; defaults to false
:granularitylongThe number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6.No; default is 0 milliseconds, or 2 seconds on DOS systems
:includeemptydirsbooleanCopy empty directories included with the nested FileSet(s).No; defaults to yes
:outputencodingStringThe encoding to use when writing the files. since Ant 1.6.No; defaults to encoding if set or default JVM character encoding otherwise
:overwritebooleanoverwrite existing files even if the destination files are newerNo; defaults to true
:performgconfaileddeletebooleanIf Ant fails to delete a file or directory it will retry the operation once. If this flag is set to true it will perform a garbage collection before retrying the delete. Setting this flag to true is known to resolve some problems on Windows (where it defaults to true) but also for directory trees residing on an NFS share. Since Ant 1.8.3No; defaults to true on Windows and false on any other OS
:preservelastmodifiedbooleanGive the moved files the same last modified time as the original source files. (Note: Ignored on Java 1.1)No; defaults to false
:quietbooleanIf true and failonerror is false, then do not log a warning message when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. since Ant 1.8.3.No; defaults to false
:todirFilethe directory to move toWith the file attribute, either tofile or todir can be used. With nested filesets, if the fileset size is greater than 1 or if the only entry in the fileset is a directory or if the file attribute is already specified, only todir is allowed
:tofileFilethe file to move toWith the file attribute, either tofile or todir can be used. With nested filesets, if the fileset size is greater than 1 or if the only entry in the fileset is a directory or if the file attribute is already specified, only todir is allowed
:verbosebooleanLog the files that are being moved.No; defaults to false

Nested elements

  • :fileset (FileSet)
  • :filterchain (FilterChain)
  • :filterset (FilterSet)
  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Tasks/move.html

Defined by

org.apache.tools.ant.taskdefs.Move

Moves a file to a new file or directory, or collections of files to a new directory. By
default, the destination file is overwritten if it already exists. When overwrite is
turned off, then files are only moved if the source file is newer than the destination
file, or when the destination file does not exist - please see the granularity attribute
for Ant's idea of newer. Resource collections are used to select a group of files to
move. Only file system based resource collections are supported, this includes filesets,
filelist and path. Prior to Apache Ant 1.7 only <fileset> has been supported as a nested
element. To use a resource collection, the todir attribute must be set. Since Ant 1.6.3,
the file attribute may be used to move (rename) an entire directory. If tofile denotes
an existing file, or there is a directory by the same name in todir, the action will
fail.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:enablemultiplemappings` | `boolean` | If true the task will process to all the mappings for a given source path. If false the task will only process the first file or directory. This attribute is only relevant if there is a mapper subelement. since Ant 1.6. | No; defaults to false |
| `:encoding` | `String` | The encoding to assume when filter-copying the files. since Ant 1.5. | No; defaults to default JVM character encoding |
| `:failonerror` | `boolean` | If false, log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while moving. | No; defaults to true |
| `:file` | `File` | the file or directory to move | One of file or at least one nested resource collection element |
| `:filtering` | `boolean` | indicates whether token filtering should take place during the move. See the filter task for a description of how filters work. | No |
| `:flatten` | `boolean` | ignore directory structure of source directory, copy all files into a single directory, specified by the todir attribute. Note that you can achieve the same effect by using a flatten mapper | No; defaults to false |
| `:force` | `boolean` | Overwrite read-only destination files. since Ant 1.8.2 | No; defaults to false |
| `:granularity` | `long` | The number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6. | No; default is 0 milliseconds, or 2 seconds on DOS systems |
| `:includeemptydirs` | `boolean` | Copy empty directories included with the nested FileSet(s). | No; defaults to yes |
| `:outputencoding` | `String` | The encoding to use when writing the files. since Ant 1.6. | No; defaults to encoding if set or default JVM character encoding otherwise |
| `:overwrite` | `boolean` | overwrite existing files even if the destination files are newer | No; defaults to true |
| `:performgconfaileddelete` | `boolean` | If Ant fails to delete a file or directory it will retry the operation once. If this flag is set to true it will perform a garbage collection before retrying the delete. Setting this flag to true is known to resolve some problems on Windows (where it defaults to true) but also for directory trees residing on an NFS share. Since Ant 1.8.3 | No; defaults to true on Windows and false on any other OS |
| `:preservelastmodified` | `boolean` | Give the moved files the same last modified time as the original source files. (Note: Ignored on Java 1.1) | No; defaults to false |
| `:quiet` | `boolean` | If true and failonerror is false, then do not log a warning message when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. since Ant 1.8.3. | No; defaults to false |
| `:todir` | `File` | the directory to move to | With the file attribute, either tofile or todir can be used. With nested filesets, if the fileset size is greater than 1 or if the only entry in the fileset is a directory or if the file attribute is already specified, only todir is allowed |
| `:tofile` | `File` | the file to move to | With the file attribute, either tofile or todir can be used. With nested filesets, if the fileset size is greater than 1 or if the only entry in the fileset is a directory or if the file attribute is already specified, only todir is allowed |
| `:verbose` | `boolean` | Log the files that are being moved. | No; defaults to false |

**Nested elements**

- `:fileset` (`FileSet`)
- `:filterchain` (`FilterChain`)
- `:filterset` (`FilterSet`)
- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Tasks/move.html

**Defined by**

`org.apache.tools.ant.taskdefs.Move`
sourceraw docstring

multirootfilesetclj

(multirootfileset & args)

Since Ant 1.9.4 A MultiRootFileSet is a group of files or directories. These files or directories can be found in a directory forrest starting with a set of base directories and are matched by patterns taken from a number of PatternSets and Selectors. MultiRootFileSet acts as a union of FileSets and DirSets that share the same patterns and selectors. MultiRootFileSet supports all attributes and nested elements of FileSet and DirSet except for the dir attribute.

Attributes

AttributeTypeDescriptionRequired
:basedirsStringComma separated list of directories that build the roots of the MultiRootFileSet.No
:cachebooleanWhether to cache results; disabling may seriously impact performanceNo; default is true
:casesensitivebooleanSpecifies whether case-sensitivity should be applied (true, yes, on or false, no, off).No; defaults to true
:defaultexcludesboolean
:dirFile
:erroronmissingdirbooleanSpecify what happens if one of the base directories does not exist. If true a build error will happen, if false, the subtree will be ignored/empty.No; defaults to true
:excludesStringA comma- or space-separated list of patterns of directories that must be excluded.No; defaults to none
:excludesfileFileName of a file; each line of this file is taken to be an exclude pattern.No
:fileFile
:followsymlinksbooleanShall symbolic links and Windows junctions be followed? See fileset's documentation. Windows junctions are detected since Ant 1.10.16.No; defaults to true
:includesStringA comma- or space-separated list of patterns of directories that must be included.No; defaults to all directories
:includesfileFileName of a file; each line of this file is taken to be an include pattern.No
:maxlevelsofsymlinksint
:refidReference
:typeSetType {file\|dir\|both}The type of file system entities which will be included in this set. Acceptable values are: file-regular files dir-directories both-regular files and directoriesNo; defaults to file

Nested elements

  • :and (AndSelector)
  • :basedir (FileResource)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/multirootfileset.html

Defined by

org.apache.tools.ant.types.resources.MultiRootFileSet

Since Ant 1.9.4 A MultiRootFileSet is a group of files or directories. These files or
directories can be found in a directory forrest starting with a set of base directories
and are matched by patterns taken from a number of PatternSets and Selectors.
MultiRootFileSet acts as a union of FileSets and DirSets that share the same patterns
and selectors. MultiRootFileSet supports all attributes and nested elements of FileSet
and DirSet except for the dir attribute.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedirs` | `String` | Comma separated list of directories that build the roots of the MultiRootFileSet. | No |
| `:cache` | `boolean` | Whether to cache results; disabling may seriously impact performance | No; default is true |
| `:casesensitive` | `boolean` | Specifies whether case-sensitivity should be applied (true, yes, on or false, no, off). | No; defaults to true |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` | Specify what happens if one of the base directories does not exist. If true a build error will happen, if false, the subtree will be ignored/empty. | No; defaults to true |
| `:excludes` | `String` | A comma- or space-separated list of patterns of directories that must be excluded. | No; defaults to none |
| `:excludesfile` | `File` | Name of a file; each line of this file is taken to be an exclude pattern. | No |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` | Shall symbolic links and Windows junctions be followed? See fileset's documentation. Windows junctions are detected since Ant 1.10.16. | No; defaults to true |
| `:includes` | `String` | A comma- or space-separated list of patterns of directories that must be included. | No; defaults to all directories |
| `:includesfile` | `File` | Name of a file; each line of this file is taken to be an include pattern. | No |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |
| `:type` | `SetType {file\|dir\|both}` | The type of file system entities which will be included in this set. Acceptable values are: file-regular files dir-directories both-regular files and directories | No; defaults to file |

**Nested elements**

- `:and` (`AndSelector`)
- `:basedir` (`FileResource`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/multirootfileset.html

**Defined by**

`org.apache.tools.ant.types.resources.MultiRootFileSet`
sourceraw docstring

nameclj

(name & args)

Ant nested name. (No description bundled.)

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Local$Name

Ant nested name. (No description bundled.)

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Local$Name`
sourceraw docstring

native2asciiclj

(native2ascii & args)

Converts files from native encodings to ASCII with escaped Unicode. A common usage is to convert source files maintained in a native operating system encoding, to ASCII prior to compilation. Files in the directory src are converted from a native encoding to ASCII. By default, all files in the directory are converted. However, conversion may be limited to selected files using includes and excludes attributes. For more information on file matching patterns, see the section on directory based tasks. If no encoding is specified, the default encoding for the JVM is used. If ext is specified, then output files are renamed to use it as a new extension. More sophisticated file name translations can be achieved using a nested <mapper> element. By default an identity mapper will be used. If dest and src point to the same directory, the ext attribute or a nested <mapper> is required. This task forms an implicit FileSet, and supports most attributes of <fileset> (dir becomes src) as well as nested <include>, <exclude>, and <patternset> elements. It is possible to use different converters. This can be selected with the implementation attribute or a nested element. Here are the choices of the attribute: default-the default converter for the platform: kaffe when run on Kaffe, builtin otherwise. sun-used to be the standard converter of the JDK 8 or earlier kaffe-the standard converter of Kaffe builtin-Ant's internal implementation. Since Ant 1.9.8 Attribute Description Required reverse Reverse the sense of the conversion, i.e. convert from ASCII to native Only supported by the sun and builtin converters No encoding The native encoding the files are in No; defaults to default JVM character encoding src The directory to find files in; default is basedir No dest The directory to output file to Yes ext File extension to use in renaming output files No includes Comma- or space-separated list of patterns of files that must be included. No; defaults to all (**) includesfile Name of a file. Each line of this file is taken to be an include pattern No excludes Comma- or space-separated list of patterns of files that must be excluded. No; defaults to default excludes or none if defaultexcludes is no excludesfile Name of a file. Each line of this file is taken to be an exclude pattern No defaultexcludes Indicates whether default excludes should be used or not (yes|no). No; defaults to yes implementation The converter implementation to use. (See the above list of valid converters.) No; defaults to default converter for the current JVM

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesbooleanIndicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destFileThe directory to output file toYes
:encodingStringThe native encoding the files are inNo; defaults to default JVM character encoding
:excludesStringComma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFileName of a file. Each line of this file is taken to be an exclude patternNo
:extStringFile extension to use in renaming output filesNo
:followsymlinksboolean
:implementationStringThe converter implementation to use. (See the above list of valid converters.)No; defaults to default converter for the current JVM
:includesStringComma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFileName of a file. Each line of this file is taken to be an include patternNo
:reversebooleanReverse the sense of the conversion, i.e. convert from ASCII to native Only supported by the sun and builtin convertersNo
:srcFileThe directory to find files in; default is basedirNo

Nested elements

  • :and (AndSelector)
  • :arg (ImplementationSpecificArgument)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :implementationclasspath (Path)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :mapper (Mapper)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/native2ascii.html

Defined by

org.apache.tools.ant.taskdefs.optional.Native2Ascii

Converts files from native encodings to ASCII with escaped Unicode. A common usage is to
convert source files maintained in a native operating system encoding, to ASCII prior to
compilation. Files in the directory src are converted from a native encoding to ASCII.
By default, all files in the directory are converted. However, conversion may be limited
to selected files using includes and excludes attributes. For more information on file
matching patterns, see the section on directory based tasks. If no encoding is
specified, the default encoding for the JVM is used. If ext is specified, then output
files are renamed to use it as a new extension. More sophisticated file name
translations can be achieved using a nested <mapper> element. By default an identity
mapper will be used. If dest and src point to the same directory, the ext attribute or a
nested <mapper> is required. This task forms an implicit FileSet, and supports most
attributes of <fileset> (dir becomes src) as well as nested <include>, <exclude>, and
<patternset> elements. It is possible to use different converters. This can be selected
with the implementation attribute or a nested element. Here are the choices of the
attribute: default-the default converter for the platform: kaffe when run on Kaffe,
builtin otherwise. sun-used to be the standard converter of the JDK 8 or earlier
kaffe-the standard converter of Kaffe builtin-Ant's internal implementation. Since Ant
1.9.8 Attribute Description Required reverse Reverse the sense of the conversion, i.e.
convert from ASCII to native Only supported by the sun and builtin converters No
encoding The native encoding the files are in No; defaults to default JVM character
encoding src The directory to find files in; default is basedir No dest The directory to
output file to Yes ext File extension to use in renaming output files No includes Comma-
or space-separated list of patterns of files that must be included. No; defaults to all
(**) includesfile Name of a file. Each line of this file is taken to be an include
pattern No excludes Comma- or space-separated list of patterns of files that must be
excluded. No; defaults to default excludes or none if defaultexcludes is no excludesfile
Name of a file. Each line of this file is taken to be an exclude pattern No
defaultexcludes Indicates whether default excludes should be used or not (yes|no). No;
defaults to yes implementation The converter implementation to use. (See the above list
of valid converters.) No; defaults to default converter for the current JVM

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` | Indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:dest` | `File` | The directory to output file to | Yes |
| `:encoding` | `String` | The native encoding the files are in | No; defaults to default JVM character encoding |
| `:excludes` | `String` | Comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | Name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:ext` | `String` | File extension to use in renaming output files | No |
| `:followsymlinks` | `boolean` |  |  |
| `:implementation` | `String` | The converter implementation to use. (See the above list of valid converters.) | No; defaults to default converter for the current JVM |
| `:includes` | `String` | Comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | Name of a file. Each line of this file is taken to be an include pattern | No |
| `:reverse` | `boolean` | Reverse the sense of the conversion, i.e. convert from ASCII to native Only supported by the sun and builtin converters | No |
| `:src` | `File` | The directory to find files in; default is basedir | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:arg` (`ImplementationSpecificArgument`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:implementationclasspath` (`Path`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:mapper` (`Mapper`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/native2ascii.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Native2Ascii`
sourceraw docstring

nativelibpathclj

(nativelibpath & args)

Ant nested nativelibpath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested nativelibpath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

niceclj

(nice & args)

Provide "nice-ness" to the current thread and/or query the current value.

Attributes

AttributeTypeDescriptionRequired
:currentpriorityStringname of the property whose value should be set to the current "nice-ness" level.No
:newpriorityintvalue to which the "nice-ness" level should be set. Must be a valid Java Thread priority.No

Reference

https://ant.apache.org/manual/Tasks/nice.html

Defined by

org.apache.tools.ant.taskdefs.Nice

Provide "nice-ness" to the current thread and/or query the current value.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:currentpriority` | `String` | name of the property whose value should be set to the current "nice-ness" level. | No |
| `:newpriority` | `int` | value to which the "nice-ness" level should be set. Must be a valid Java Thread priority. | No |

**Reference**

https://ant.apache.org/manual/Tasks/nice.html

**Defined by**

`org.apache.tools.ant.taskdefs.Nice`
sourceraw docstring

noneclj

(none & args)

Ant nested none. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.NoneSelector

Ant nested none. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.NoneSelector`
sourceraw docstring

notclj

(not & args)

Ant nested not. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.condition.Not

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.NotSelector

Ant nested not. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.condition.Not`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.NotSelector`
sourceraw docstring

observablemoduleclj

(observablemodule & args)

Ant nested observablemodule. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$ModuleSpec

Ant nested observablemodule. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$ModuleSpec`
sourceraw docstring

optionsclj

(options & args)

Ant nested options. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :extension (ExtensionAdapter)
  • :fileset (FileSet)
  • :libfileset (LibFileSet)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet

Ant nested options. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:extension` (`ExtensionAdapter`)
- `:fileset` (`FileSet`)
- `:libfileset` (`LibFileSet`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet`
sourceraw docstring

orclj

(or & args)

Ant nested or. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.condition.Or

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.OrSelector

Ant nested or. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.condition.Or`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.OrSelector`
sourceraw docstring

orionclj

(orion & args)

Ant nested orion. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:destdirFile
:genericjarsuffixString

Nested elements

  • :classpath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.OrionDeploymentTool

Ant nested orion. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:destdir` | `File` |  |  |
| `:genericjarsuffix` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.OrionDeploymentTool`
sourceraw docstring

osclj

(os & args)

Ant nested os. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:archString
:familyString
:nameString
:versionString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.Os

Ant nested os. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:arch` | `String` |  |  |
| `:family` | `String` |  |  |
| `:name` | `String` |  |  |
| `:version` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.Os`
sourceraw docstring

outputfilterchainclj

(outputfilterchain & args)

Ant nested outputfilterchain. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidReference

Nested elements

  • :classconstants (ClassConstants)
  • :containsregex (ContainsRegex)
  • :deletecharacters (DeleteCharacters)
  • :escapeunicode (EscapeUnicode)
  • :expandproperties (ExpandProperties)
  • :filterreader (AntFilterReader)
  • :headfilter (HeadFilter)
  • :ignoreblank (IgnoreBlank)
  • :linecontains (LineContains)
  • :linecontainsregexp (LineContainsRegExp)
  • :prefixlines (PrefixLines)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :replacetokens (ReplaceTokens)
  • :stripjavacomments (StripJavaComments)
  • :striplinebreaks (StripLineBreaks)
  • :striplinecomments (StripLineComments)
  • :suffixlines (SuffixLines)
  • :tabstospaces (TabsToSpaces)
  • :tailfilter (TailFilter)
  • :tokenfilter (TokenFilter)
  • :trim (Trim)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FilterChain

Ant nested outputfilterchain. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:classconstants` (`ClassConstants`)
- `:containsregex` (`ContainsRegex`)
- `:deletecharacters` (`DeleteCharacters`)
- `:escapeunicode` (`EscapeUnicode`)
- `:expandproperties` (`ExpandProperties`)
- `:filterreader` (`AntFilterReader`)
- `:headfilter` (`HeadFilter`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linecontains` (`LineContains`)
- `:linecontainsregexp` (`LineContainsRegExp`)
- `:prefixlines` (`PrefixLines`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:replacetokens` (`ReplaceTokens`)
- `:stripjavacomments` (`StripJavaComments`)
- `:striplinebreaks` (`StripLineBreaks`)
- `:striplinecomments` (`StripLineComments`)
- `:suffixlines` (`SuffixLines`)
- `:tabstospaces` (`TabsToSpaces`)
- `:tailfilter` (`TailFilter`)
- `:tokenfilter` (`TokenFilter`)
- `:trim` (`Trim`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FilterChain`
sourceraw docstring

outputmapperclj

(outputmapper & args)

Ant nested outputmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString
:classpathPath
:classpathrefReference
:fromString
:refidReference
:toString
:typeMapperType

Nested elements

  • :classpath (Path)
  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Mapper

Ant nested outputmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:from` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:to` | `String` |  |  |
| `:type` | `MapperType` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Mapper`
sourceraw docstring

outputpropertyclj

(outputproperty & args)

Ant nested outputproperty. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess$OutputProperty

Ant nested outputproperty. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess$OutputProperty`
sourceraw docstring

ownedbyclj

(ownedby & args)

Ant nested ownedby. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:followsymlinksboolean
:ownerString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.OwnedBySelector

Ant nested ownedby. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:followsymlinks` | `boolean` |  |  |
| `:owner` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.OwnedBySelector`
sourceraw docstring

packageclj

(package & args)

Ant nested package. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$PackageName

Ant nested package. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$PackageName`
sourceraw docstring

packagemapperclj

(packagemapper & args)

Ant type packagemapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:fromString
:handledirsepboolean
:toString

Reference

https://ant.apache.org/manual/Types/packagemapper.html

Defined by

org.apache.tools.ant.util.PackageNameMapper

Ant type packagemapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:from` | `String` |  |  |
| `:handledirsep` | `boolean` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/packagemapper.html

**Defined by**

`org.apache.tools.ant.util.PackageNameMapper`
sourceraw docstring

packagesetclj

(packageset & args)

Ant nested packageset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.DirSet

Ant nested packageset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.DirSet`
sourceraw docstring

parallelclj

(parallel & args)

Executes nested tasks in parallel with no guarantees of thread safety. Every task will run in its own thread, with the likelihood of concurrency problems scaling with the number of CPUs on the host system. Warning: While the Apache Ant core is believed to be thread safe, no such guarantees are made about tasks, which are not tested for thread safety during Ant's test process. Third party tasks may or may not be thread safe, and some of Ant's core tasks, such as <javac> are definitely not re-entrant. This is because they use libraries that were never designed to be used in a multithreaded environment. The primary use case for <parallel> is to run external programs such as an application server, and the JUnit or TestNG test suites at the same time. Anyone trying to run large Ant task sequences in parallel, such as javadoc and javac at the same time, is implicitly taking on the task of identifying and fixing all concurrency bugs the tasks that they run. Accordingly, while this task has uses, it should be considered an advanced task which should be used in certain batch processing or testing situations, rather than an easy trick to speed up build times on a multicore CPU.

Attributes

AttributeTypeDescriptionRequired
:failonanybooleanIf any of the nested tasks fails, execution of the task completes at that point without waiting for any other tasks to complete.No; default is false.
:pollintervalintCurrently has no effectNo; default is 1000
:threadcountintMaximum numbers of thread to use.No
:threadsperprocessorintMaximum number of threads to use per available processor (Java 1.4+)No; defers to threadCount
:timeoutlongNumber of milliseconds before execution is terminatedNo

Nested elements

  • :daemons (TaskList)

Reference

https://ant.apache.org/manual/Tasks/parallel.html

Defined by

org.apache.tools.ant.taskdefs.Parallel

Executes nested tasks in parallel with no guarantees of thread safety. Every task will
run in its own thread, with the likelihood of concurrency problems scaling with the
number of CPUs on the host system. Warning: While the Apache Ant core is believed to be
thread safe, no such guarantees are made about tasks, which are not tested for thread
safety during Ant's test process. Third party tasks may or may not be thread safe, and
some of Ant's core tasks, such as <javac> are definitely not re-entrant. This is because
they use libraries that were never designed to be used in a multithreaded environment.
The primary use case for <parallel> is to run external programs such as an application
server, and the JUnit or TestNG test suites at the same time. Anyone trying to run large
Ant task sequences in parallel, such as javadoc and javac at the same time, is
implicitly taking on the task of identifying and fixing all concurrency bugs the tasks
that they run. Accordingly, while this task has uses, it should be considered an
advanced task which should be used in certain batch processing or testing situations,
rather than an easy trick to speed up build times on a multicore CPU.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:failonany` | `boolean` | If any of the nested tasks fails, execution of the task completes at that point without waiting for any other tasks to complete. | No; default is false. |
| `:pollinterval` | `int` | Currently has no effect | No; default is 1000 |
| `:threadcount` | `int` | Maximum numbers of thread to use. | No |
| `:threadsperprocessor` | `int` | Maximum number of threads to use per available processor (Java 1.4+) | No; defers to threadCount |
| `:timeout` | `long` | Number of milliseconds before execution is terminated | No |

**Nested elements**

- `:daemons` (`TaskList`)

**Reference**

https://ant.apache.org/manual/Tasks/parallel.html

**Defined by**

`org.apache.tools.ant.taskdefs.Parallel`
sourceraw docstring

paramclj

(param & args)

Ant nested param. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:typeString
:valueString

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.Property
  • java.lang.Object
  • org.apache.tools.ant.taskdefs.Javadoc$DocletParam
  • org.apache.tools.ant.taskdefs.XSLTProcess$Param

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Parameter

Ant nested param. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:type` | `String` |  |  |
| `:value` | `String` |  |  |

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.Property`
- `java.lang.Object`
- `org.apache.tools.ant.taskdefs.Javadoc$DocletParam`
- `org.apache.tools.ant.taskdefs.XSLTProcess$Param`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Parameter`
sourceraw docstring

patchclj

(patch & args)

Applies a diff file to originals. Requires patch to be on the execution path.

Attributes

AttributeTypeDescriptionRequired
:backupsbooleanKeep backups of the unpatched filesNo
:destfileFilethe file to send the output to instead of patching the file(s) in place. since Apache Ant 1.6No
:dirFileThe directory in which to run the patch command.No; default is the project's basedir
:failonerrorbooleanStop the build process if the command exits with a return code signaling failure. since Ant 1.8.0No; defaults to false
:ignorewhitespacebooleanIgnore whitespace differences.No
:originalfileFilethe file to patchNo; tries to guess it from the diff file
:patchfileFilethe file that includes the diff outputYes
:quietbooleanWork silently unless an error occursNo
:reversebooleanAssume patch was created with old and new files swapped.No
:stripintStrip the smallest prefix containing num leading slashes from filenames.No

Reference

https://ant.apache.org/manual/Tasks/patch.html

Defined by

org.apache.tools.ant.taskdefs.Patch

Applies a diff file to originals. Requires patch to be on the execution path.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:backups` | `boolean` | Keep backups of the unpatched files | No |
| `:destfile` | `File` | the file to send the output to instead of patching the file(s) in place. since Apache Ant 1.6 | No |
| `:dir` | `File` | The directory in which to run the patch command. | No; default is the project's basedir |
| `:failonerror` | `boolean` | Stop the build process if the command exits with a return code signaling failure. since Ant 1.8.0 | No; defaults to false |
| `:ignorewhitespace` | `boolean` | Ignore whitespace differences. | No |
| `:originalfile` | `File` | the file to patch | No; tries to guess it from the diff file |
| `:patchfile` | `File` | the file that includes the diff output | Yes |
| `:quiet` | `boolean` | Work silently unless an error occurs | No |
| `:reverse` | `boolean` | Assume patch was created with old and new files swapped. | No |
| `:strip` | `int` | Strip the smallest prefix containing num leading slashes from filenames. | No |

**Reference**

https://ant.apache.org/manual/Tasks/patch.html

**Defined by**

`org.apache.tools.ant.taskdefs.Patch`
sourceraw docstring

pathclj

(path & args)

Ant type path. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

https://ant.apache.org/manual/Types/path.html

Defined by

org.apache.tools.ant.types.Path

Ant type path. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

https://ant.apache.org/manual/Types/path.html

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

pathconvertclj

(pathconvert & args)

Converts nested resource collections, or a reference to just one, into a path form for a particular platform, optionally storing the result into a property or writing to an Ant resource. It can also be used when you need to convert a resource collection into a list, separated by a given character, such as a comma or space, or, conversely, e.g. to convert a list of files in a FileList into a path. Nested <map> elements can be specified to map Windows drive letters to Unix paths, and vice-versa. More complex transformations can be achieved using a nested <mapper> (since Apache Ant 1.6.2).

Attributes

AttributeTypeDescriptionRequired
:destResourceA destination resource into which to write the converted path (Ant interprets this as a File by default). Since Ant 1.10.13No, result will be logged if neither @property nor @dest is set
:dirsepStringThe character(s) to use as the directory separator in the generated paths.No; defaults to current JVM File.separator
:pathsepStringThe character(s) to use as the path-element separator in the generated paths.No; defaults to current JVM File.pathSeparator
:preserveduplicatesbooleanWhether to preserve duplicate resources. Since Ant 1.8No; default is false
:propertyStringThe name of the property in which to place the converted path.No, result will be logged if neither @property nor @dest is set
:refidReferenceWhat to convert, given as a reference to a <path>, <fileset>, <dirset>, or <filelist> defined elsewhereYes, unless a nested <path> element is supplied
:setonemptybooleanShould the property be set, even if the result is the empty string?No; default is true
:targetosTargetOsThe target architecture. Must be one of unix, windows, netware, tandem or os/2. This is a shorthand mechanism for specifying both pathsep and dirsep according to the specified target architecture.No

Nested elements

  • :map (MapEntry)
  • :mapper (Mapper)
  • :path (Path)

Reference

https://ant.apache.org/manual/Tasks/pathconvert.html

Defined by

org.apache.tools.ant.taskdefs.PathConvert

Converts nested resource collections, or a reference to just one, into a path form for a
particular platform, optionally storing the result into a property or writing to an Ant
resource. It can also be used when you need to convert a resource collection into a
list, separated by a given character, such as a comma or space, or, conversely, e.g. to
convert a list of files in a FileList into a path. Nested <map> elements can be
specified to map Windows drive letters to Unix paths, and vice-versa. More complex
transformations can be achieved using a nested <mapper> (since Apache Ant 1.6.2).

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dest` | `Resource` | A destination resource into which to write the converted path (Ant interprets this as a File by default). Since Ant 1.10.13 | No, result will be logged if neither @property nor @dest is set |
| `:dirsep` | `String` | The character(s) to use as the directory separator in the generated paths. | No; defaults to current JVM File.separator |
| `:pathsep` | `String` | The character(s) to use as the path-element separator in the generated paths. | No; defaults to current JVM File.pathSeparator |
| `:preserveduplicates` | `boolean` | Whether to preserve duplicate resources. Since Ant 1.8 | No; default is false |
| `:property` | `String` | The name of the property in which to place the converted path. | No, result will be logged if neither @property nor @dest is set |
| `:refid` | `Reference` | What to convert, given as a reference to a <path>, <fileset>, <dirset>, or <filelist> defined elsewhere | Yes, unless a nested <path> element is supplied |
| `:setonempty` | `boolean` | Should the property be set, even if the result is the empty string? | No; default is true |
| `:targetos` | `TargetOs` | The target architecture. Must be one of unix, windows, netware, tandem or os/2. This is a shorthand mechanism for specifying both pathsep and dirsep according to the specified target architecture. | No |

**Nested elements**

- `:map` (`MapEntry`)
- `:mapper` (`Mapper`)
- `:path` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/pathconvert.html

**Defined by**

`org.apache.tools.ant.taskdefs.PathConvert`
sourceraw docstring

pathelementclj

(pathelement & args)

Ant nested pathelement. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:pathString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path$PathElement

Ant nested pathelement. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:path` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path$PathElement`
sourceraw docstring

patternsetclj

(patternset & args)

Patterns can be grouped to sets and later be referenced by their id attribute. They are defined via a patternset element, which can appear nested into a FileSet or a directory-based task that constitutes an implicit FileSet. In addition, patternsets can be defined as a stand alone element at the same level as target-i.e., as children of project as well as as children of target. Patterns can be specified by nested <include>, or <exclude> elements or the following attributes.

Attributes

AttributeTypeDescriptionRequired
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No files except default excludes are excluded.
:excludesfileFilename of a file; each line of this file is taken to be an exclude pattern. You can specify more than one exclude file by using a nested excludesfile elements.See excludes
:includesStringcomma- or space-separated list of patterns of files that must be included.All files are included.
:includesfileFilename of a file; each line of this file is taken to be an include pattern. You can specify more than one include file by using a nested includesfile elements. Note: if the file is empty and there are no other patterns defined for the fileset, all files will be included.See includes
:refidReferenceMakes this patternset a reference to a patternset defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :invert (PatternSet)
  • :patternset (PatternSet)

Reference

https://ant.apache.org/manual/Types/patternset.html

Defined by

org.apache.tools.ant.types.PatternSet

Patterns can be grouped to sets and later be referenced by their id attribute. They are
defined via a patternset element, which can appear nested into a FileSet or a
directory-based task that constitutes an implicit FileSet. In addition, patternsets can
be defined as a stand alone element at the same level as target-i.e., as children of
project as well as as children of target. Patterns can be specified by nested <include>,
or <exclude> elements or the following attributes.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No files except default excludes are excluded. |
| `:excludesfile` | `File` | name of a file; each line of this file is taken to be an exclude pattern. You can specify more than one exclude file by using a nested excludesfile elements. | See excludes |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | All files are included. |
| `:includesfile` | `File` | name of a file; each line of this file is taken to be an include pattern. You can specify more than one include file by using a nested includesfile elements. Note: if the file is empty and there are no other patterns defined for the fileset, all files will be included. | See includes |
| `:refid` | `Reference` | Makes this patternset a reference to a patternset defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:invert` (`PatternSet`)
- `:patternset` (`PatternSet`)

**Reference**

https://ant.apache.org/manual/Types/patternset.html

**Defined by**

`org.apache.tools.ant.types.PatternSet`
sourceraw docstring

permissionsclj

(permissions & args)

Note: Permissions requires the use of Java SecurityManager. Java version 17 deprecated SecurityManager for removal and Java 18 and higher versions, by default, disallow setting SecurityManager at runtime. Permissions is thus no longer supported when used in Java 18 or higher versions. Using it in those Java runtime versions will throw a org.apache.tools.ant.BuildException. Throwing of BuildException can be relaxed by setting the ant.securitymanager.usage.warn system or Ant property to true, which will then cause a warning to be logged instead of the exception being thrown. Even when ant.securitymanager.usage.warn is set to true, SecurityManager usage will still be disabled and no security checks will be performed. It is recommended to no longer use <permissions> Permissions represents a set of security permissions granted or revoked to a specific part code executed in the JVM where Apache Ant is running in. The actual Permissions are specified via a set of nested permission items either <grant>ed or <revoke>d. In the base situation a base set of permissions granted. Extra permissions can be granted. A granted permission can be overruled by revoking a permission. The security manager installed by the permissions will throw an SecurityException if the code subject to these permissions try to use an permission that has not been granted or that has been revoked.

Nested elements

  • :grant (Permission)
  • :revoke (Permission)

Reference

https://ant.apache.org/manual/Types/permissions.html

Defined by

org.apache.tools.ant.types.Permissions

Note: Permissions requires the use of Java SecurityManager. Java version 17 deprecated
SecurityManager for removal and Java 18 and higher versions, by default, disallow
setting SecurityManager at runtime. Permissions is thus no longer supported when used in
Java 18 or higher versions. Using it in those Java runtime versions will throw a
org.apache.tools.ant.BuildException. Throwing of BuildException can be relaxed by
setting the ant.securitymanager.usage.warn system or Ant property to true, which will
then cause a warning to be logged instead of the exception being thrown. Even when
ant.securitymanager.usage.warn is set to true, SecurityManager usage will still be
disabled and no security checks will be performed. It is recommended to no longer use
<permissions> Permissions represents a set of security permissions granted or revoked to
a specific part code executed in the JVM where Apache Ant is running in. The actual
Permissions are specified via a set of nested permission items either <grant>ed or
<revoke>d. In the base situation a base set of permissions granted. Extra permissions
can be granted. A granted permission can be overruled by revoking a permission. The
security manager installed by the permissions will throw an SecurityException if the
code subject to these permissions try to use an permission that has not been granted or
that has been revoked.

**Nested elements**

- `:grant` (`Permission`)
- `:revoke` (`Permission`)

**Reference**

https://ant.apache.org/manual/Types/permissions.html

**Defined by**

`org.apache.tools.ant.types.Permissions`
sourceraw docstring

posixgroupclj

(posixgroup & args)

Ant nested posixgroup. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:followsymlinksboolean
:groupString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.PosixGroupSelector

Ant nested posixgroup. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:followsymlinks` | `boolean` |  |  |
| `:group` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.PosixGroupSelector`
sourceraw docstring

posixpermissionsclj

(posixpermissions & args)

Ant nested posixpermissions. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:followsymlinksboolean
:permissionsString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.PosixPermissionsSelector

Ant nested posixpermissions. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:followsymlinks` | `boolean` |  |  |
| `:permissions` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.PosixPermissionsSelector`
sourceraw docstring

prefixlinesclj

(prefixlines & args)

Ant nested prefixlines. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:prefixString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.PrefixLines

Ant nested prefixlines. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:prefix` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.PrefixLines`
sourceraw docstring

presentclj

(present & args)

Ant nested present. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:presentFilePresence
:refidReference
:targetdirFile

Nested elements

  • :mapper (Mapper)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.PresentSelector

Ant nested present. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:present` | `FilePresence` |  |  |
| `:refid` | `Reference` |  |  |
| `:targetdir` | `File` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.PresentSelector`
sourceraw docstring

preserveintargetclj

(preserveintarget & args)

Ant nested preserveintarget. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:preserveemptydirsboolean
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Sync$SyncTarget

Ant nested preserveintarget. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:preserveemptydirs` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Sync$SyncTarget`
sourceraw docstring

presetdefclj

(presetdef & args)

The preset definition generates a new definition based on a current definition with some attributes or elements preset. The resolution of properties in any of the attributes or nested text takes place with the definition is used and not when the preset definition is defined.

Attributes

AttributeTypeDescriptionRequired
:nameStringthe name of the new definitionYes
:uriStringThe URI that this definition should live in.No

Reference

https://ant.apache.org/manual/Tasks/presetdef.html

Defined by

org.apache.tools.ant.taskdefs.PreSetDef

The preset definition generates a new definition based on a current definition with some
attributes or elements preset. The resolution of properties in any of the attributes or
nested text takes place with the definition is used and not when the preset definition
is defined.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` | the name of the new definition | Yes |
| `:uri` | `String` | The URI that this definition should live in. | No |

**Reference**

https://ant.apache.org/manual/Tasks/presetdef.html

**Defined by**

`org.apache.tools.ant.taskdefs.PreSetDef`
sourceraw docstring

projecthelperclj

(projecthelper & args)

This task is provided for the purpose of allowing the user to install a different ProjectHelper at run time. The helpers will be added after all the already registered helpers, but before the default one (ProjectHelper2) See the description of Apache Ant's Project Helper for more information.

Reference

https://ant.apache.org/manual/Tasks/projecthelper.html

Defined by

org.apache.tools.ant.taskdefs.ProjectHelperTask

This task is provided for the purpose of allowing the user to install a different
ProjectHelper at run time. The helpers will be added after all the already registered
helpers, but before the default one (ProjectHelper2) See the description of Apache Ant's
Project Helper for more information.

**Reference**

https://ant.apache.org/manual/Tasks/projecthelper.html

**Defined by**

`org.apache.tools.ant.taskdefs.ProjectHelperTask`
sourceraw docstring

propertyclj

(property & args)

Sets a property (by name and value), or set of properties (from file or resource) in the project. Properties are case sensitive. Properties are immutable: whoever sets a property first freezes it for the rest of the build; they are most definitely not variables. There are seven ways to set properties: By supplying both the name and one of value or location attributes. By supplying the name and nested text. By supplying both the name and refid attributes. By setting the file attribute with the filename of the property file to load. This property file has the format as defined by the file used in the class java.util.Properties, with the same rules about how non-ISO-8859-1 characters must be escaped. By setting the url attribute with the URL from which to load the properties. This URL must be directed to a file that has the format as defined by the file used in the class java.util.Properties. By setting the resource attribute with the resource name of the property file to load. A resource is a property file on the current classpath, or on the specified classpath. By setting the environment attribute with a prefix to use. Properties will be defined for every environment variable by prefixing the supplied name and a period to the name of the variable. By setting the runtime attribute with a prefix to use. Properties prefix.availableProcessors, prefix.freeMemory, prefix.totalMemory and prefix.maxMemory will be defined with values returned by the corresponding methods of the Runtime class. Although combinations of these ways are possible, only one should be used at a time. Problems might occur with the order in which properties are set, for instance. The value part of the properties being set might contain references to other properties. These references are resolved at the time these properties are set. This also holds for properties loaded from a property file. A list of predefined properties can be found here. Since Apache Ant 1.8.0, it is possible to load properties defined in XML according to Sun DTD, when running on Java 5+. For this the name of the file, resource or url has to end with .xml.

Attributes

AttributeTypeDescriptionRequired
:basedirFileThe basedir to calculate the relative path from. Since Ant 1.8.0No; default is project's basedir
:classpathPaththe classpath to use when looking up a resource.No
:classpathrefReferencethe classpath to use when looking up a resource, given as reference to a <path> defined elsewhere..No
:environmentStringthe prefix to use when retrieving environment variables. Thus if you specify environment=myenv you will be able to access OS-specific environment variables via property names myenv.PATH or myenv.TERM. Note that if you supply a property name with a final. it will not be doubled; i.e. environment=myenv. will still allow access of environment variables through myenv.PATH and myenv.TERM. This functionality is currently only implemented on select platforms. Feel free to send patches to increase the number of platforms on which this functionality is supported;-). Note also that properties are case-sensitive, even if the environment variables on your operating system are not; e.g. Windows 2000 or later system path variable is set to an Ant property named env.Path rather than env.PATH.One of these, unless the name attribute is set
:fileFilethe location of the properties file to load.One of these, unless the name attribute is set
:nameStringthe name of the property to set.No
:prefixStringPrefix to apply to properties loaded using file, resource, or url. A. is appended to the prefix if not specified.No
:prefixvaluesbooleanWhether to apply the prefix when expanding the right hand side of properties loaded using file, resource, or url. Since Ant 1.8.2No; default is false
:refidReferenceReference to an object defined elsewhere. Only yields reasonable results for references to path-like structures or properties.One of these or nested text, when the name attribute is set
:relativebooleanIf set to true the relative path to basedir is set. Since Ant 1.8.0No; default is false
:resourceStringthe name of the classpath resource containing properties settings in properties file format.One of these, unless the name attribute is set
:runtimeStringthe prefix to use when retrieving runtime properties. Thus if you specify runtime=myrt you will be able to access runtime values corresponding to methods in the Runtime class via property names myrt.availableProcessors, myrt.maxMemory, myrt.totalMemory or myrt.freeMemory. Note that if you supply a property name with a final. it will not be doubled; i.e. runtime=myrt. will still allow access of runtime properties as e.g. myrt.maxMemory. Note also that the property values are snapshots taken at the point in time when the property has been executed. Since Ant 1.10.4One of these, unless the name attribute is set
:urlURLa URL containing properties-format settings.One of these, unless the name attribute is set
:userpropertyboolean
:valueObjectthe value of the property.One of these or nested text, when the name attribute is set

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/property.html

Defined by

org.apache.tools.ant.taskdefs.Property

Sets a property (by name and value), or set of properties (from file or resource) in the
project. Properties are case sensitive. Properties are immutable: whoever sets a
property first freezes it for the rest of the build; they are most definitely not
variables. There are seven ways to set properties: By supplying both the name and one of
value or location attributes. By supplying the name and nested text. By supplying both
the name and refid attributes. By setting the file attribute with the filename of the
property file to load. This property file has the format as defined by the file used in
the class java.util.Properties, with the same rules about how non-ISO-8859-1 characters
must be escaped. By setting the url attribute with the URL from which to load the
properties. This URL must be directed to a file that has the format as defined by the
file used in the class java.util.Properties. By setting the resource attribute with the
resource name of the property file to load. A resource is a property file on the current
classpath, or on the specified classpath. By setting the environment attribute with a
prefix to use. Properties will be defined for every environment variable by prefixing
the supplied name and a period to the name of the variable. By setting the runtime
attribute with a prefix to use. Properties prefix.availableProcessors,
prefix.freeMemory, prefix.totalMemory and prefix.maxMemory will be defined with values
returned by the corresponding methods of the Runtime class. Although combinations of
these ways are possible, only one should be used at a time. Problems might occur with
the order in which properties are set, for instance. The value part of the properties
being set might contain references to other properties. These references are resolved at
the time these properties are set. This also holds for properties loaded from a property
file. A list of predefined properties can be found here. Since Apache Ant 1.8.0, it is
possible to load properties defined in XML according to Sun DTD, when running on Java
5+. For this the name of the file, resource or url has to end with .xml.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | The basedir to calculate the relative path from. Since Ant 1.8.0 | No; default is project's basedir |
| `:classpath` | `Path` | the classpath to use when looking up a resource. | No |
| `:classpathref` | `Reference` | the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere.. | No |
| `:environment` | `String` | the prefix to use when retrieving environment variables. Thus if you specify environment=myenv you will be able to access OS-specific environment variables via property names myenv.PATH or myenv.TERM. Note that if you supply a property name with a final. it will not be doubled; i.e. environment=myenv. will still allow access of environment variables through myenv.PATH and myenv.TERM. This functionality is currently only implemented on select platforms. Feel free to send patches to increase the number of platforms on which this functionality is supported;-). Note also that properties are case-sensitive, even if the environment variables on your operating system are not; e.g. Windows 2000 or later system path variable is set to an Ant property named env.Path rather than env.PATH. | One of these, unless the name attribute is set |
| `:file` | `File` | the location of the properties file to load. | One of these, unless the name attribute is set |
| `:name` | `String` | the name of the property to set. | No |
| `:prefix` | `String` | Prefix to apply to properties loaded using file, resource, or url. A. is appended to the prefix if not specified. | No |
| `:prefixvalues` | `boolean` | Whether to apply the prefix when expanding the right hand side of properties loaded using file, resource, or url. Since Ant 1.8.2 | No; default is false |
| `:refid` | `Reference` | Reference to an object defined elsewhere. Only yields reasonable results for references to path-like structures or properties. | One of these or nested text, when the name attribute is set |
| `:relative` | `boolean` | If set to true the relative path to basedir is set. Since Ant 1.8.0 | No; default is false |
| `:resource` | `String` | the name of the classpath resource containing properties settings in properties file format. | One of these, unless the name attribute is set |
| `:runtime` | `String` | the prefix to use when retrieving runtime properties. Thus if you specify runtime=myrt you will be able to access runtime values corresponding to methods in the Runtime class via property names myrt.availableProcessors, myrt.maxMemory, myrt.totalMemory or myrt.freeMemory. Note that if you supply a property name with a final. it will not be doubled; i.e. runtime=myrt. will still allow access of runtime properties as e.g. myrt.maxMemory. Note also that the property values are snapshots taken at the point in time when the property has been executed. Since Ant 1.10.4 | One of these, unless the name attribute is set |
| `:url` | `URL` | a URL containing properties-format settings. | One of these, unless the name attribute is set |
| `:userproperty` | `boolean` |  |  |
| `:value` | `Object` | the value of the property. | One of these or nested text, when the name attribute is set |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/property.html

**Defined by**

`org.apache.tools.ant.taskdefs.Property`
sourceraw docstring

propertyfileclj

(propertyfile & args)

Apache Ant provides an optional task for editing property files. This is very useful when wanting to make unattended modifications to configuration files for application servers and applications. Currently, the task maintains a working property file with the ability to add properties or make changes to existing ones. Since Ant 1.8.0 comments and layout of the original properties file are preserved. Since Ant 1.8.2 the linefeed-style of the original file will be preserved as well, as long as style used to be consistent. In general, linefeeds of the updated file will be the same as the first linefeed found when reading it.

Attributes

AttributeTypeDescriptionRequired
:commentStringHeader for the file itselfNo
:fileFileLocation of the property file to be editedYes
:jdkpropertiesbooleanUse java.lang.Properties, which will lose comments and layout of file. since Ant 1.8.0No; default is false

Nested elements

  • :entry (Entry)

Reference

https://ant.apache.org/manual/Tasks/propertyfile.html

Defined by

org.apache.tools.ant.taskdefs.optional.PropertyFile

Apache Ant provides an optional task for editing property files. This is very useful
when wanting to make unattended modifications to configuration files for application
servers and applications. Currently, the task maintains a working property file with the
ability to add properties or make changes to existing ones. Since Ant 1.8.0 comments and
layout of the original properties file are preserved. Since Ant 1.8.2 the linefeed-style
of the original file will be preserved as well, as long as style used to be consistent.
In general, linefeeds of the updated file will be the same as the first linefeed found
when reading it.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:comment` | `String` | Header for the file itself | No |
| `:file` | `File` | Location of the property file to be edited | Yes |
| `:jdkproperties` | `boolean` | Use java.lang.Properties, which will lose comments and layout of file. since Ant 1.8.0 | No; default is false |

**Nested elements**

- `:entry` (`Entry`)

**Reference**

https://ant.apache.org/manual/Tasks/propertyfile.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.PropertyFile`
sourceraw docstring

propertyhelperclj

(propertyhelper & args)

This task is provided for the purpose of allowing the user to (a) install a different PropertyHelper at run time, or (b) (hopefully more often) install one or more PropertyHelper Delegates into the PropertyHelper active on the current Project. This is somewhat advanced Apache Ant usage and assumes a working familiarity with the modern Ant APIs. See the description of Ant's Property Helper for more information.

Nested elements

  • :delegate (DelegateElement)

Reference

https://ant.apache.org/manual/Tasks/propertyhelper.html

Defined by

org.apache.tools.ant.taskdefs.PropertyHelperTask

This task is provided for the purpose of allowing the user to (a) install a different
PropertyHelper at run time, or (b) (hopefully more often) install one or more
PropertyHelper Delegates into the PropertyHelper active on the current Project. This is
somewhat advanced Apache Ant usage and assumes a working familiarity with the modern Ant
APIs. See the description of Ant's Property Helper for more information.

**Nested elements**

- `:delegate` (`DelegateElement`)

**Reference**

https://ant.apache.org/manual/Tasks/propertyhelper.html

**Defined by**

`org.apache.tools.ant.taskdefs.PropertyHelperTask`
sourceraw docstring

propertyrefclj

(propertyref & args)

Ant nested propertyref. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:builtinBuiltinPropertySetName
:nameString
:prefixString
:regexString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PropertySet$PropertyRef

Ant nested propertyref. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:builtin` | `BuiltinPropertySetName` |  |  |
| `:name` | `String` |  |  |
| `:prefix` | `String` |  |  |
| `:regex` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PropertySet$PropertyRef`
sourceraw docstring

propertyresourceclj

(propertyresource & args)

Ant type propertyresource. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:directoryboolean
:existsboolean
:lastmodifiedlong
:nameString
:refidReference
:sizelong

Reference

https://ant.apache.org/manual/Types/propertyresource.html

Defined by

org.apache.tools.ant.types.resources.PropertyResource

Ant type propertyresource. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

https://ant.apache.org/manual/Types/propertyresource.html

**Defined by**

`org.apache.tools.ant.types.resources.PropertyResource`
sourceraw docstring

propertysetclj

(propertyset & args)

Since Apache Ant 1.6 Groups a set of properties to be used by reference in a task that supports this.

Attributes

AttributeTypeDescriptionRequired
:dynamicbooleanWhether to reevaluate the set every time the set is used.No; default is true
:negatebooleanWhether to negate results. If true, all properties not selected by nested elements will be returned. Since Ant 1.6.2No; default is false
:refidReferenceMakes this propertyset a reference to a propertyset defined elsewhere. If specified no other attributes or nested elements are allowed.No

Nested elements

  • :mapper (Mapper)
  • :propertyref (PropertyRef)
  • :propertyset (PropertySet)

Reference

https://ant.apache.org/manual/Types/propertyset.html

Defined by

org.apache.tools.ant.types.PropertySet

Since Apache Ant 1.6 Groups a set of properties to be used by reference in a task that
supports this.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dynamic` | `boolean` | Whether to reevaluate the set every time the set is used. | No; default is true |
| `:negate` | `boolean` | Whether to negate results. If true, all properties not selected by nested elements will be returned. Since Ant 1.6.2 | No; default is false |
| `:refid` | `Reference` | Makes this propertyset a reference to a propertyset defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Nested elements**

- `:mapper` (`Mapper`)
- `:propertyref` (`PropertyRef`)
- `:propertyset` (`PropertySet`)

**Reference**

https://ant.apache.org/manual/Types/propertyset.html

**Defined by**

`org.apache.tools.ant.types.PropertySet`
sourceraw docstring

providerclj

(provider & args)

Ant nested provider. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.spi.Provider

Ant nested provider. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.spi.Provider`
sourceraw docstring

pvcsclj

(pvcs & args)

The pvcs task is set to point at a PVCS repository and optionally a project within that repository, and can from that specification get the latest version of the files contained by the repository.

Attributes

AttributeTypeDescriptionRequired
:configFilepath of a non default .cfg file. Can be given absolute or relative to project's base directory.No
:filenameformatStringThe format of your folder names in a format suitable for java.text.MessageFormat. Repositories where the archive extension is not -arc should set this.No; defaults to {0}-arc({1})
:forceStringIf set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions!No; default is no
:ignorereturncodebooleanIf set to true the return value from executing the PVCS commands are ignored.No
:labelStringOnly files marked with this label are extracted.No
:linestartStringUsed to parse the output of the pcli command. The parser already knows about / and \, this property is useful in cases where the repository is accessed on a Windows platform via a drive letter mapping.No; defaults to "P:
:promotiongroupStringOnly files within this promotion group are extracted. Using both the label and the promotiongroup tag will cause the files in the promotion group and with that label to be extracted.No
:pvcsbinStringOn some systems the PVCS executables pcli and get are not found in the PATH. In such cases this attribute should be set to the bin directory of the PVCS installation containing the executables mentioned before. If this attribute isn't specified the tag expects the executables to be found using the PATH environment variable.No
:pvcsprojectStringThe project within the PVCS repository to extract files from.No; defaults to root project, /
:repositoryStringThe location of the repository (see your PVCS manuals).Yes
:revisionStringRetrieve the specified revision.No
:updateonlybooleanIf set to true files are gotten only if newer than existing local files.No
:useridStringUse the specified userid.No
:workspaceStringBy specifying a workspace, the files are extracted to that location. A PVCS workspace is a name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace using the PVCS GUI clients.No; defaults to default workspace for the current user

Nested elements

  • :pvcsproject (PvcsProject)

Reference

https://ant.apache.org/manual/Tasks/pvcstask.html#pvcs

Defined by

org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs

The pvcs task is set to point at a PVCS repository and optionally a project within that
repository, and can from that specification get the latest version of the files
contained by the repository.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:config` | `File` | path of a non default .cfg file. Can be given absolute or relative to project's base directory. | No |
| `:filenameformat` | `String` | The format of your folder names in a format suitable for java.text.MessageFormat. Repositories where the archive extension is not -arc should set this. | No; defaults to {0}-arc({1}) |
| `:force` | `String` | If set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions! | No; default is no |
| `:ignorereturncode` | `boolean` | If set to true the return value from executing the PVCS commands are ignored. | No |
| `:label` | `String` | Only files marked with this label are extracted. | No |
| `:linestart` | `String` | Used to parse the output of the pcli command. The parser already knows about / and \\, this property is useful in cases where the repository is accessed on a Windows platform via a drive letter mapping. | No; defaults to "P: |
| `:promotiongroup` | `String` | Only files within this promotion group are extracted. Using both the label and the promotiongroup tag will cause the files in the promotion group and with that label to be extracted. | No |
| `:pvcsbin` | `String` | On some systems the PVCS executables pcli and get are not found in the PATH. In such cases this attribute should be set to the bin directory of the PVCS installation containing the executables mentioned before. If this attribute isn't specified the tag expects the executables to be found using the PATH environment variable. | No |
| `:pvcsproject` | `String` | The project within the PVCS repository to extract files from. | No; defaults to root project, / |
| `:repository` | `String` | The location of the repository (see your PVCS manuals). | Yes |
| `:revision` | `String` | Retrieve the specified revision. | No |
| `:updateonly` | `boolean` | If set to true files are gotten only if newer than existing local files. | No |
| `:userid` | `String` | Use the specified userid. | No |
| `:workspace` | `String` | By specifying a workspace, the files are extracted to that location. A PVCS workspace is a name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace using the PVCS GUI clients. | No; defaults to default workspace for the current user |

**Nested elements**

- `:pvcsproject` (`PvcsProject`)

**Reference**

https://ant.apache.org/manual/Tasks/pvcstask.html#pvcs

**Defined by**

`org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs`
sourceraw docstring

pvcsprojectclj

(pvcsproject & args)

Ant nested pvcsproject. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject

Ant nested pvcsproject. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject`
sourceraw docstring

readableclj

(readable & args)

Ant nested readable. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.ReadableSelector

Ant nested readable. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.ReadableSelector`
sourceraw docstring

recordclj

(record & args)

A recorder is a listener to the current build process that records the output to a file. Several recorders can exist at the same time. Each recorder is associated with a file. The filename is used as a unique identifier for the recorders. The first call to the record task with an unused filename will create a recorder (using the parameters provided) and add it to the listeners of the build. All subsequent calls to the record task using this filename will modify that recorder's state (recording or not) or other properties (like logging level). Some technical issues: the file's print stream is flushed for finished events (buildFinished, targetFinished and taskFinished), and is closed on a buildFinished event.

Attributes

AttributeTypeDescriptionRequired
:actionActionChoicesThis tells the logger what to do: should it start recording or stop? The first time that the recorder task is called for this logfile, and if this attribute is not provided, then the default for this attribute is start. If this attribute is not provided on subsequent calls, then the state remains as previous.No [values = start|stop, default = no state change]
:appendbooleanShould the recorder append to a file, or create a new one? This is only applicable the first time this task is called for this file.No [values = start|stop, default = no state change]
:emacsmodebooleanRemoves [task] banners like Apache Ant's -emacs command line switch if set to true.No; default is false
:loglevelVerbosityLevelChoicesAt what logging level should this recorder instance record to? This is not a once only parameter (like append is)-you can increase or decrease the logging level as the build process continues.No [values = error|warn|info|verbose|debug, default = no change]
:nameStringThe name of the file this logger is associated with.Yes

Reference

https://ant.apache.org/manual/Tasks/recorder.html

Defined by

org.apache.tools.ant.taskdefs.Recorder

A recorder is a listener to the current build process that records the output to a file.
Several recorders can exist at the same time. Each recorder is associated with a file.
The filename is used as a unique identifier for the recorders. The first call to the
record task with an unused filename will create a recorder (using the parameters
provided) and add it to the listeners of the build. All subsequent calls to the record
task using this filename will modify that recorder's state (recording or not) or other
properties (like logging level). Some technical issues: the file's print stream is
flushed for finished events (buildFinished, targetFinished and taskFinished), and is
closed on a buildFinished event.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:action` | `ActionChoices` | This tells the logger what to do: should it start recording or stop? The first time that the recorder task is called for this logfile, and if this attribute is not provided, then the default for this attribute is start. If this attribute is not provided on subsequent calls, then the state remains as previous. | No [values = start\|stop, default = no state change] |
| `:append` | `boolean` | Should the recorder append to a file, or create a new one? This is only applicable the first time this task is called for this file. | No [values = start\|stop, default = no state change] |
| `:emacsmode` | `boolean` | Removes [task] banners like Apache Ant's -emacs command line switch if set to true. | No; default is false |
| `:loglevel` | `VerbosityLevelChoices` | At what logging level should this recorder instance record to? This is not a once only parameter (like append is)-you can increase or decrease the logging level as the build process continues. | No [values = error\|warn\|info\|verbose\|debug, default = no change] |
| `:name` | `String` | The name of the file this logger is associated with. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/recorder.html

**Defined by**

`org.apache.tools.ant.taskdefs.Recorder`
sourceraw docstring

redirectorclj

(redirector & args)

Since Apache Ant 1.6.2 For many tasks, input and output can be defined in a fairly straightforward fashion. The exec task, used to execute an external process, stands as a very basic example. The executed process may accept input, produce output, or do either or both depending upon various circumstances. Output may be classified as output or as error output. The <redirector> type provides a concrete means of redirecting input and output featuring the use of File Mappers to specify source (input) and destination (output/error) files. The <redirector> element accepts the following attributes:

Attributes

AttributeTypeDescriptionRequired
:alwayslogbooleanAlways send to the log in addition to any other destination. Since Ant 1.6.3No; default is false
:appendbooleanWhether output and error files should be appended to rather than overwritten.No; defaults to false
:binaryoutputbooleanWhen set to true Ant will not try to split the output into lines-which it will usually do in order to separate error from normal output. This setting will not prevent binary output from getting corrupted if you also specify filter chains. Since Ant 1.9.4No; default is false
:createemptyfilesbooleanWhether output and error files should be created even when empty.No; defaults to true
:errorFileThe file to which the standard error of the command should be redirected.No
:errorencodingStringThe error encoding.No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored.No
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute.No
:inputencodingStringThe input encoding.No
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute.No
:logerrorbooleanThis attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property.No; ignored if error or errorProperty is set
:loginputstringbooleanControls the display of inputstring's value in log messages. Set to false when sending sensitive data (e.g. passwords) to external processes. Since Ant 1.6.3No; default is true
:outputFileName of a file to which output should be written. If the error stream is not also redirected to a file or property, it will appear in this output.No
:outputencodingStringThe output encoding.No
:outputpropertyStringThe name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output.No
:refidReference

Nested elements

  • :errorfilterchain (FilterChain)
  • :errormapper (Mapper)
  • :inputfilterchain (FilterChain)
  • :inputmapper (Mapper)
  • :outputfilterchain (FilterChain)
  • :outputmapper (Mapper)

Reference

https://ant.apache.org/manual/Types/redirector.html

Defined by

org.apache.tools.ant.types.RedirectorElement

Since Apache Ant 1.6.2 For many tasks, input and output can be defined in a fairly
straightforward fashion. The exec task, used to execute an external process, stands as a
very basic example. The executed process may accept input, produce output, or do either
or both depending upon various circumstances. Output may be classified as output or as
error output. The <redirector> type provides a concrete means of redirecting input and
output featuring the use of File Mappers to specify source (input) and destination
(output/error) files. The <redirector> element accepts the following attributes:

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:alwayslog` | `boolean` | Always send to the log in addition to any other destination. Since Ant 1.6.3 | No; default is false |
| `:append` | `boolean` | Whether output and error files should be appended to rather than overwritten. | No; defaults to false |
| `:binaryoutput` | `boolean` | When set to true Ant will not try to split the output into lines-which it will usually do in order to separate error from normal output. This setting will not prevent binary output from getting corrupted if you also specify filter chains. Since Ant 1.9.4 | No; default is false |
| `:createemptyfiles` | `boolean` | Whether output and error files should be created even when empty. | No; defaults to true |
| `:error` | `File` | The file to which the standard error of the command should be redirected. | No |
| `:errorencoding` | `String` | The error encoding. | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. | No |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. | No |
| `:inputencoding` | `String` | The input encoding. | No |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. | No |
| `:logerror` | `boolean` | This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. | No; ignored if error or errorProperty is set |
| `:loginputstring` | `boolean` | Controls the display of inputstring's value in log messages. Set to false when sending sensitive data (e.g. passwords) to external processes. Since Ant 1.6.3 | No; default is true |
| `:output` | `File` | Name of a file to which output should be written. If the error stream is not also redirected to a file or property, it will appear in this output. | No |
| `:outputencoding` | `String` | The output encoding. | No |
| `:outputproperty` | `String` | The name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. | No |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:errorfilterchain` (`FilterChain`)
- `:errormapper` (`Mapper`)
- `:inputfilterchain` (`FilterChain`)
- `:inputmapper` (`Mapper`)
- `:outputfilterchain` (`FilterChain`)
- `:outputmapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Types/redirector.html

**Defined by**

`org.apache.tools.ant.types.RedirectorElement`
sourceraw docstring

referenceclj

(reference & args)

Ant nested reference. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:refidString
:torefidString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Ant$Reference

Ant nested reference. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:refid` | `String` |  |  |
| `:torefid` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Ant$Reference`
sourceraw docstring

regexpclj

(regexp & args)

Regexp represents a regular expression.

Attributes

AttributeTypeDescriptionRequired
:patternStringregular expression patternYes
:refidReferenceMakes this regexp a reference to a regexp defined elsewhere. If specified no other attributes or nested elements are allowed.No

Reference

https://ant.apache.org/manual/Types/regexp.html

Defined by

org.apache.tools.ant.types.RegularExpression

Regexp represents a regular expression.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:pattern` | `String` | regular expression pattern | Yes |
| `:refid` | `Reference` | Makes this regexp a reference to a regexp defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Reference**

https://ant.apache.org/manual/Types/regexp.html

**Defined by**

`org.apache.tools.ant.types.RegularExpression`
sourceraw docstring

regexpmapperclj

(regexpmapper & args)

Ant type regexpmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:fromString
:handledirsepboolean
:toString

Reference

https://ant.apache.org/manual/Types/regexpmapper.html

Defined by

org.apache.tools.ant.util.RegexpPatternMapper

Ant type regexpmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:from` | `String` |  |  |
| `:handledirsep` | `boolean` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/regexpmapper.html

**Defined by**

`org.apache.tools.ant.util.RegexpPatternMapper`
sourceraw docstring

releaseinfoclj

(releaseinfo & args)

Ant nested releaseinfo. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:deleteString
:fileFile

Nested elements

  • :add (ReleaseInfoEntry)
  • :delete (ReleaseInfoKey)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$ReleaseInfo

Ant nested releaseinfo. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:delete` | `String` |  |  |
| `:file` | `File` |  |  |

**Nested elements**

- `:add` (`ReleaseInfoEntry`)
- `:delete` (`ReleaseInfoKey`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$ReleaseInfo`
sourceraw docstring

remotetunnelclj

(remotetunnel & args)

Ant nested remotetunnel. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:lhostString
:lportint
:rportint

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ssh.SSHSession$RemoteTunnel

Ant nested remotetunnel. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:lhost` | `String` |  |  |
| `:lport` | `int` |  |  |
| `:rport` | `int` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ssh.SSHSession$RemoteTunnel`
sourceraw docstring

renameclj

(rename & args)

Renames a given file.

Attributes

AttributeTypeDescriptionRequired
:destFilenew name of the file.Yes
:replaceStringEnable replacing of existing file.No; default is on
:srcFilefile to rename.Yes

Reference

https://ant.apache.org/manual/Tasks/rename.html

Defined by

org.apache.tools.ant.taskdefs.Rename

Renames a given file.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dest` | `File` | new name of the file. | Yes |
| `:replace` | `String` | Enable replacing of existing file. | No; default is on |
| `:src` | `File` | file to rename. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/rename.html

**Defined by**

`org.apache.tools.ant.taskdefs.Rename`
sourceraw docstring

renameextclj

(renameext & args)

Renames files in the srcDir directory ending with the fromExtension string so that they end with the toExtension string. Files are only replaced if replace is true. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes srcDir) as well as the nested <include>, <exclude> and <patternset> elements.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:followsymlinksboolean
:fromextensionStringThe string that files must end in to be renamedYes
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:replacebooleanWhether the file being renamed to should be replaced if it already existsNo
:srcdirFileThe starting directory for files to search inYes
:toextensionStringThe string that renamed files will end with on completionYes

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/renameextensions.html

Defined by

org.apache.tools.ant.taskdefs.optional.RenameExtensions

Renames files in the srcDir directory ending with the fromExtension string so that they
end with the toExtension string. Files are only replaced if replace is true. See the
section on directory based tasks, on how the inclusion/exclusion of files works, and how
to write patterns. This task forms an implicit FileSet and supports most attributes of
<fileset> (dir becomes srcDir) as well as the nested <include>, <exclude> and
<patternset> elements.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:followsymlinks` | `boolean` |  |  |
| `:fromextension` | `String` | The string that files must end in to be renamed | Yes |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:replace` | `boolean` | Whether the file being renamed to should be replaced if it already exists | No |
| `:srcdir` | `File` | The starting directory for files to search in | Yes |
| `:toextension` | `String` | The string that renamed files will end with on completion | Yes |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/renameextensions.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.RenameExtensions`
sourceraw docstring

replaceclj

(replace & args)

Replace is a directory based task for replacing the occurrence of a given string with another string in selected file. If you want to replace a text that crosses line boundaries, you must use a nested <replacetoken> element. The output file is only written if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which have been regenerated by this task.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:dirFileThe base directory to use when replacing a token in multiple files.Exactly one of the two
:encodingStringThe encoding of the files upon which replace operates.No; defaults to default JVM character encoding
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:failonnoreplacementsbooleanWhether to fail the build if the task didn't do anything. since Ant 1.8.0.No; defaults to false
:fileFilefile for which the token should be replaced.Exactly one of the two
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:preservelastmodifiedbooleanKeep the file timestamp(s) even if the file(s) is(are) modified. since Apache Ant 1.8.0.No; defaults to false
:propertyfileFilevalid property file from which properties specified using nested <replacefilter> elements are drawn.Yes, only if property attribute of <replacefilter> is used.
:propertyresourceResource
:replacefilterfileFilevalid property file. Each property will be treated as a replacefilter where token is the name of the property and value is the property's value.No
:replacefilterresourceResource
:summarybooleanIndicates whether a summary of the replace operation should be produced, detailing how many token occurrences and files were processedNo; defaults to no summary
:tokenStringthe token which must be replaced.Yes, unless a nested replacetoken element or the replacefilterfile attribute is used.
:valueStringthe new value for the token.No; defaults to empty string ()

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :replacefilter (Replacefilter)
  • :replacetoken (NestedString)
  • :replacevalue (NestedString)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/replace.html

Defined by

org.apache.tools.ant.taskdefs.Replace

Replace is a directory based task for replacing the occurrence of a given string with
another string in selected file. If you want to replace a text that crosses line
boundaries, you must use a nested <replacetoken> element. The output file is only
written if it differs from the existing file. This prevents spurious rebuilds based on
unchanged files which have been regenerated by this task.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:dir` | `File` | The base directory to use when replacing a token in multiple files. | Exactly one of the two |
| `:encoding` | `String` | The encoding of the files upon which replace operates. | No; defaults to default JVM character encoding |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:failonnoreplacements` | `boolean` | Whether to fail the build if the task didn't do anything. since Ant 1.8.0. | No; defaults to false |
| `:file` | `File` | file for which the token should be replaced. | Exactly one of the two |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:preservelastmodified` | `boolean` | Keep the file timestamp(s) even if the file(s) is(are) modified. since Apache Ant 1.8.0. | No; defaults to false |
| `:propertyfile` | `File` | valid property file from which properties specified using nested <replacefilter> elements are drawn. | Yes, only if property attribute of <replacefilter> is used. |
| `:propertyresource` | `Resource` |  |  |
| `:replacefilterfile` | `File` | valid property file. Each property will be treated as a replacefilter where token is the name of the property and value is the property's value. | No |
| `:replacefilterresource` | `Resource` |  |  |
| `:summary` | `boolean` | Indicates whether a summary of the replace operation should be produced, detailing how many token occurrences and files were processed | No; defaults to no summary |
| `:token` | `String` | the token which must be replaced. | Yes, unless a nested replacetoken element or the replacefilterfile attribute is used. |
| `:value` | `String` | the new value for the token. | No; defaults to empty string () |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:replacefilter` (`Replacefilter`)
- `:replacetoken` (`NestedString`)
- `:replacevalue` (`NestedString`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/replace.html

**Defined by**

`org.apache.tools.ant.taskdefs.Replace`
sourceraw docstring

replacefilterclj

(replacefilter & args)

Ant nested replacefilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:propertyString
:tokenString
:valueString

Nested elements

  • :replacetoken (NestedString)
  • :replacevalue (NestedString)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Replace$Replacefilter

Ant nested replacefilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:property` | `String` |  |  |
| `:token` | `String` |  |  |
| `:value` | `String` |  |  |

**Nested elements**

- `:replacetoken` (`NestedString`)
- `:replacevalue` (`NestedString`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Replace$Replacefilter`
sourceraw docstring

replaceregexclj

(replaceregex & args)

Ant nested replaceregex. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean
:flagsString
:patternString
:replaceString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$ReplaceRegex

Ant nested replaceregex. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |
| `:flags` | `String` |  |  |
| `:pattern` | `String` |  |  |
| `:replace` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$ReplaceRegex`
sourceraw docstring

replaceregexpclj

(replaceregexp & args)

ReplaceRegExp is a directory based task for replacing the occurrence of a given regular expression with a substitution pattern in a selected file or set of files. The output file is only written if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which have been regenerated by this task. In order to assess whether a file has changed, this task will create a pre-processed version of the source file inside of the temporary directory. Similar to regexp type mappers this task needs a supporting regular expression library and an implementation of org.apache.tools.ant.util.regexp.Regexp. See details in the documentation of the Regexp Type.

Attributes

AttributeTypeDescriptionRequired
:bylinebooleanProcess the file(s) one line at a time, executing the replacement on one line at a time (true|false). This is useful if you want to only replace the first occurrence of a regular expression on each line, which is not easy to do when processing the file as a whole.No; defaults to false
:encodingStringThe encoding of the file. since Apache Ant 1.6No; defaults to default JVM character encoding
:failonerrorbooleanStop the build process if certain file operations fail. For historical reasons the task swallows and logs certain failure cases, enabling this option makes sure the exception make the build fail instead. since Ant 1.10.15No; defaults to false
:fileFilefile for which the regular expression should be replaced.Yes, unless nested <fileset> is used
:flagsStringThe flags to use when matching the regular expression. For more information, consult the Perl 5 syntax g: Global replacement. Replace all occurrences found i: Case Insensitive. Do not consider case in the match m: Multiline. Treat the string as multiple lines of input, using ^ and $ as the start or end of any line, respectively, rather than start or end of string. s: Singleline. Treat the string as a single line of input, using. to match any character, including a newline, which normally, it would not match.No
:matchStringThe regular expression pattern to match in the file(s)Yes, unless nested <regexp> is used
:preservelastmodifiedbooleanKeep the file timestamp(s) even if the file(s) is(are) modified. since Ant 1.8.0.No; defaults to false
:replaceStringThe substitution pattern to place in the file(s) in place of the regular expression.Yes, unless nested <substitution> is used

Nested elements

  • :fileset (FileSet)
  • :regexp (RegularExpression)
  • :substitution (Substitution)

Reference

https://ant.apache.org/manual/Tasks/replaceregexp.html

Defined by

org.apache.tools.ant.taskdefs.optional.ReplaceRegExp

ReplaceRegExp is a directory based task for replacing the occurrence of a given regular
expression with a substitution pattern in a selected file or set of files. The output
file is only written if it differs from the existing file. This prevents spurious
rebuilds based on unchanged files which have been regenerated by this task. In order to
assess whether a file has changed, this task will create a pre-processed version of the
source file inside of the temporary directory. Similar to regexp type mappers this task
needs a supporting regular expression library and an implementation of
org.apache.tools.ant.util.regexp.Regexp. See details in the documentation of the Regexp
Type.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` | Process the file(s) one line at a time, executing the replacement on one line at a time (true\|false). This is useful if you want to only replace the first occurrence of a regular expression on each line, which is not easy to do when processing the file as a whole. | No; defaults to false |
| `:encoding` | `String` | The encoding of the file. since Apache Ant 1.6 | No; defaults to default JVM character encoding |
| `:failonerror` | `boolean` | Stop the build process if certain file operations fail. For historical reasons the task swallows and logs certain failure cases, enabling this option makes sure the exception make the build fail instead. since Ant 1.10.15 | No; defaults to false |
| `:file` | `File` | file for which the regular expression should be replaced. | Yes, unless nested <fileset> is used |
| `:flags` | `String` | The flags to use when matching the regular expression. For more information, consult the Perl 5 syntax g: Global replacement. Replace all occurrences found i: Case Insensitive. Do not consider case in the match m: Multiline. Treat the string as multiple lines of input, using ^ and $ as the start or end of any line, respectively, rather than start or end of string. s: Singleline. Treat the string as a single line of input, using. to match any character, including a newline, which normally, it would not match. | No |
| `:match` | `String` | The regular expression pattern to match in the file(s) | Yes, unless nested <regexp> is used |
| `:preservelastmodified` | `boolean` | Keep the file timestamp(s) even if the file(s) is(are) modified. since Ant 1.8.0. | No; defaults to false |
| `:replace` | `String` | The substitution pattern to place in the file(s) in place of the regular expression. | Yes, unless nested <substitution> is used |

**Nested elements**

- `:fileset` (`FileSet`)
- `:regexp` (`RegularExpression`)
- `:substitution` (`Substitution`)

**Reference**

https://ant.apache.org/manual/Tasks/replaceregexp.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ReplaceRegExp`
sourceraw docstring

replacestringclj

(replacestring & args)

Ant nested replacestring. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean
:fromString
:toString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$ReplaceString

Ant nested replacestring. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |
| `:from` | `String` |  |  |
| `:to` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$ReplaceString`
sourceraw docstring

replacetokenclj

(replacetoken & args)

Ant nested replacetoken. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:expandpropertiesboolean

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Replace$NestedString

Ant nested replacetoken. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:expandproperties` | `boolean` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Replace$NestedString`
sourceraw docstring

replacetokensclj

(replacetokens & args)

Ant nested replacetokens. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:begintokenString
:endtokenString
:propertiesresourceResource

Nested elements

  • :token (Token)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.ReplaceTokens

Ant nested replacetokens. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:begintoken` | `String` |  |  |
| `:endtoken` | `String` |  |  |
| `:propertiesresource` | `Resource` |  |  |

**Nested elements**

- `:token` (`Token`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.ReplaceTokens`
sourceraw docstring

replacevalueclj

(replacevalue & args)

Ant nested replacevalue. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:expandpropertiesboolean

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Replace$NestedString

Ant nested replacevalue. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:expandproperties` | `boolean` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Replace$NestedString`
sourceraw docstring

replytoclj

(replyto & args)

Ant nested replyto. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:addressString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.EmailAddress

Ant nested replyto. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:address` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailAddress`
sourceraw docstring

resourceclj

(resource & args)

A file-like entity can be abstracted to the concept of a resource. In addition to providing access to file-like attributes, a resource implementation should, when possible, provide the means to read content from and/or write content to the underlying entity. Although the resource concept was introduced in Apache Ant 1.5.2, resources are available for explicit use since Ant 1.7.

Attributes

AttributeTypeDescriptionRequired
:directorybooleanWhether this resource is directory-likeNo; default false
:existsbooleanWhether this resource existsNo; default true
:lastmodifiedlongThe last modification time of this resourceNo
:nameStringThe name of this resourceNo
:refidReferenceMakes this resource a reference to a resource defined elsewhere. If specified no other attributes or nested elements are allowed.No
:sizelongThe size of this resourceNo

Reference

https://ant.apache.org/manual/Types/resources.html#resource

Defined by

org.apache.tools.ant.types.Resource

A file-like entity can be abstracted to the concept of a resource. In addition to
providing access to file-like attributes, a resource implementation should, when
possible, provide the means to read content from and/or write content to the underlying
entity. Although the resource concept was introduced in Apache Ant 1.5.2, resources are
available for explicit use since Ant 1.7.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:directory` | `boolean` | Whether this resource is directory-like | No; default false |
| `:exists` | `boolean` | Whether this resource exists | No; default true |
| `:lastmodified` | `long` | The last modification time of this resource | No |
| `:name` | `String` | The name of this resource | No |
| `:refid` | `Reference` | Makes this resource a reference to a resource defined elsewhere. If specified no other attributes or nested elements are allowed. | No |
| `:size` | `long` | The size of this resource | No |

**Reference**

https://ant.apache.org/manual/Types/resources.html#resource

**Defined by**

`org.apache.tools.ant.types.Resource`
sourceraw docstring

resourcecountclj

(resourcecount & args)

Display or set a property containing the size of a nested resource collection. Can also be used as a condition.

Attributes

AttributeTypeDescriptionRequired
:countintComparison count.Ignored
:propertyStringThe property to set.No; by default, output value to the log
:refidReferenceA reference to a resource collection.Yes, unless a nested resource collection is supplied
:whenComparisonComparison type: equal, eq, greater, gt, less, lt, ge (greater or equal), ne (not equal), le (less or equal).No; default is equal

Reference

https://ant.apache.org/manual/Tasks/resourcecount.html

Defined by

org.apache.tools.ant.taskdefs.ResourceCount

Display or set a property containing the size of a nested resource collection. Can also
be used as a condition.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:count` | `int` | Comparison count. | Ignored |
| `:property` | `String` | The property to set. | No; by default, output value to the log |
| `:refid` | `Reference` | A reference to a resource collection. | Yes, unless a nested resource collection is supplied |
| `:when` | `Comparison` | Comparison type: equal, eq, greater, gt, less, lt, ge (greater or equal), ne (not equal), le (less or equal). | No; default is equal |

**Reference**

https://ant.apache.org/manual/Tasks/resourcecount.html

**Defined by**

`org.apache.tools.ant.taskdefs.ResourceCount`
sourceraw docstring

resourcelistclj

(resourcelist & args)

Ant type resourcelist. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile
:encodingString
:preserveduplicatesboolean
:refidReference

Nested elements

  • :filterchain (FilterChain)

Reference

https://ant.apache.org/manual/Types/resourcelist.html

Defined by

org.apache.tools.ant.types.resources.ResourceList

Ant type resourcelist. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |
| `:encoding` | `String` |  |  |
| `:preserveduplicates` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:filterchain` (`FilterChain`)

**Reference**

https://ant.apache.org/manual/Types/resourcelist.html

**Defined by**

`org.apache.tools.ant.types.resources.ResourceList`
sourceraw docstring

resourceorderclj

(resourceorder & args)

Ant nested resourceorder. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:listfileFile
:patternString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry

Ant nested resourceorder. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:listfile` | `File` |  |  |
| `:pattern` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.modules.Link$PatternListEntry`
sourceraw docstring

resourcesclj

(resources & args)

A file-like entity can be abstracted to the concept of a resource. In addition to providing access to file-like attributes, a resource implementation should, when possible, provide the means to read content from and/or write content to the underlying entity. Although the resource concept was introduced in Apache Ant 1.5.2, resources are available for explicit use since Ant 1.7.

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReferenceMakes this resource a reference to a resource defined elsewhere. If specified no other attributes or nested elements are allowed.No

Reference

https://ant.apache.org/manual/Types/resources.html

Defined by

org.apache.tools.ant.types.resources.Resources

A file-like entity can be abstracted to the concept of a resource. In addition to
providing access to file-like attributes, a resource implementation should, when
possible, provide the means to read content from and/or write content to the underlying
entity. Although the resource concept was introduced in Apache Ant 1.5.2, resources are
available for explicit use since Ant 1.7.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` | Makes this resource a reference to a resource defined elsewhere. If specified no other attributes or nested elements are allowed. | No |

**Reference**

https://ant.apache.org/manual/Types/resources.html

**Defined by**

`org.apache.tools.ant.types.resources.Resources`
sourceraw docstring

restrictclj

(restrict & args)

Ant type restrict. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

https://ant.apache.org/manual/Types/restrict.html

Defined by

org.apache.tools.ant.types.resources.Restrict

Ant type restrict. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/restrict.html

**Defined by**

`org.apache.tools.ant.types.resources.Restrict`
sourceraw docstring

retryclj

(retry & args)

Retry is a container which executes a single nested task until either: there is no failure; or: its retrycount has been exceeded. If this happens a BuildException is thrown.

Attributes

AttributeTypeDescriptionRequired
:retrycountintnumber of times to attempt to execute the nested taskYes
:retrydelayintnumber of milliseconds to wait between retry attempts task. Since Apache Ant 1.8.3No; defaults to no delay

Reference

https://ant.apache.org/manual/Tasks/retry.html

Defined by

org.apache.tools.ant.taskdefs.Retry

Retry is a container which executes a single nested task until either: there is no
failure; or: its retrycount has been exceeded. If this happens a BuildException is
thrown.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:retrycount` | `int` | number of times to attempt to execute the nested task | Yes |
| `:retrydelay` | `int` | number of milliseconds to wait between retry attempts task. Since Apache Ant 1.8.3 | No; defaults to no delay |

**Reference**

https://ant.apache.org/manual/Tasks/retry.html

**Defined by**

`org.apache.tools.ant.taskdefs.Retry`
sourceraw docstring

revokeclj

(revoke & args)

Ant nested revoke. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:actionsString
:classString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Permissions$Permission

Ant nested revoke. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:actions` | `String` |  |  |
| `:class` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Permissions$Permission`
sourceraw docstring

rmicclj

(rmic & args)

Runs the rmic compiler for a certain class. Note rmic has been deprecated as of Java 13 and removed as of Java 15. Trying to use it with Java15 will fail unless you specify the executable or rmic-adapter explicitly. Rmic can be run on a single class (as specified with the classname attribute) or a number of classes at once (all classes below base that are neither _Stub nor _Skel classes). If you want to rmic a single class and this class is a class nested into another class, you have to specify the classname in the form Outer$$Inner instead of Outer.Inner. It is possible to refine the set of files that are being rmiced. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes base) as well as the nested <include>, <exclude> and <patternset> elements. It is possible to use different compilers. This can be selected with the build.rmic property, the compiler attribute, or a nested element. Here are the choices: default-the default compiler (kaffe, sun or forking) for the platform. sun-the standard compiler prior to JDK 9 kaffe-the standard compiler of Kaffe weblogic forking-(since Apache Ant 1.7) the sun compiler forked into a separate process. Since Ant 1.9.8, this is the default when running on JDK 9+. xnew-(since Ant 1.7) the sun compiler forked into a separate process, with the -Xnew option. This is the most reliable way to use -Xnew. JDK 9 has removed support for -Xnew and since Ant 1.9.8 this option will be rejected when running on JDK 9+. (empty string). This has the same behaviour as not setting the compiler attribute. First the value of build.rmic is used if defined, and if not, the default for the platform is chosen. If build.rmic is set to this, you get the default. The miniRMI project contains a compiler implementation for this task as well, please consult miniRMI's documentation to learn how to use it. CORBA support Java 11 removes the Java EE and CORBA packages and rmic no longer supports either -iiop or -idl options. Starting with Ant 1.10.3, the rmic task will fail when using either while running Java 11+ unless you fork the task and explicitly specify an executable.

Attributes

AttributeTypeDescriptionRequired
:baseFilethe location to store the compiled files. Also serves as the parent directory for any non-Fileset includes, etc. (This functionality has remained unchanged.)See note
:casesensitiveboolean
:classnameStringthe class for which to run rmic.No
:classpathPathThe classpath to use during compilationNo
:classpathrefReferenceThe classpath to use during compilation, given as reference to a path defined elsewhereNo
:compilerStringThe compiler implementation to use. (See the above list of valid compilers.)No; defaults to the value of the build.rmic property, if set, and the default compiler for the current JDK otherwise
:debugbooleangenerate debug info (passes -g to rmic)No; defaults to false
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destdirFilethe location to store the compiled files.See note
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:executableStringComplete path to the rmic executable to use in case of the forking or xnew compiler. Since Ant 1.8.0.No; defaults to the rmic compiler of JDK that is currently running Ant
:extdirsPathlocation of installed extensionsNo
:filteringbooleanindicates whether token filtering should take placeNo
:followsymlinksboolean
:idlbooleanindicates that IDL output files should be generated. See the note on CORBA support above.No
:idloptsStringadditional arguments for IDL file generationNo
:iiopbooleanindicates that portable (RMI/IIOP) stubs should be generated. See the note on CORBA support above.No
:iiopoptsStringadditional arguments for IIOP class generationNo
:includeantruntimebooleanwhether to include the Ant run-time librariesNo; defaults to yes
:includejavaruntimebooleanwhether to include the default run-time libraries from the executing JVMNo; defaults to no
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:listfilesbooleanIndicates whether the source files to be compiled will be listed. Since Ant 1.8.0.No; defaults to no
:sourcebaseFilePass the -keepgenerated flag to rmic and move the generated source file to the given sourcebase directory.No
:stubversionStringSpecify the JDK version for the generated stub code. Specify 1.1 to pass the -v1.1 option to rmic, 1.2 for -v1.2, compat for -vcompat. Since Ant 1.7, if you do not specify a version, and do not ask for .iiop or .idl files, compat is selected.No; default is compat
:verifybooleancheck that classes implement Remote before handing them to rmicNo; default is false

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :compilerarg (ImplementationSpecificArgument)
  • :compilerclasspath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :extdirs (Path)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/rmic.html

Defined by

org.apache.tools.ant.taskdefs.Rmic

Runs the rmic compiler for a certain class. Note rmic has been deprecated as of Java 13
and removed as of Java 15. Trying to use it with Java15 will fail unless you specify the
executable or rmic-adapter explicitly. Rmic can be run on a single class (as specified
with the classname attribute) or a number of classes at once (all classes below base
that are neither _Stub nor _Skel classes). If you want to rmic a single class and this
class is a class nested into another class, you have to specify the classname in the
form Outer$$Inner instead of Outer.Inner. It is possible to refine the set of files that
are being rmiced. This can be done with the includes, includesfile, excludes,
excludesfile and defaultexcludes attributes. With the includes or includesfile attribute
you specify the files you want to have included by using patterns. The exclude or
excludesfile attribute is used to specify the files you want to have excluded. This is
also done with patterns. And finally with the defaultexcludes attribute, you can specify
whether you want to use default exclusions or not. See the section on directory based
tasks, on how the inclusion/exclusion of files works, and how to write patterns. This
task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes
base) as well as the nested <include>, <exclude> and <patternset> elements. It is
possible to use different compilers. This can be selected with the build.rmic property,
the compiler attribute, or a nested element. Here are the choices: default-the default
compiler (kaffe, sun or forking) for the platform. sun-the standard compiler prior to
JDK 9 kaffe-the standard compiler of Kaffe weblogic forking-(since Apache Ant 1.7) the
sun compiler forked into a separate process. Since Ant 1.9.8, this is the default when
running on JDK 9+. xnew-(since Ant 1.7) the sun compiler forked into a separate process,
with the -Xnew option. This is the most reliable way to use -Xnew. JDK 9 has removed
support for -Xnew and since Ant 1.9.8 this option will be rejected when running on JDK
9+. (empty string). This has the same behaviour as not setting the compiler attribute.
First the value of build.rmic is used if defined, and if not, the default for the
platform is chosen. If build.rmic is set to this, you get the default. The miniRMI
project contains a compiler implementation for this task as well, please consult
miniRMI's documentation to learn how to use it. CORBA support Java 11 removes the Java
EE and CORBA packages and rmic no longer supports either -iiop or -idl options. Starting
with Ant 1.10.3, the rmic task will fail when using either while running Java 11+ unless
you fork the task and explicitly specify an executable.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:base` | `File` | the location to store the compiled files. Also serves as the parent directory for any non-Fileset includes, etc. (This functionality has remained unchanged.) | See note |
| `:casesensitive` | `boolean` |  |  |
| `:classname` | `String` | the class for which to run rmic. | No |
| `:classpath` | `Path` | The classpath to use during compilation | No |
| `:classpathref` | `Reference` | The classpath to use during compilation, given as reference to a path defined elsewhere | No |
| `:compiler` | `String` | The compiler implementation to use. (See the above list of valid compilers.) | No; defaults to the value of the build.rmic property, if set, and the default compiler for the current JDK otherwise |
| `:debug` | `boolean` | generate debug info (passes -g to rmic) | No; defaults to false |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | the location to store the compiled files. | See note |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:executable` | `String` | Complete path to the rmic executable to use in case of the forking or xnew compiler. Since Ant 1.8.0. | No; defaults to the rmic compiler of JDK that is currently running Ant |
| `:extdirs` | `Path` | location of installed extensions | No |
| `:filtering` | `boolean` | indicates whether token filtering should take place | No |
| `:followsymlinks` | `boolean` |  |  |
| `:idl` | `boolean` | indicates that IDL output files should be generated. See the note on CORBA support above. | No |
| `:idlopts` | `String` | additional arguments for IDL file generation | No |
| `:iiop` | `boolean` | indicates that portable (RMI/IIOP) stubs should be generated. See the note on CORBA support above. | No |
| `:iiopopts` | `String` | additional arguments for IIOP class generation | No |
| `:includeantruntime` | `boolean` | whether to include the Ant run-time libraries | No; defaults to yes |
| `:includejavaruntime` | `boolean` | whether to include the default run-time libraries from the executing JVM | No; defaults to no |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:listfiles` | `boolean` | Indicates whether the source files to be compiled will be listed. Since Ant 1.8.0. | No; defaults to no |
| `:sourcebase` | `File` | Pass the -keepgenerated flag to rmic and move the generated source file to the given sourcebase directory. | No |
| `:stubversion` | `String` | Specify the JDK version for the generated stub code. Specify 1.1 to pass the -v1.1 option to rmic, 1.2 for -v1.2, compat for -vcompat. Since Ant 1.7, if you do not specify a version, and do not ask for .iiop or .idl files, compat is selected. | No; default is compat |
| `:verify` | `boolean` | check that classes implement Remote before handing them to rmic | No; default is false |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:compilerarg` (`ImplementationSpecificArgument`)
- `:compilerclasspath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:extdirs` (`Path`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/rmic.html

**Defined by**

`org.apache.tools.ant.taskdefs.Rmic`
sourceraw docstring

rootclj

(root & args)

Ant nested root. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classnameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.optional.depend.ClassfileSet$ClassRoot

Ant nested root. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.optional.depend.ClassfileSet$ClassRoot`
sourceraw docstring

rootfilesetclj

(rootfileset & args)

Ant nested rootfileset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested rootfileset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

rpmclj

(rpm & args)

A basic task for invoking the rpm executable to build a RedHat Package Manager Linux installation file. The task currently only works on Linux or other Unix platforms with rpm support.

Attributes

AttributeTypeDescriptionRequired
:cleanbuilddirbooleanThis will remove the generated files in the BUILD directory. See the the --clean option of rpmbuild.No
:commandStringThe command to pass to the rpmbuild program.No; default is -bb
:errorFile
:failonerrorbooleanStop the build process if the RPM build command exits with a non-zero return code.No; defaults to false
:outputFile
:quietbooleanSuppress output.No; defaults to false
:removesourcebooleanFlag to remove the sources after the build. See the --rmsource option of rpmbuild.No; default is false
:removespecbooleanThis will remove the spec file from SPECS. See the the --rmspec option of rpmbuild.No
:rpmbuildcommandStringThe executable to use for building the RPM. Set this if default executables are not on PATH or a different executable is needed. Since Apache Ant 1.6.No; defaults to rpmbuild if it can be found or rpm otherwise
:specfileStringThe name of the spec file to be used. This must be relative to the SPECS directory under the root of the RPM set in the topDir attribute.Yes
:topdirFileThis is the directory which will have the expected subdirectories, SPECS, SOURCES, BUILD, SRPMS. If this isn't specified, the default RPM directory of the system (or user, if ~/.rpmmacros defines it) is used (often /usr/src/rpm. Defining a topdir will set %_topdir to the specified directory-there is no need to edit your .rpmmacros file.No, but your build file is very brittle if it is not set.

Reference

https://ant.apache.org/manual/Tasks/rpm.html

Defined by

org.apache.tools.ant.taskdefs.optional.Rpm

A basic task for invoking the rpm executable to build a RedHat Package Manager Linux
installation file. The task currently only works on Linux or other Unix platforms with
rpm support.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cleanbuilddir` | `boolean` | This will remove the generated files in the BUILD directory. See the the --clean option of rpmbuild. | No |
| `:command` | `String` | The command to pass to the rpmbuild program. | No; default is -bb |
| `:error` | `File` |  |  |
| `:failonerror` | `boolean` | Stop the build process if the RPM build command exits with a non-zero return code. | No; defaults to false |
| `:output` | `File` |  |  |
| `:quiet` | `boolean` | Suppress output. | No; defaults to false |
| `:removesource` | `boolean` | Flag to remove the sources after the build. See the --rmsource option of rpmbuild. | No; default is false |
| `:removespec` | `boolean` | This will remove the spec file from SPECS. See the the --rmspec option of rpmbuild. | No |
| `:rpmbuildcommand` | `String` | The executable to use for building the RPM. Set this if default executables are not on PATH or a different executable is needed. Since Apache Ant 1.6. | No; defaults to rpmbuild if it can be found or rpm otherwise |
| `:specfile` | `String` | The name of the spec file to be used. This must be relative to the SPECS directory under the root of the RPM set in the topDir attribute. | Yes |
| `:topdir` | `File` | This is the directory which will have the expected subdirectories, SPECS, SOURCES, BUILD, SRPMS. If this isn't specified, the default RPM directory of the system (or user, if ~/.rpmmacros defines it) is used (often /usr/src/rpm. Defining a topdir will set %_topdir to the specified directory-there is no need to edit your .rpmmacros file. | No, but your build file is very brittle if it is not set. |

**Reference**

https://ant.apache.org/manual/Tasks/rpm.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Rpm`
sourceraw docstring

schemaclj

(schema & args)

Ant nested schema. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:namespaceString
:urlString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.SchemaValidate$SchemaLocation

Ant nested schema. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:namespace` | `String` |  |  |
| `:url` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.SchemaValidate$SchemaLocation`
sourceraw docstring

schemavalidateclj

(schemavalidate & args)

This schemavalidate task validates XML files described by an XML Schema. The task extends the XmlValidate task with XSD-specific features. The parser is created validating and namespace aware. Validation is turned on. Schema validation is turned on. Any no-namespace schema URL or file supplied is used as the no-namespace schema. All nested schema declarations are turned into the list of namespace-url bindings for schema lookup. Note that nested catalogs are still used for lookup of the URLs given as the sources of schema documents, so you can still delegate lookup to a catalog, you just need to list all schema URIs and their URL equivalents. This task supports the use of nested <xmlcatalog> elements <schema> elements, that bind a namespace URI to a URL or a local filename. <dtd> elements which are used to resolve DTDs and entities. <attribute> elements which are used to set features on the parser. These can be any number of http://xml.org/sax/features/ or other features that your parser may support. <property> elements, containing string properties The task only supports SAX2 or later parsers: it is an error to specify a SAX1 parser.

Attributes

AttributeTypeDescriptionRequired
:classnameStringthe parser to use.No
:classpathPath
:classpathrefReferencewhere to find the parser class. Optionally can use an embedded <classpath> element.No
:disabledtdbooleanFlag to disable DTD support. DTD support is needed to validate XSD files themselves, amongst others.No; default false
:failonerrorbooleanfails on a error if set to true.No; defaults to true
:fileFilethe file(s) you want to check (optionally use an embedded fileset).No
:fullcheckingbooleanenable full schema checking. Slow but strict.No; default true
:lenientbooleanif true, only check the XML document is well formedNo
:nonamespacefileFilefilename of a no-namespace XSD file to provide the schema for no-namespace XML contentNo
:nonamespaceurlStringURL of a no-namespace XSD file to provide the schema for no-namespace XML contentNo
:warnbooleanlog parser warn eventsNo

Nested elements

  • :attribute (Attribute)
  • :classpath (Path)
  • :dtd (DTDLocation)
  • :fileset (FileSet)
  • :property (Property)
  • :schema (SchemaLocation)
  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Tasks/schemavalidate.html

Defined by

org.apache.tools.ant.taskdefs.optional.SchemaValidate

This schemavalidate task validates XML files described by an XML Schema. The task
extends the XmlValidate task with XSD-specific features. The parser is created
validating and namespace aware. Validation is turned on. Schema validation is turned on.
Any no-namespace schema URL or file supplied is used as the no-namespace schema. All
nested schema declarations are turned into the list of namespace-url bindings for schema
lookup. Note that nested catalogs are still used for lookup of the URLs given as the
sources of schema documents, so you can still delegate lookup to a catalog, you just
need to list all schema URIs and their URL equivalents. This task supports the use of
nested <xmlcatalog> elements <schema> elements, that bind a namespace URI to a URL or a
local filename. <dtd> elements which are used to resolve DTDs and entities. <attribute>
elements which are used to set features on the parser. These can be any number of
http://xml.org/sax/features/ or other features that your parser may support. <property>
elements, containing string properties The task only supports SAX2 or later parsers: it
is an error to specify a SAX1 parser.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` | the parser to use. | No |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` | where to find the parser class. Optionally can use an embedded <classpath> element. | No |
| `:disabledtd` | `boolean` | Flag to disable DTD support. DTD support is needed to validate XSD files themselves, amongst others. | No; default false |
| `:failonerror` | `boolean` | fails on a error if set to true. | No; defaults to true |
| `:file` | `File` | the file(s) you want to check (optionally use an embedded fileset). | No |
| `:fullchecking` | `boolean` | enable full schema checking. Slow but strict. | No; default true |
| `:lenient` | `boolean` | if true, only check the XML document is well formed | No |
| `:nonamespacefile` | `File` | filename of a no-namespace XSD file to provide the schema for no-namespace XML content | No |
| `:nonamespaceurl` | `String` | URL of a no-namespace XSD file to provide the schema for no-namespace XML content | No |
| `:warn` | `boolean` | log parser warn events | No |

**Nested elements**

- `:attribute` (`Attribute`)
- `:classpath` (`Path`)
- `:dtd` (`DTDLocation`)
- `:fileset` (`FileSet`)
- `:property` (`Property`)
- `:schema` (`SchemaLocation`)
- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Tasks/schemavalidate.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.SchemaValidate`
sourceraw docstring

scpclj

(scp & args)

Copies a file or FileSet to or from a (remote) machine running an SSH daemon. FileSet only works for copying files from the local machine to a remote machine. Note: This task depends on external libraries not included in the Ant distribution. See Library Dependencies for more information. This task has been tested with jsch-0.1.2 and later. See also the sshexec task

Attributes

AttributeTypeDescriptionRequired
:compressedbooleanWhether to enable compression during transfer. since Ant 1.9.8No; defaults to false
:dirmodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to uploaded dirs. Note the actual permissions of the remote dir will be governed by this setting and the UMASK on the remote server. since Ant 1.9.5.No; default is 755
:failonerrorbooleanWhether to halt the build if the transfer fails.No; defaults to true
:fileStringThe file to copy. This can be a local path or a remote path of the form user[:password]@host:/directory/path.:password can be omitted if you use key based authentication or specify the password attribute. The way remote path is recognized is whether it contains @ character or not. This will not work if your localPath contains @ character.Yes, unless a nested <fileset> element is used
:filemodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to uploaded files. Note the actual permissions of the remote file will be governed by this setting and the UMASK on the remote server. since Ant 1.9.5.No; default is 644
:hostString
:keyfileStringLocation of the file holding the private key.Yes, if you are using key based authentication
:knownhostsStringThis sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No; defaults to ${user.home}/.ssh/known_hosts
:localfileStringThis is an alternative to the file attribute. But this must always point to a local file. The reason this was added was that when you give file attribute it is treated as remote if it contains @ character. This character can exist also in local paths. since Ant 1.6.2Alternative to file attribute
:localtodirStringThis is an alternative to the todir attribute. But this must always point to a local directory. The reason this was added was that when you give todir attribute it is treated as remote if it contains @ character. This character can exist also in local paths. since Ant 1.6.2Alternative to todir attribute
:localtofileStringChanges the file name to the given name while receiving it, only useful if receiving a single file. since Ant 1.6.2Alternative to todir attribute
:passphraseStringPassphrase for your private key.No; defaults to an empty string
:passwordStringThe password.Yes, unless you are using key based authentication or the password has been given in the file or todir attribute
:portintThe port to connect to on the remote host.No; defaults to 22
:preservelastmodifiedbooleanDetermines whether the last modification timestamp of downloaded files is preserved. It only works when transferring from a remote to a local system and probably doesn't work with a server that doesn't support SSH2. since Ant 1.8.0No; defaults to false
:remotefileStringThis is an alternative to the file attribute. But this must always point to a remote file. since Ant 1.6.2Alternative to file attribute
:remotetodirStringThis is an alternative to the todir attribute. But this must always point to a remote directory. since Ant 1.6.2Alternative to todir attribute
:remotetofileStringChanges the file name to the given name while sending it, only useful if sending a single file. since Ant 1.6.2Alternative to todir attribute
:serveralivecountmaxintThe number of server alive messages which may be sent without receiving any messages back from the server. Only used if serverAliveIntervalSeconds is not 0. since Ant 1.9.7No; defaults to 3
:serveraliveintervalsecondsintSets a timeout interval in seconds after which if no data has been received from the server, the task will send a message through the encrypted channel to request a response from the server. since Ant 1.9.7No, the default is 0, indicating that these messages will not be sent to the server
:sftpbooleanDetermines whether SCP uses the sftp protocol. The sftp protocol is the file transfer protocol of SSH2. It is recommended that this be set to true if you are copying to/from a server that doesn't support scp1. since Ant 1.7No; defaults to false
:sshconfigStringLocation of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8No
:todirStringThe directory to copy to. This can be a local path or a remote path of the form user[:password]@host:/directory/path.:password can be omitted if you use key based authentication or specify the password attribute. The way remote path is recognized is whether it contains @ character or not. This will not work if your localPath contains @ character.Yes
:trustbooleanThis trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists.No; defaults to no
:usernameString
:verbosebooleanDetermines whether SCP outputs verbosely to the user. Currently this means outputting dots/stars showing the progress of a file transfer. since Ant 1.6.2No; defaults to false

Nested elements

  • :additionalconfig (Variable)
  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/scp.html

Defined by

org.apache.tools.ant.taskdefs.optional.ssh.Scp

Copies a file or FileSet to or from a (remote) machine running an SSH daemon. FileSet
only works for copying files from the local machine to a remote machine. Note: This task
depends on external libraries not included in the Ant distribution. See Library
Dependencies for more information. This task has been tested with jsch-0.1.2 and later.
See also the sshexec task

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:compressed` | `boolean` | Whether to enable compression during transfer. since Ant 1.9.8 | No; defaults to false |
| `:dirmode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to uploaded dirs. Note the actual permissions of the remote dir will be governed by this setting and the UMASK on the remote server. since Ant 1.9.5. | No; default is 755 |
| `:failonerror` | `boolean` | Whether to halt the build if the transfer fails. | No; defaults to true |
| `:file` | `String` | The file to copy. This can be a local path or a remote path of the form user[:password]@host:/directory/path.:password can be omitted if you use key based authentication or specify the password attribute. The way remote path is recognized is whether it contains @ character or not. This will not work if your localPath contains @ character. | Yes, unless a nested <fileset> element is used |
| `:filemode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to uploaded files. Note the actual permissions of the remote file will be governed by this setting and the UMASK on the remote server. since Ant 1.9.5. | No; default is 644 |
| `:host` | `String` |  |  |
| `:keyfile` | `String` | Location of the file holding the private key. | Yes, if you are using key based authentication |
| `:knownhosts` | `String` | This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported. | No; defaults to ${user.home}/.ssh/known_hosts |
| `:localfile` | `String` | This is an alternative to the file attribute. But this must always point to a local file. The reason this was added was that when you give file attribute it is treated as remote if it contains @ character. This character can exist also in local paths. since Ant 1.6.2 | Alternative to file attribute |
| `:localtodir` | `String` | This is an alternative to the todir attribute. But this must always point to a local directory. The reason this was added was that when you give todir attribute it is treated as remote if it contains @ character. This character can exist also in local paths. since Ant 1.6.2 | Alternative to todir attribute |
| `:localtofile` | `String` | Changes the file name to the given name while receiving it, only useful if receiving a single file. since Ant 1.6.2 | Alternative to todir attribute |
| `:passphrase` | `String` | Passphrase for your private key. | No; defaults to an empty string |
| `:password` | `String` | The password. | Yes, unless you are using key based authentication or the password has been given in the file or todir attribute |
| `:port` | `int` | The port to connect to on the remote host. | No; defaults to 22 |
| `:preservelastmodified` | `boolean` | Determines whether the last modification timestamp of downloaded files is preserved. It only works when transferring from a remote to a local system and probably doesn't work with a server that doesn't support SSH2. since Ant 1.8.0 | No; defaults to false |
| `:remotefile` | `String` | This is an alternative to the file attribute. But this must always point to a remote file. since Ant 1.6.2 | Alternative to file attribute |
| `:remotetodir` | `String` | This is an alternative to the todir attribute. But this must always point to a remote directory. since Ant 1.6.2 | Alternative to todir attribute |
| `:remotetofile` | `String` | Changes the file name to the given name while sending it, only useful if sending a single file. since Ant 1.6.2 | Alternative to todir attribute |
| `:serveralivecountmax` | `int` | The number of server alive messages which may be sent without receiving any messages back from the server. Only used if serverAliveIntervalSeconds is not 0. since Ant 1.9.7 | No; defaults to 3 |
| `:serveraliveintervalseconds` | `int` | Sets a timeout interval in seconds after which if no data has been received from the server, the task will send a message through the encrypted channel to request a response from the server. since Ant 1.9.7 | No, the default is 0, indicating that these messages will not be sent to the server |
| `:sftp` | `boolean` | Determines whether SCP uses the sftp protocol. The sftp protocol is the file transfer protocol of SSH2. It is recommended that this be set to true if you are copying to/from a server that doesn't support scp1. since Ant 1.7 | No; defaults to false |
| `:sshconfig` | `String` | Location of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8 | No |
| `:todir` | `String` | The directory to copy to. This can be a local path or a remote path of the form user[:password]@host:/directory/path.:password can be omitted if you use key based authentication or specify the password attribute. The way remote path is recognized is whether it contains @ character or not. This will not work if your localPath contains @ character. | Yes |
| `:trust` | `boolean` | This trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists. | No; defaults to no |
| `:username` | `String` |  |  |
| `:verbose` | `boolean` | Determines whether SCP outputs verbosely to the user. Currently this means outputting dots/stars showing the progress of a file transfer. since Ant 1.6.2 | No; defaults to false |

**Nested elements**

- `:additionalconfig` (`Variable`)
- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/scp.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ssh.Scp`
sourceraw docstring

scriptclj

(script & args)

Execute a script in a Apache BSF or JSR 223 supported language. Note: This task depends on external libraries not included in the Apache Ant distribution. See Library Dependencies for more information. The task may use the BSF scripting manager or the JSR 223 manager that is included in the JDK. This is controlled by the manager attribute. The JSR 223 scripting manager is indicated by javax. All items (tasks, targets, etc) of the running project are accessible from the script, using either their name or id attributes (as long as their names are considered valid Java identifiers, that is). This is controlled by the setbeans attribute of the task. The name project is a pre-defined reference to the Project, which can be used instead of the project name. The name self is a pre-defined reference to the actual <script>-Task instance. From these objects you have access to the Ant Java API, see the JavaDoc (especially for Project and Script) for more information. If you are using JavaScript under BSF, a good resource is https://www.mozilla.org/rhino/doc.html as we are using their JavaScript interpreter. Scripts can do almost anything a task written in Java could do. Rhino provides a special construct-the JavaAdapter. With that you can create an object which implements several interfaces, extends classes and for which you can overwrite methods. Because this is an undocumented feature (yet), here is the link to an explanation: Google Groups: "Rhino, enum.js, JavaAdapter?" by Norris Boyd in the newsgroup netscape.public.mozilla.jseng. If you are creating Targets programmatically, make sure you set the Location to a useful value. In particular all targets should have different location values.

Attributes

AttributeTypeDescriptionRequired
:classpathPathThe classpath to pass into the script. Since Ant 1.7No
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere. Since Ant 1.7No
:encodingStringThe encoding of the script as a file. Since Ant 1.10.2.No; defaults to default JVM character encoding
:languageStringThe programming language the script is written in. Must be a supported Apache BSF or JSR 223 languageYes
:managerScriptManager {auto\|bsf\|javax}Since Ant 1.7. The script engine manager to use. This can have one of three values: auto, bsf or javax. bsf use the BSF scripting manager to run the language. javax use the javax.scripting manager to run the language. auto use the BSF engine if it exists, otherwise use the javax.scripting manager.No; default is auto
:setbeansbooleanThis attribute controls whether to set variables for all properties, references and targets in the running script. If this attribute is false, only the project and self variables are set. If this attribute is true all the variables are set. Since Ant 1.7No; defaults to true
:srcStringThe location of the script as a file, if not inlineNo

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/script.html

Defined by

org.apache.tools.ant.taskdefs.optional.Script

Execute a script in a Apache BSF or JSR 223 supported language. Note: This task depends
on external libraries not included in the Apache Ant distribution. See Library
Dependencies for more information. The task may use the BSF scripting manager or the JSR
223 manager that is included in the JDK. This is controlled by the manager attribute.
The JSR 223 scripting manager is indicated by javax. All items (tasks, targets, etc) of
the running project are accessible from the script, using either their name or id
attributes (as long as their names are considered valid Java identifiers, that is). This
is controlled by the setbeans attribute of the task. The name project is a pre-defined
reference to the Project, which can be used instead of the project name. The name self
is a pre-defined reference to the actual <script>-Task instance. From these objects you
have access to the Ant Java API, see the JavaDoc (especially for Project and Script) for
more information. If you are using JavaScript under BSF, a good resource is
https://www.mozilla.org/rhino/doc.html as we are using their JavaScript interpreter.
Scripts can do almost anything a task written in Java could do. Rhino provides a special
construct-the JavaAdapter. With that you can create an object which implements several
interfaces, extends classes and for which you can overwrite methods. Because this is an
undocumented feature (yet), here is the link to an explanation: Google Groups: "Rhino,
enum.js, JavaAdapter?" by Norris Boyd in the newsgroup netscape.public.mozilla.jseng. If
you are creating Targets programmatically, make sure you set the Location to a useful
value. In particular all targets should have different location values.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` | The classpath to pass into the script. Since Ant 1.7 | No |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. Since Ant 1.7 | No |
| `:encoding` | `String` | The encoding of the script as a file. Since Ant 1.10.2. | No; defaults to default JVM character encoding |
| `:language` | `String` | The programming language the script is written in. Must be a supported Apache BSF or JSR 223 language | Yes |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` | Since Ant 1.7. The script engine manager to use. This can have one of three values: auto, bsf or javax. bsf use the BSF scripting manager to run the language. javax use the javax.scripting manager to run the language. auto use the BSF engine if it exists, otherwise use the javax.scripting manager. | No; default is auto |
| `:setbeans` | `boolean` | This attribute controls whether to set variables for all properties, references and targets in the running script. If this attribute is false, only the project and self variables are set. If this attribute is true all the variables are set. Since Ant 1.7 | No; defaults to true |
| `:src` | `String` | The location of the script as a file, if not inline | No |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/script.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.Script`
sourceraw docstring

scriptconditionclj

(scriptcondition & args)

Ant type scriptcondition. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:encodingString
:languageString
:managerScriptManager {auto\|bsf\|javax}
:setbeansboolean
:srcFile
:valueboolean

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/scriptcondition.html

Defined by

org.apache.tools.ant.types.optional.ScriptCondition

Ant type scriptcondition. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:encoding` | `String` |  |  |
| `:language` | `String` |  |  |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` |  |  |
| `:setbeans` | `boolean` |  |  |
| `:src` | `File` |  |  |
| `:value` | `boolean` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/scriptcondition.html

**Defined by**

`org.apache.tools.ant.types.optional.ScriptCondition`
sourceraw docstring

scriptdefclj

(scriptdef & args)

Scriptdef can be used to define an Apache Ant task using a scripting language. Ant scripting languages supported by Apache BSF or JSR 223 may be used to define the script. Scriptdef provides a mechanism to encapsulate control logic from a build within an Ant task minimizing the need for providing control style tasks in Ant itself. Complex logic can be made available while retaining the simple structure of an Ant build file. Scriptdef is also useful for prototyping new custom tasks. Certainly as the complexity of the script increases it would be better to migrate the task definition into a Java based custom task. Note: This task depends on external libraries not included in the Ant distribution. See Library Dependencies for more information. The attributes and nested elements supported by the task may be defined using <attribute> and <element> nested elements. These are available to the script that implements the task as two collection style script variables attributes and elements. The elements in the attributes collection may be accessed by the attribute name. The elements collection is accessed by the nested element name. This will return a list of all instances of the nested element. The instances in this list may be accessed by an integer index. Note: Ant will turn all attribute and element names into all lowercase names, so even if you use name=SomeAttribute, you'll have to use someattribute to retrieve the attribute's value from the attributes collection. The name self (since Ant 1.6.3) is a pre-defined reference to the scriptdef task instance. It can be used for logging, or for integration with the rest of Ant. The self.text attribute contains any nested text passed to the script If an attribute or element is not passed in, then attributes.get() or elements.get() will return null. It is up to the script to perform any checks and validation. self.fail(String message)can be used to raise a BuildException. The name project is a pre-defined reference to the Ant Project. For more information on writing scripts, please refer to the <script> task.

Attributes

AttributeTypeDescriptionRequired
:classpathPathThe classpath to pass into the script.No
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere. No
:compiledbooleanIf true, the script is compiled before the first evaluation for faster multiple executions, on the condition that the manager is javax and the target engine implements javax.script.Compilable. Note that the bsf manager may automatically compile the script. since Ant 1.10.2.No; defaults to false
:encodingStringThe encoding of the script as a file. since Ant 1.10.2.No; defaults to default JVM character encoding
:languageStringThe programming language the script is written in. Must be a supported Apache BSF or JSR 223 languageYes
:loaderrefReferencethe name of the loader that is used to load the script, constructed from the specified classpath. This allows multiple script definitions to reuse the same class loader.No
:managerScriptManager {auto\|bsf\|javax}The script engine manager to use. See the script task for using this attribute.No; default is auto
:nameStringthe name of the task to be created using the scriptYes
:reverseloaderboolean
:setbeansbooleanThis attribute controls whether to set variables for all properties, references and targets in the running script. If this attribute is false, only the project and self variables are set. If this attribute is true all the variables are set. Since Ant 1.10.13No; default false for backward compatibility
:srcFileThe location of the script as a file, if not inlineNo
:uriStringThe XML namespace uri that this definition should live in.No

Nested elements

  • :attribute (Attribute)
  • :classpath (Path)
  • :element (NestedElement)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/scriptdef.html

Defined by

org.apache.tools.ant.taskdefs.optional.script.ScriptDef

Scriptdef can be used to define an Apache Ant task using a scripting language. Ant
scripting languages supported by Apache BSF or JSR 223 may be used to define the script.
Scriptdef provides a mechanism to encapsulate control logic from a build within an Ant
task minimizing the need for providing control style tasks in Ant itself. Complex logic
can be made available while retaining the simple structure of an Ant build file.
Scriptdef is also useful for prototyping new custom tasks. Certainly as the complexity
of the script increases it would be better to migrate the task definition into a Java
based custom task. Note: This task depends on external libraries not included in the Ant
distribution. See Library Dependencies for more information. The attributes and nested
elements supported by the task may be defined using <attribute> and <element> nested
elements. These are available to the script that implements the task as two collection
style script variables attributes and elements. The elements in the attributes
collection may be accessed by the attribute name. The elements collection is accessed by
the nested element name. This will return a list of all instances of the nested element.
The instances in this list may be accessed by an integer index. Note: Ant will turn all
attribute and element names into all lowercase names, so even if you use
name=SomeAttribute, you'll have to use someattribute to retrieve the attribute's value
from the attributes collection. The name self (since Ant 1.6.3) is a pre-defined
reference to the scriptdef task instance. It can be used for logging, or for integration
with the rest of Ant. The self.text attribute contains any nested text passed to the
script If an attribute or element is not passed in, then attributes.get() or
elements.get() will return null. It is up to the script to perform any checks and
validation. self.fail(String message)can be used to raise a BuildException. The name
project is a pre-defined reference to the Ant Project. For more information on writing
scripts, please refer to the <script> task.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` | The classpath to pass into the script. | No |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. No |  |
| `:compiled` | `boolean` | If true, the script is compiled before the first evaluation for faster multiple executions, on the condition that the manager is javax and the target engine implements javax.script.Compilable. Note that the bsf manager may automatically compile the script. since Ant 1.10.2. | No; defaults to false |
| `:encoding` | `String` | The encoding of the script as a file. since Ant 1.10.2. | No; defaults to default JVM character encoding |
| `:language` | `String` | The programming language the script is written in. Must be a supported Apache BSF or JSR 223 language | Yes |
| `:loaderref` | `Reference` | the name of the loader that is used to load the script, constructed from the specified classpath. This allows multiple script definitions to reuse the same class loader. | No |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` | The script engine manager to use. See the script task for using this attribute. | No; default is auto |
| `:name` | `String` | the name of the task to be created using the script | Yes |
| `:reverseloader` | `boolean` |  |  |
| `:setbeans` | `boolean` | This attribute controls whether to set variables for all properties, references and targets in the running script. If this attribute is false, only the project and self variables are set. If this attribute is true all the variables are set. Since Ant 1.10.13 | No; default false for backward compatibility |
| `:src` | `File` | The location of the script as a file, if not inline | No |
| `:uri` | `String` | The XML namespace uri that this definition should live in. | No |

**Nested elements**

- `:attribute` (`Attribute`)
- `:classpath` (`Path`)
- `:element` (`NestedElement`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/scriptdef.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.script.ScriptDef`
sourceraw docstring

scriptfilterclj

(scriptfilter & args)

Ant type scriptfilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean
:classpathPath
:classpathrefReference
:encodingString
:languageString
:managerScriptManager {auto\|bsf\|javax}
:setbeansboolean
:srcFile
:tokenString

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/scriptfilter.html

Defined by

org.apache.tools.ant.types.optional.ScriptFilter

Ant type scriptfilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:encoding` | `String` |  |  |
| `:language` | `String` |  |  |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` |  |  |
| `:setbeans` | `boolean` |  |  |
| `:src` | `File` |  |  |
| `:token` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/scriptfilter.html

**Defined by**

`org.apache.tools.ant.types.optional.ScriptFilter`
sourceraw docstring

scriptmapperclj

(scriptmapper & args)

Ant type scriptmapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:encodingString
:fromString
:languageString
:managerScriptManager {auto\|bsf\|javax}
:setbeansboolean
:srcFile
:toString

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/scriptmapper.html

Defined by

org.apache.tools.ant.types.optional.ScriptMapper

Ant type scriptmapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:encoding` | `String` |  |  |
| `:from` | `String` |  |  |
| `:language` | `String` |  |  |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` |  |  |
| `:setbeans` | `boolean` |  |  |
| `:src` | `File` |  |  |
| `:to` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/scriptmapper.html

**Defined by**

`org.apache.tools.ant.types.optional.ScriptMapper`
sourceraw docstring

scriptselectorclj

(scriptselector & args)

Ant type scriptselector. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:classpathrefReference
:encodingString
:errorString
:languageString
:managerScriptManager {auto\|bsf\|javax}
:refidReference
:selectedboolean
:setbeansboolean
:srcFile

Nested elements

  • :classpath (Path)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/scriptselector.html

Defined by

org.apache.tools.ant.types.optional.ScriptSelector

Ant type scriptselector. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:encoding` | `String` |  |  |
| `:error` | `String` |  |  |
| `:language` | `String` |  |  |
| `:manager` | `ScriptManager {auto\|bsf\|javax}` |  |  |
| `:refid` | `Reference` |  |  |
| `:selected` | `boolean` |  |  |
| `:setbeans` | `boolean` |  |  |
| `:src` | `File` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/scriptselector.html

**Defined by**

`org.apache.tools.ant.types.optional.ScriptSelector`
sourceraw docstring

sectionclj

(section & args)

Ant nested section. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Nested elements

  • :attribute (Attribute)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Manifest$Section

Ant nested section. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Nested elements**

- `:attribute` (`Attribute`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Manifest$Section`
sourceraw docstring

selectorclj

(selector & args)

Ant type selector. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:ifObject
:refidReference
:unlessObject

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/selector.html

Defined by

org.apache.tools.ant.types.selectors.SelectSelector

Ant type selector. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:if` | `Object` |  |  |
| `:refid` | `Reference` |  |  |
| `:unless` | `Object` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/selector.html

**Defined by**

`org.apache.tools.ant.types.selectors.SelectSelector`
sourceraw docstring

sequentialclj

(sequential & args)

Sequential is a container task-it can contain other Apache Ant tasks. The nested tasks are simply executed in sequence. Sequential's primary use is to support the sequential execution of a subset of tasks within the parallel task The sequential task has no attributes and does not support any nested elements apart from Ant tasks. Any valid Ant task may be embedded within the sequential task.

Reference

https://ant.apache.org/manual/Tasks/sequential.html

Defined by

org.apache.tools.ant.taskdefs.Sequential

Sequential is a container task-it can contain other Apache Ant tasks. The nested tasks
are simply executed in sequence. Sequential's primary use is to support the sequential
execution of a subset of tasks within the parallel task The sequential task has no
attributes and does not support any nested elements apart from Ant tasks. Any valid Ant
task may be embedded within the sequential task.

**Reference**

https://ant.apache.org/manual/Tasks/sequential.html

**Defined by**

`org.apache.tools.ant.taskdefs.Sequential`
sourceraw docstring

serverdeployclj

(serverdeploy & args)

The serverdeploy task is used to run a "hot" deployment tool for vendor-specific J2EE server. The task requires nested elements which define the attributes of the vendor-specific deployment tool being executed. Vendor-specific deployment tools elements may enforce rules for which attributes are required, depending on the tool.

Attributes

AttributeTypeDescriptionRequired
:actionStringThis is the action to be performed. For most cases this will be deploy. Some tools support additional actions, such as delete, list, undeploy, update, ...Yes
:sourceFileA fully qualified path/filename of the component to be deployed. This may be an .ear, .jar, .war, or any other type that is supported by the server.Tool dependent

Nested elements

  • :generic (GenericHotDeploymentTool)
  • :jonas (JonasHotDeploymentTool)
  • :weblogic (WebLogicHotDeploymentTool)

Reference

https://ant.apache.org/manual/Tasks/serverdeploy.html

Defined by

org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy

The serverdeploy task is used to run a "hot" deployment tool for vendor-specific J2EE
server. The task requires nested elements which define the attributes of the
vendor-specific deployment tool being executed. Vendor-specific deployment tools
elements may enforce rules for which attributes are required, depending on the tool.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:action` | `String` | This is the action to be performed. For most cases this will be deploy. Some tools support additional actions, such as delete, list, undeploy, update, ... | Yes |
| `:source` | `File` | A fully qualified path/filename of the component to be deployed. This may be an .ear, .jar, .war, or any other type that is supported by the server. | Tool dependent |

**Nested elements**

- `:generic` (`GenericHotDeploymentTool`)
- `:jonas` (`JonasHotDeploymentTool`)
- `:weblogic` (`WebLogicHotDeploymentTool`)

**Reference**

https://ant.apache.org/manual/Tasks/serverdeploy.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy`
sourceraw docstring

serviceclj

(service & args)

Ant nested service. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:providerString
:typeString

Nested elements

  • :provider (Provider)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.spi.Service

Ant nested service. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:provider` | `String` |  |  |
| `:type` | `String` |  |  |

**Nested elements**

- `:provider` (`Provider`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.spi.Service`
sourceraw docstring

setpermissionsclj

(setpermissions & args)

Changes the file permissions using Java's NIO support for permissions. This task provides a subset of the platform specific abilities of chmod and attrib in a platform independent way. If no permissions are specified either via the mode or the permissions attribute, then all permissions will be removed from the nested resources. The task accepts arbitrary resources as part of the nested resource collections, but not all resources support setting permissions. This task won't do anything for resources that don't support setting permissions-for example URLs. The permissions are applied to all resources contained within the nested resources collections. You may want to ensure the collection only returns files or directories if you want different sets of permissions to apply to either type of resource.

Attributes

AttributeTypeDescriptionRequired
:actonlinktargetsbooleanWhether to set the permissions of the targets of symbolic links or Windows junctions instead of the links themselves. since Ant 1.10.16.No; defaults to true
:failonerrorbooleanWhether to stop the build if setting permissions fails.No; defaults to true
:modeStringThe permissions to set as traditional Unix three-digit octal number.No
:nonposixmodeNonPosixMode {fail\|pass\|tryDosOrFail\|tryDosOrPass}What to do if changing the permissions of a file is not possible because the file-system doesn't support POSIX file permissions. Possible options are fail (fail the build), pass (just log an error), tryDosOrFail (at least try to set the read-only flag on DOS file systems, fail if that isn't possible either) and tryDosOrPass (at least try to set the read-only flag on DOS file systems, just log an error if that isn't possible either).No; defaults to fail
:permissionsStringThe permissions to set as comma separated list of names of PosixFilePermission values.No

Reference

https://ant.apache.org/manual/Tasks/setpermissions.html

Defined by

org.apache.tools.ant.taskdefs.SetPermissions

Changes the file permissions using Java's NIO support for permissions. This task
provides a subset of the platform specific abilities of chmod and attrib in a platform
independent way. If no permissions are specified either via the mode or the permissions
attribute, then all permissions will be removed from the nested resources. The task
accepts arbitrary resources as part of the nested resource collections, but not all
resources support setting permissions. This task won't do anything for resources that
don't support setting permissions-for example URLs. The permissions are applied to all
resources contained within the nested resources collections. You may want to ensure the
collection only returns files or directories if you want different sets of permissions
to apply to either type of resource.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:actonlinktargets` | `boolean` | Whether to set the permissions of the targets of symbolic links or Windows junctions instead of the links themselves. since Ant 1.10.16. | No; defaults to true |
| `:failonerror` | `boolean` | Whether to stop the build if setting permissions fails. | No; defaults to true |
| `:mode` | `String` | The permissions to set as traditional Unix three-digit octal number. | No |
| `:nonposixmode` | `NonPosixMode {fail\|pass\|tryDosOrFail\|tryDosOrPass}` | What to do if changing the permissions of a file is not possible because the file-system doesn't support POSIX file permissions. Possible options are fail (fail the build), pass (just log an error), tryDosOrFail (at least try to set the read-only flag on DOS file systems, fail if that isn't possible either) and tryDosOrPass (at least try to set the read-only flag on DOS file systems, just log an error if that isn't possible either). | No; defaults to fail |
| `:permissions` | `String` | The permissions to set as comma separated list of names of PosixFilePermission values. | No |

**Reference**

https://ant.apache.org/manual/Tasks/setpermissions.html

**Defined by**

`org.apache.tools.ant.taskdefs.SetPermissions`
sourceraw docstring

setproxyclj

(setproxy & args)

Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote FTP sites. You can nominate an HTTP and FTP proxy, or a SOCKS server, reset the server settings, or do nothing at all.

Attributes

AttributeTypeDescriptionRequired
:nonproxyhostsStringA list of hosts to bypass the proxy on. These should be separated with the vertical bar character |. Only in Java 1.4 does FTP use this list. e.g. fozbot.corp.sun.com|*.eng.sun.comString
:proxyhostStringthe HTTP/FTP proxy host. Set this to for the HTTP proxy option to be disabled.String
:proxypasswordStringSet the password for the proxy. Used only if the proxyUser is set.String
:proxyportintthe HTTP/FTP proxy port numberint
:proxyuserStringset the proxy user. Probably requires a password to accompany this setting.String
:socksproxyhostStringThe name of a SOCKS server. Set to to turn SOCKS proxying off.String
:socksproxyportintSet the ProxyPort for SOCKS connections.int

Reference

https://ant.apache.org/manual/Tasks/setproxy.html

Defined by

org.apache.tools.ant.taskdefs.optional.net.SetProxy

Sets Java's web proxy properties, so that tasks and code run in the same JVM can have
through-the-firewall access to remote web sites, and remote FTP sites. You can nominate
an HTTP and FTP proxy, or a SOCKS server, reset the server settings, or do nothing at
all.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:nonproxyhosts` | `String` | A list of hosts to bypass the proxy on. These should be separated with the vertical bar character \|. Only in Java 1.4 does FTP use this list. e.g. fozbot.corp.sun.com\|*.eng.sun.com | String |
| `:proxyhost` | `String` | the HTTP/FTP proxy host. Set this to for the HTTP proxy option to be disabled. | String |
| `:proxypassword` | `String` | Set the password for the proxy. Used only if the proxyUser is set. | String |
| `:proxyport` | `int` | the HTTP/FTP proxy port number | int |
| `:proxyuser` | `String` | set the proxy user. Probably requires a password to accompany this setting. | String |
| `:socksproxyhost` | `String` | The name of a SOCKS server. Set to to turn SOCKS proxying off. | String |
| `:socksproxyport` | `int` | Set the ProxyPort for SOCKS connections. | int |

**Reference**

https://ant.apache.org/manual/Tasks/setproxy.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.net.SetProxy`
sourceraw docstring

signedselectorclj

(signedselector & args)

Ant type signedselector. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:refidReference

Reference

https://ant.apache.org/manual/Types/signedselector.html

Defined by

org.apache.tools.ant.types.selectors.SignedSelector

Ant type signedselector. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/signedselector.html

**Defined by**

`org.apache.tools.ant.types.selectors.SignedSelector`
sourceraw docstring

signjarclj

(signjar & args)

Signing a jar allows users to authenticate the publisher. Signs JAR files with the jarsigner command line tool. It will take a named file in the jar attribute, and an optional destDir or signedJar attribute. Nested paths are also supported; here only an (optional) destDir is allowed. If a destination directory or explicit JAR file name is not provided, JARs are signed in place. Dependency rules Nonexistent destination JARs are created/signed Out of date destination JARs are created/signed If a destination file and a source file are the same, and lazy is true, the JAR is only signed if it does not contain a signature by this alias. If a destination file and a source file are the same, and lazy is false, the JAR is signed.

Attributes

AttributeTypeDescriptionRequired
:aliasStringthe alias to sign underYes
:destdirFile
:digestalgStringname of digest algorithmNo
:executableStringSpecify a particular jarsigner executable to use in place of the default binary (found in the same JDK as Apache Ant is running in). Must support the same command line options as the Sun JDK jarsigner command. since Ant 1.8.0.No
:forcebooleanWhether to force signing of the jar file even if it doesn't seem to be out of date or already signed. since Ant 1.8.0.No; default false
:internalsfboolean(true|false) include the .SF file inside the signature blockNo; default false
:jarFilethe jar file to signYes, unless nested paths have been used
:keypassStringpassword for private key (if different)No
:keystoreStringkeystore locationNo
:lazybooleanflag to control whether the presence of a signature file means a JAR is signed. This is only used when the target JAR matches the source JARNo; default false
:maxmemoryStringSpecifies the maximum memory the jarsigner JVM will use. Specified in the style of standard Java memory specs (e.g. 128m = 128 MBytes)No
:preservelastmodifiedbooleanGive the signed files the same last modified time as the original jar files.No; default false.
:providerargStringRepresents an optional string input argument for the constructor of provider_class_name. Ignored if providerclass is not set. since Ant 1.10.6.No
:providerclassStringname of a cryptographic service provider's master class file when the service provider is not listed in the security properties file. since Ant 1.10.6.No
:providernameStringname of a cryptographic service provider's name when listed in the security properties file. since Ant 1.10.6.No
:sectionsonlyboolean(true|false) don't compute hash of entire manifestNo; default false
:sigalgStringname of signature algorithmNo
:sigfileStringname of .SF/.DSA fileNo
:signedjarFilename of signed JAR file. This can only be set when the jar attribute is set.No
:storepassStringpassword for keystore integrity. Ant will not use the -storepass command line argument but send the password to jarsigner when it prompts for it.Yes
:storetypeStringkeystore typeNo
:strictboolean(true|false) strict checking when signing. since Ant 1.9.1.No; default false
:tsacertStringalias in the keystore for a timestamp authority for timestamped JAR files in Java 5+No
:tsadigestalgStringname of TSA digest algorithm. since Ant 1.10.2No
:tsaproxyhostStringproxy host to be used when connecting to TSA serverNo
:tsaproxyportStringproxy port to be used when connecting to TSA serverNo
:tsaurlStringURL for a timestamp authority for timestamped JAR files in Java 5+No
:verboseboolean(true|false) verbose output when signingNo; default false

Nested elements

  • :arg (Argument)
  • :fileset (FileSet)
  • :path (Path)
  • :sysproperty (Variable)

Reference

https://ant.apache.org/manual/Tasks/signjar.html

Defined by

org.apache.tools.ant.taskdefs.SignJar

Signing a jar allows users to authenticate the publisher. Signs JAR files with the
jarsigner command line tool. It will take a named file in the jar attribute, and an
optional destDir or signedJar attribute. Nested paths are also supported; here only an
(optional) destDir is allowed. If a destination directory or explicit JAR file name is
not provided, JARs are signed in place. Dependency rules Nonexistent destination JARs
are created/signed Out of date destination JARs are created/signed If a destination file
and a source file are the same, and lazy is true, the JAR is only signed if it does not
contain a signature by this alias. If a destination file and a source file are the same,
and lazy is false, the JAR is signed.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:alias` | `String` | the alias to sign under | Yes |
| `:destdir` | `File` |  |  |
| `:digestalg` | `String` | name of digest algorithm | No |
| `:executable` | `String` | Specify a particular jarsigner executable to use in place of the default binary (found in the same JDK as Apache Ant is running in). Must support the same command line options as the Sun JDK jarsigner command. since Ant 1.8.0. | No |
| `:force` | `boolean` | Whether to force signing of the jar file even if it doesn't seem to be out of date or already signed. since Ant 1.8.0. | No; default false |
| `:internalsf` | `boolean` | (true\|false) include the .SF file inside the signature block | No; default false |
| `:jar` | `File` | the jar file to sign | Yes, unless nested paths have been used |
| `:keypass` | `String` | password for private key (if different) | No |
| `:keystore` | `String` | keystore location | No |
| `:lazy` | `boolean` | flag to control whether the presence of a signature file means a JAR is signed. This is only used when the target JAR matches the source JAR | No; default false |
| `:maxmemory` | `String` | Specifies the maximum memory the jarsigner JVM will use. Specified in the style of standard Java memory specs (e.g. 128m = 128 MBytes) | No |
| `:preservelastmodified` | `boolean` | Give the signed files the same last modified time as the original jar files. | No; default false. |
| `:providerarg` | `String` | Represents an optional string input argument for the constructor of provider_class_name. Ignored if providerclass is not set. since Ant 1.10.6. | No |
| `:providerclass` | `String` | name of a cryptographic service provider's master class file when the service provider is not listed in the security properties file. since Ant 1.10.6. | No |
| `:providername` | `String` | name of a cryptographic service provider's name when listed in the security properties file. since Ant 1.10.6. | No |
| `:sectionsonly` | `boolean` | (true\|false) don't compute hash of entire manifest | No; default false |
| `:sigalg` | `String` | name of signature algorithm | No |
| `:sigfile` | `String` | name of .SF/.DSA file | No |
| `:signedjar` | `File` | name of signed JAR file. This can only be set when the jar attribute is set. | No |
| `:storepass` | `String` | password for keystore integrity. Ant will not use the -storepass command line argument but send the password to jarsigner when it prompts for it. | Yes |
| `:storetype` | `String` | keystore type | No |
| `:strict` | `boolean` | (true\|false) strict checking when signing. since Ant 1.9.1. | No; default false |
| `:tsacert` | `String` | alias in the keystore for a timestamp authority for timestamped JAR files in Java 5+ | No |
| `:tsadigestalg` | `String` | name of TSA digest algorithm. since Ant 1.10.2 | No |
| `:tsaproxyhost` | `String` | proxy host to be used when connecting to TSA server | No |
| `:tsaproxyport` | `String` | proxy port to be used when connecting to TSA server | No |
| `:tsaurl` | `String` | URL for a timestamp authority for timestamped JAR files in Java 5+ | No |
| `:verbose` | `boolean` | (true\|false) verbose output when signing | No; default false |

**Nested elements**

- `:arg` (`Argument`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:sysproperty` (`Variable`)

**Reference**

https://ant.apache.org/manual/Tasks/signjar.html

**Defined by**

`org.apache.tools.ant.taskdefs.SignJar`
sourceraw docstring

sizeclj

(size & args)

Ant nested size. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference
:unitsByteUnits
:valuelong
:whenSizeComparisons

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.SizeSelector

Ant nested size. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:units` | `ByteUnits` |  |  |
| `:value` | `long` |  |  |
| `:when` | `SizeComparisons` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.SizeSelector`
sourceraw docstring

sleepclj

(sleep & args)

A task for sleeping a short period of time, useful when a build or deployment process requires an interval between tasks.

Attributes

AttributeTypeDescriptionRequired
:failonerrorbooleanflag controlling whether to break the build on an errorNo
:hoursinthours to to add to the sleep timeNo
:millisecondsintmilliseconds to add to the sleep timeNo
:minutesintminutes to add to the sleep timeNo
:secondsintseconds to add to the sleep timeNo

Reference

https://ant.apache.org/manual/Tasks/sleep.html

Defined by

org.apache.tools.ant.taskdefs.Sleep

A task for sleeping a short period of time, useful when a build or deployment process
requires an interval between tasks.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:failonerror` | `boolean` | flag controlling whether to break the build on an error | No |
| `:hours` | `int` | hours to to add to the sleep time | No |
| `:milliseconds` | `int` | milliseconds to add to the sleep time | No |
| `:minutes` | `int` | minutes to add to the sleep time | No |
| `:seconds` | `int` | seconds to add to the sleep time | No |

**Reference**

https://ant.apache.org/manual/Tasks/sleep.html

**Defined by**

`org.apache.tools.ant.taskdefs.Sleep`
sourceraw docstring

socketclj

(socket & args)

Ant nested socket. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:portint
:serverString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.condition.Socket

Ant nested socket. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:port` | `int` |  |  |
| `:server` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.condition.Socket`
sourceraw docstring

sortclj

(sort & args)

Ant type sort. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

https://ant.apache.org/manual/Types/sort.html

Defined by

org.apache.tools.ant.types.resources.Sort

Ant type sort. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/sort.html

**Defined by**

`org.apache.tools.ant.types.resources.Sort`
sourceraw docstring

soscheckinclj

(soscheckin & args)

Task to perform CheckIn commands with SOS

Attributes

AttributeTypeDescriptionRequired
:commentStringA comment to be applied to all files being checked inNo
:fileStringFilename to act uponNo; by default, act upon the project
:localpathPathOverride the working directory and get to the specified pathNo
:nocachebooleantrue|false-Only needed if SOSHOME is set as an environment variableNo
:nocompressbooleantrue|false-disable compressionNo
:passwordStringSourceSafe passwordNo
:projectpathStringSourceSafe project path-eg. $/SourceRoot/Project1Yes
:recursivebooleantrue|false-Only works with the CheckOutProject commandNo
:soscmdStringDirectory which contains soscmd(.exe)No; by default, the executable must be in the path
:soshomeStringThe path to the SourceOffSite home directoryNo
:sosserverpathStringaddress and port of the SOS server-eg. 192.168.0.1:8888Yes
:usernameStringSourceSafe usernameYes
:verbosebooleantrue|false-Status messages are displayedNo
:vssserverpathStringpath to the srcsafe.ini-eg. \server\vss\srcsafe.iniYes

Reference

https://ant.apache.org/manual/Tasks/sos.html#SOSCheckIn

Defined by

org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin

Task to perform CheckIn commands with SOS

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:comment` | `String` | A comment to be applied to all files being checked in | No |
| `:file` | `String` | Filename to act upon | No; by default, act upon the project |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:nocache` | `boolean` | true\|false-Only needed if SOSHOME is set as an environment variable | No |
| `:nocompress` | `boolean` | true\|false-disable compression | No |
| `:password` | `String` | SourceSafe password | No |
| `:projectpath` | `String` | SourceSafe project path-eg. $/SourceRoot/Project1 | Yes |
| `:recursive` | `boolean` | true\|false-Only works with the CheckOutProject command | No |
| `:soscmd` | `String` | Directory which contains soscmd(.exe) | No; by default, the executable must be in the path |
| `:soshome` | `String` | The path to the SourceOffSite home directory | No |
| `:sosserverpath` | `String` | address and port of the SOS server-eg. 192.168.0.1:8888 | Yes |
| `:username` | `String` | SourceSafe username | Yes |
| `:verbose` | `boolean` | true\|false-Status messages are displayed | No |
| `:vssserverpath` | `String` | path to the srcsafe.ini-eg. \\server\vss\srcsafe.ini | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/sos.html#SOSCheckIn

**Defined by**

`org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin`
sourceraw docstring

soscheckoutclj

(soscheckout & args)

Task to perform CheckOut commands with SOS

Attributes

AttributeTypeDescriptionRequired
:fileStringFilename to act uponNo; by default, act upon the project
:localpathPathOverride the working directory and get to the specified pathNo
:nocachebooleantrue|false-Only needed if SOSHOME is set as an environment variableNo
:nocompressbooleantrue|false-disable compressionNo
:passwordStringSourceSafe passwordNo
:projectpathStringSourceSafe project path-eg. $/SourceRoot/Project1Yes
:recursivebooleantrue|false-Only works with the CheckOutProject commandNo
:soscmdStringDirectory which contains soscmd(.exe)No; by default, the executable must be in the path
:soshomeStringThe path to the SourceOffSite home directoryNo
:sosserverpathStringaddress and port of the SOS server-eg. 192.168.0.1:8888Yes
:usernameStringSourceSafe usernameYes
:verbosebooleantrue|false-Status messages are displayedNo
:vssserverpathStringpath to the srcsafe.ini-eg. \server\vss\srcsafe.iniYes

Reference

https://ant.apache.org/manual/Tasks/sos.html#SOSCheckOut

Defined by

org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout

Task to perform CheckOut commands with SOS

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `String` | Filename to act upon | No; by default, act upon the project |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:nocache` | `boolean` | true\|false-Only needed if SOSHOME is set as an environment variable | No |
| `:nocompress` | `boolean` | true\|false-disable compression | No |
| `:password` | `String` | SourceSafe password | No |
| `:projectpath` | `String` | SourceSafe project path-eg. $/SourceRoot/Project1 | Yes |
| `:recursive` | `boolean` | true\|false-Only works with the CheckOutProject command | No |
| `:soscmd` | `String` | Directory which contains soscmd(.exe) | No; by default, the executable must be in the path |
| `:soshome` | `String` | The path to the SourceOffSite home directory | No |
| `:sosserverpath` | `String` | address and port of the SOS server-eg. 192.168.0.1:8888 | Yes |
| `:username` | `String` | SourceSafe username | Yes |
| `:verbose` | `boolean` | true\|false-Status messages are displayed | No |
| `:vssserverpath` | `String` | path to the srcsafe.ini-eg. \\server\vss\srcsafe.ini | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/sos.html#SOSCheckOut

**Defined by**

`org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout`
sourceraw docstring

sosgetclj

(sosget & args)

Task to perform Get commands with SOS

Attributes

AttributeTypeDescriptionRequired
:fileStringFilename to act uponNo; by default, act upon the project
:labelStringa label version to get-Only works with the GetProject commandNo
:localpathPathOverride the working directory and get to the specified pathNo
:nocachebooleantrue|false-Only needed if SOSHOME is set as an environment variableNo
:nocompressbooleantrue|false-disable compressionNo
:passwordStringSourceSafe passwordNo
:projectpathStringSourceSafe project path-eg. $/SourceRoot/Project1Yes
:recursivebooleantrue|false-Only works with the GetProject commandNo
:soscmdStringDirectory which contains soscmd(.exe)No; by default, the executable must be in the path
:soshomeStringThe path to the SourceOffSite home directoryNo
:sosserverpathStringaddress & port of the SOS server-eg. 192.168.0.1:8888Yes
:usernameStringSourceSafe usernameYes
:verbosebooleantrue|false-Status messages are displayedNo
:versionStringa version number to get-Only works with the GetFile commandNo
:vssserverpathStringpath to the srcsafe.ini-eg. \server\vss\srcsafe.iniYes

Reference

https://ant.apache.org/manual/Tasks/sos.html#SOSGet

Defined by

org.apache.tools.ant.taskdefs.optional.sos.SOSGet

Task to perform Get commands with SOS

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `String` | Filename to act upon | No; by default, act upon the project |
| `:label` | `String` | a label version to get-Only works with the GetProject command | No |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:nocache` | `boolean` | true\|false-Only needed if SOSHOME is set as an environment variable | No |
| `:nocompress` | `boolean` | true\|false-disable compression | No |
| `:password` | `String` | SourceSafe password | No |
| `:projectpath` | `String` | SourceSafe project path-eg. $/SourceRoot/Project1 | Yes |
| `:recursive` | `boolean` | true\|false-Only works with the GetProject command | No |
| `:soscmd` | `String` | Directory which contains soscmd(.exe) | No; by default, the executable must be in the path |
| `:soshome` | `String` | The path to the SourceOffSite home directory | No |
| `:sosserverpath` | `String` | address & port of the SOS server-eg. 192.168.0.1:8888 | Yes |
| `:username` | `String` | SourceSafe username | Yes |
| `:verbose` | `boolean` | true\|false-Status messages are displayed | No |
| `:version` | `String` | a version number to get-Only works with the GetFile command | No |
| `:vssserverpath` | `String` | path to the srcsafe.ini-eg. \\server\vss\srcsafe.ini | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/sos.html#SOSGet

**Defined by**

`org.apache.tools.ant.taskdefs.optional.sos.SOSGet`
sourceraw docstring

soslabelclj

(soslabel & args)

Task to perform Label commands with SOS

Attributes

AttributeTypeDescriptionRequired
:commentStringA comment to be applied to all files being labeledNo
:labelStringThe label to apply to a projectYes
:localpathPath
:nocacheboolean
:nocompressboolean
:passwordStringSourceSafe passwordNo
:projectpathStringSourceSafe project path-eg. $/SourceRoot/Project1Yes
:soscmdStringDirectory which contains soscmd(.exe)No; by default, the executable must be in the path
:soshomeString
:sosserverpathStringaddress and port of the SOS server-eg. 192.168.0.1:8888Yes
:usernameStringSourceSafe usernameYes
:verbosebooleantrue|false-Status messages are displayedNo
:versionString
:vssserverpathStringpath to the srcsafe.ini-eg. \server\vss\srcsafe.iniYes

Reference

https://ant.apache.org/manual/Tasks/sos.html#SOSLabel

Defined by

org.apache.tools.ant.taskdefs.optional.sos.SOSLabel

Task to perform Label commands with SOS

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:comment` | `String` | A comment to be applied to all files being labeled | No |
| `:label` | `String` | The label to apply to a project | Yes |
| `:localpath` | `Path` |  |  |
| `:nocache` | `boolean` |  |  |
| `:nocompress` | `boolean` |  |  |
| `:password` | `String` | SourceSafe password | No |
| `:projectpath` | `String` | SourceSafe project path-eg. $/SourceRoot/Project1 | Yes |
| `:soscmd` | `String` | Directory which contains soscmd(.exe) | No; by default, the executable must be in the path |
| `:soshome` | `String` |  |  |
| `:sosserverpath` | `String` | address and port of the SOS server-eg. 192.168.0.1:8888 | Yes |
| `:username` | `String` | SourceSafe username | Yes |
| `:verbose` | `boolean` | true\|false-Status messages are displayed | No |
| `:version` | `String` |  |  |
| `:vssserverpath` | `String` | path to the srcsafe.ini-eg. \\server\vss\srcsafe.ini | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/sos.html#SOSLabel

**Defined by**

`org.apache.tools.ant.taskdefs.optional.sos.SOSLabel`
sourceraw docstring

sourceclj

(source & args)

Ant nested source. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$SourceFile

Ant nested source. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$SourceFile`
sourceraw docstring

sourcefilesclj

(sourcefiles & args)

Ant nested sourcefiles. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$ResourceCollectionContainer

Ant nested sourcefiles. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$ResourceCollectionContainer`
sourceraw docstring

sourcepathclj

(sourcepath & args)

Ant nested sourcepath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested sourcepath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

sourcesclj

(sources & args)

Ant nested sources. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.resources.Union

Ant nested sources. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.resources.Union`
sourceraw docstring

sqlclj

(sql & args)

Executes a series of SQL statements via JDBC to a database. Statements can either be read in from a text file using the src attribute or from between the enclosing SQL tags. Multiple statements can be provided, separated by semicolons (or the defined delimiter). Individual lines within the statements can be commented using either --, // or REM at the start of the line. The autocommit attribute specifies whether auto-commit should be turned on or off whilst executing the statements. If auto-commit is turned on each statement will be executed and committed. If it is turned off the statements will all be executed as one transaction. The onerror attribute specifies how to proceed when an error occurs during the execution of one of the statements. The possible values are: continue execution, only show the error; stop execution, log the error but don't fail the task and abort execution and transaction and fail task. Proxies. Some JDBC drivers (including the Oracle thin driver), use the JVM's proxy settings to route their JDBC operations to the database. Since Apache Ant 1.7, Ant running on Java 5 or later defaults to using the proxy settings of the operating system. Accordingly, the OS proxy settings need to be valid, or Ant's proxy support disabled with -noproxy option.

Attributes

AttributeTypeDescriptionRequired
:appendbooleanwhether output should be appended to or overwrite an existing file.No; defaults to false, ignored if output does not specify a filesystem destination
:autocommitbooleanAuto commit flag for database connectionNo; defaults to false
:cachingbooleanShould the task cache loaders and the driver?No; defaults to true
:classpathPathClasspath used to load driverNo; defaults to system classpath
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere.No; defaults to system classpath
:csvcolumnseparatorStringThe column separator used when printing the results. Since Ant 1.8.0.No; defaults to,
:csvquotecharacterStringThe character used to quote column values. If set, columns that contain either the column separator or the quote character itself will be surrounded by the quote character. The quote character itself will be doubled if it appears inside of the column's value. Note: BLOB values will never be quoted. Since Ant 1.8.0.No; default is not set (i.e. no quoting ever occurs)
:delimiterStringString that separates SQL statementsNo; defaults to;;
:delimitertypeDelimiterTypeControl whether the delimiter will only be recognized on a line by itself. Can be normal-anywhere on the line, or row, meaning it must be on a line by itselfNo; defaults to normal
:driverStringClass name of the jdbc driverYes
:encodingStringThe encoding of the files containing SQL statementsNo; defaults to default JVM character encoding
:errorpropertyStringThe name of a property to set in the event of an error. Since Ant 1.8.0No
:escapeprocessingbooleanControl whether the Java statement object will perform escape substitution. See Statement's API docs for details. Since Ant 1.6. No; defaults to true
:expandpropertiesbooleanSet to true to turn on property expansion in nested SQL, inline in the task or nested transactions. Since Ant 1.7. No; defaults to true
:failonconnectionerrorbooleanIf false, will only print a warning message and not execute any statement if the task fails to connect to the database. Since Ant 1.8.0.No; defaults to true
:forcecsvquotecharbooleanIf true, quoting always occursNo; default is not set (i.e. quoting occurs only where needed)
:keepformatbooleanControl whether the format of SQL will be preserved. Useful when loading packages and procedures. No; defaults to false
:onerrorOnErrorAction to perform when statement fails: continue, stop, abortNo; defaults to abort
:outputResourceOutput file for result sets. Since Ant 1.8 can specify any Resource that supports output (see note).No; print to System.out by default
:outputencodingStringThe encoding of the files holding results. since Ant 1.9.4No; defaults to default JVM character encoding
:passwordStringDatabase passwordYes
:printbooleanPrint result sets from the statementsNo; defaults to false
:rawblobsbooleanIf true, will write raw streams rather than hex encoding when printing BLOB results. Since Ant 1.7.1.No; defaults to false
:rdbmsStringExecute task only if this rdbmsNo; unrestricted by default
:rowcountpropertyStringThe name of a property to set to the number of rows updated by the first statement/transaction that actually returned a row count. Since Ant 1.8.0No
:showheadersbooleanPrint headers for result sets from the statementsNo; defaults to true
:showtrailersbooleanPrint trailer for number of rows affectedNo; defaults to true
:showwarningsbooleanIf true, SQLWarnings will be logged at the warning level. Since Ant 1.8.0. Note: even if the attribute is set to false, warnings that apply to the connection will be logged at the verbose level.No; defaults to false
:srcFileFile containing SQL statementsYes, unless statements enclosed within tags
:strictdelimitermatchingbooleanIf false, delimiters will be searched for in a case-insensitive manner (i.e. delimiter=go matches GO) and surrounding whitespace will be ignored (delimiter=go matches GO). Since Ant 1.8.0.No; defaults to true
:treatwarningsaserrorsbooleanIf true, SQLWarnings will be treated like errors-and the logic selected via the onError attribute applies. Since Ant 1.8.0.No; defaults to false
:urlStringDatabase connection URLYes
:useridStringDatabase user nameYes
:versionStringExecute task only if rdbms version matchNo; unrestricted by default
:warningpropertyStringThe name of a property to set in the event of an warning. Since Ant 1.8.0No

Nested elements

  • :classpath (Path)
  • :connectionproperty (Property)
  • :fileset (FileSet)
  • :transaction (Transaction)

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Tasks/sql.html

Defined by

org.apache.tools.ant.taskdefs.SQLExec

Executes a series of SQL statements via JDBC to a database. Statements can either be
read in from a text file using the src attribute or from between the enclosing SQL tags.
Multiple statements can be provided, separated by semicolons (or the defined delimiter).
Individual lines within the statements can be commented using either --, // or REM at
the start of the line. The autocommit attribute specifies whether auto-commit should be
turned on or off whilst executing the statements. If auto-commit is turned on each
statement will be executed and committed. If it is turned off the statements will all be
executed as one transaction. The onerror attribute specifies how to proceed when an
error occurs during the execution of one of the statements. The possible values are:
continue execution, only show the error; stop execution, log the error but don't fail
the task and abort execution and transaction and fail task. Proxies. Some JDBC drivers
(including the Oracle thin driver), use the JVM's proxy settings to route their JDBC
operations to the database. Since Apache Ant 1.7, Ant running on Java 5 or later
defaults to using the proxy settings of the operating system. Accordingly, the OS proxy
settings need to be valid, or Ant's proxy support disabled with -noproxy option.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | whether output should be appended to or overwrite an existing file. | No; defaults to false, ignored if output does not specify a filesystem destination |
| `:autocommit` | `boolean` | Auto commit flag for database connection | No; defaults to false |
| `:caching` | `boolean` | Should the task cache loaders and the driver? | No; defaults to true |
| `:classpath` | `Path` | Classpath used to load driver | No; defaults to system classpath |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. | No; defaults to system classpath |
| `:csvcolumnseparator` | `String` | The column separator used when printing the results. Since Ant 1.8.0. | No; defaults to, |
| `:csvquotecharacter` | `String` | The character used to quote column values. If set, columns that contain either the column separator or the quote character itself will be surrounded by the quote character. The quote character itself will be doubled if it appears inside of the column's value. Note: BLOB values will never be quoted. Since Ant 1.8.0. | No; default is not set (i.e. no quoting ever occurs) |
| `:delimiter` | `String` | String that separates SQL statements | No; defaults to;; |
| `:delimitertype` | `DelimiterType` | Control whether the delimiter will only be recognized on a line by itself. Can be normal-anywhere on the line, or row, meaning it must be on a line by itself | No; defaults to normal |
| `:driver` | `String` | Class name of the jdbc driver | Yes |
| `:encoding` | `String` | The encoding of the files containing SQL statements | No; defaults to default JVM character encoding |
| `:errorproperty` | `String` | The name of a property to set in the event of an error. Since Ant 1.8.0 | No |
| `:escapeprocessing` | `boolean` | Control whether the Java statement object will perform escape substitution. See Statement's API docs for details. Since Ant 1.6. No; defaults to true |  |
| `:expandproperties` | `boolean` | Set to true to turn on property expansion in nested SQL, inline in the task or nested transactions. Since Ant 1.7. No; defaults to true |  |
| `:failonconnectionerror` | `boolean` | If false, will only print a warning message and not execute any statement if the task fails to connect to the database. Since Ant 1.8.0. | No; defaults to true |
| `:forcecsvquotechar` | `boolean` | If true, quoting always occurs | No; default is not set (i.e. quoting occurs only where needed) |
| `:keepformat` | `boolean` | Control whether the format of SQL will be preserved. Useful when loading packages and procedures. No; defaults to false |  |
| `:onerror` | `OnError` | Action to perform when statement fails: continue, stop, abort | No; defaults to abort |
| `:output` | `Resource` | Output file for result sets. Since Ant 1.8 can specify any Resource that supports output (see note). | No; print to System.out by default |
| `:outputencoding` | `String` | The encoding of the files holding results. since Ant 1.9.4 | No; defaults to default JVM character encoding |
| `:password` | `String` | Database password | Yes |
| `:print` | `boolean` | Print result sets from the statements | No; defaults to false |
| `:rawblobs` | `boolean` | If true, will write raw streams rather than hex encoding when printing BLOB results. Since Ant 1.7.1. | No; defaults to false |
| `:rdbms` | `String` | Execute task only if this rdbms | No; unrestricted by default |
| `:rowcountproperty` | `String` | The name of a property to set to the number of rows updated by the first statement/transaction that actually returned a row count. Since Ant 1.8.0 | No |
| `:showheaders` | `boolean` | Print headers for result sets from the statements | No; defaults to true |
| `:showtrailers` | `boolean` | Print trailer for number of rows affected | No; defaults to true |
| `:showwarnings` | `boolean` | If true, SQLWarnings will be logged at the warning level. Since Ant 1.8.0. Note: even if the attribute is set to false, warnings that apply to the connection will be logged at the verbose level. | No; defaults to false |
| `:src` | `File` | File containing SQL statements | Yes, unless statements enclosed within tags |
| `:strictdelimitermatching` | `boolean` | If false, delimiters will be searched for in a case-insensitive manner (i.e. delimiter=go matches GO) and surrounding whitespace will be ignored (delimiter=go matches GO). Since Ant 1.8.0. | No; defaults to true |
| `:treatwarningsaserrors` | `boolean` | If true, SQLWarnings will be treated like errors-and the logic selected via the onError attribute applies. Since Ant 1.8.0. | No; defaults to false |
| `:url` | `String` | Database connection URL | Yes |
| `:userid` | `String` | Database user name | Yes |
| `:version` | `String` | Execute task only if rdbms version match | No; unrestricted by default |
| `:warningproperty` | `String` | The name of a property to set in the event of an warning. Since Ant 1.8.0 | No |

**Nested elements**

- `:classpath` (`Path`)
- `:connectionproperty` (`Property`)
- `:fileset` (`FileSet`)
- `:transaction` (`Transaction`)

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Tasks/sql.html

**Defined by**

`org.apache.tools.ant.taskdefs.SQLExec`
sourceraw docstring

srcclj

(src & args)

Ant nested src. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested src. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

srcfileclj

(srcfile & args)

Ant nested srcfile. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:prefixString
:suffixString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Marker

Ant nested srcfile. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Marker`
sourceraw docstring

srcfilelistclj

(srcfilelist & args)

Ant nested srcfilelist. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:dirFile
:filesString
:refidReference

Nested elements

  • :file (FileName)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileList

Ant nested srcfilelist. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dir` | `File` |  |  |
| `:files` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:file` (`FileName`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileList`
sourceraw docstring

srcfilesclj

(srcfiles & args)

Ant nested srcfiles. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested srcfiles. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

srcfilesetclj

(srcfileset & args)

Ant nested srcfileset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested srcfileset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

srcresourcesclj

(srcresources & args)

Ant nested srcresources. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.resources.Union

Ant nested srcresources. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.resources.Union`
sourceraw docstring

sshexecclj

(sshexec & args)

Runs a command on a remote machine running SSH daemon. Note: This task depends on external libraries not included in the Ant distribution. See Library Dependencies for more information. This task has been tested with JSCh 0.1.29 and above and won't work with versions of JSCh earlier than 0.1.28. See also the scp task

Attributes

AttributeTypeDescriptionRequired
:appendbooleanWhether output file should be appended to or overwritten.No; defaults to false, meaning overwrite any existing file
:bindsensitiveStringContains string with key=values pairs are divided by sensitiveDelimiter. since Ant 1.10.16Yes if hideSensitive set to true
:commandStringThe command to run on the remote host.Exactly one of the two
:commandresourceStringThe resource (file) that contains the commands to run on the remote host. Since Ant 1.7.1Exactly one of the two
:errappendbooleanWhether errorOutput file should be appended to or overwritten. since Ant 1.9.4No; defaults to false, meaning overwrite any existing file
:erroroutputFileThe file to which the standard error of the command should be redirected. since Ant 1.9.4No
:errorpropertyStringThe name of a property in which the standard error of the command should be stored. since Ant 1.9.4No
:failonerrorbooleanWhether to halt the build if the command does not complete successfully.No; defaults to true
:hidesensitivebooleanAllows to hide sensitive data in logs without output supressing. It makes easier debugging with sensitive data hiding. since Ant 1.10.16No; defaults to false
:hostStringThe hostname or IP address of the remote host to which you wish to connect.Yes
:inputFileA file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring and inputproperty attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.0No
:inputpropertyStringName of a property content of which serves as the input stream for the executed command. This attribute is mutually exclusive with the input and inputstring attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.0No
:inputstringStringA string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input and inputproperty attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.3No
:keyfileStringLocation of the file holding the private key.Yes, if you are using key based authentication
:knownhostsStringThis sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No; defaults to ${user.home}/.ssh/known_hosts
:outputFileName of a file to which to write the output.No
:outputpropertyStringThe name of a property in which the output of the command should be stored. If you use the commandResource attribute, each command's output will be prefixed by the command itself.No
:passphraseStringPassphrase for your private key.No; defaults to an empty string
:passwordStringThe password.Yes, unless you are using key based authentication or the password has been given in the file or todir attribute.
:placeholderbracketsStringContains symbols to destinguish placeholder are needed to replace with sensitive data. since Ant 1.10.16No, defaults to:
:portintThe port to connect to on the remote host.No; defaults to 22
:resultpropertyStringthe name of a property in which the return code of the command should be stored. Only of interest if failonerror=false. since Ant 1.9.4No
:sensitivedelimiterStringSensitive data delimiter of key=values pairs. since Ant 1.10.16No, defaults to;
:serveralivecountmaxintThe number of server alive messages which may be sent without receiving any messages back from the server. Only used if serverAliveIntervalSeconds is not 0. since Ant 1.9.7No; defaults to 3
:serveraliveintervalsecondsintSets a timeout interval in seconds after which if no data has been received from the server, the task will send a message through the encrypted channel to request a response from the server. since Ant 1.9.7No, the default is 0, indicating that these messages will not be sent to the server
:sshconfigStringLocation of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8No
:suppresssystemerrbooleanWhether to suppress System.err. since Ant 1.9.4No; defaults to false
:suppresssystemoutbooleanWhether to suppress system out. since Ant 1.9.0No; defaults to false
:timeoutlongStop the command if it doesn't finish within the specified time (given in milliseconds unlike telnet, which expects a timeout in seconds).No; defaults to 0 which means never
:trustbooleanThis trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists.No; defaults to no
:useptybooleanWhether to allocate a pseudo-tty (like ssh -t). since Ant 1.8.3No; defaults to false
:usernameStringThe username on the remote host to which you are connecting.Yes
:usesysteminbooleanWhether to pass the current standard input to the remote process. since Ant 1.9.4No; defaults to false
:verbosebooleanDetermines whether sshexec outputs verbosely to the user. Similar output is generated as the ssh command line tool with the -v option. since Ant 1.8.0No; defaults to false

Nested elements

  • :additionalconfig (Variable)

Reference

https://ant.apache.org/manual/Tasks/sshexec.html

Defined by

org.apache.tools.ant.taskdefs.optional.ssh.SSHExec

Runs a command on a remote machine running SSH daemon. Note: This task depends on
external libraries not included in the Ant distribution. See Library Dependencies for
more information. This task has been tested with JSCh 0.1.29 and above and won't work
with versions of JSCh earlier than 0.1.28. See also the scp task

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:append` | `boolean` | Whether output file should be appended to or overwritten. | No; defaults to false, meaning overwrite any existing file |
| `:bindsensitive` | `String` | Contains string with key=values pairs are divided by sensitiveDelimiter. since Ant 1.10.16 | Yes if hideSensitive set to true |
| `:command` | `String` | The command to run on the remote host. | Exactly one of the two |
| `:commandresource` | `String` | The resource (file) that contains the commands to run on the remote host. Since Ant 1.7.1 | Exactly one of the two |
| `:errappend` | `boolean` | Whether errorOutput file should be appended to or overwritten. since Ant 1.9.4 | No; defaults to false, meaning overwrite any existing file |
| `:erroroutput` | `File` | The file to which the standard error of the command should be redirected. since Ant 1.9.4 | No |
| `:errorproperty` | `String` | The name of a property in which the standard error of the command should be stored. since Ant 1.9.4 | No |
| `:failonerror` | `boolean` | Whether to halt the build if the command does not complete successfully. | No; defaults to true |
| `:hidesensitive` | `boolean` | Allows to hide sensitive data in logs without output supressing. It makes easier debugging with sensitive data hiding. since Ant 1.10.16 | No; defaults to false |
| `:host` | `String` | The hostname or IP address of the remote host to which you wish to connect. | Yes |
| `:input` | `File` | A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring and inputproperty attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.0 | No |
| `:inputproperty` | `String` | Name of a property content of which serves as the input stream for the executed command. This attribute is mutually exclusive with the input and inputstring attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.0 | No |
| `:inputstring` | `String` | A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input and inputproperty attributes. When executing more than one command via commandResource, input will be read for each command. since Ant 1.8.3 | No |
| `:keyfile` | `String` | Location of the file holding the private key. | Yes, if you are using key based authentication |
| `:knownhosts` | `String` | This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported. | No; defaults to ${user.home}/.ssh/known_hosts |
| `:output` | `File` | Name of a file to which to write the output. | No |
| `:outputproperty` | `String` | The name of a property in which the output of the command should be stored. If you use the commandResource attribute, each command's output will be prefixed by the command itself. | No |
| `:passphrase` | `String` | Passphrase for your private key. | No; defaults to an empty string |
| `:password` | `String` | The password. | Yes, unless you are using key based authentication or the password has been given in the file or todir attribute. |
| `:placeholderbrackets` | `String` | Contains symbols to destinguish placeholder are needed to replace with sensitive data. since Ant 1.10.16 | No, defaults to: |
| `:port` | `int` | The port to connect to on the remote host. | No; defaults to 22 |
| `:resultproperty` | `String` | the name of a property in which the return code of the command should be stored. Only of interest if failonerror=false. since Ant 1.9.4 | No |
| `:sensitivedelimiter` | `String` | Sensitive data delimiter of key=values pairs. since Ant 1.10.16 | No, defaults to; |
| `:serveralivecountmax` | `int` | The number of server alive messages which may be sent without receiving any messages back from the server. Only used if serverAliveIntervalSeconds is not 0. since Ant 1.9.7 | No; defaults to 3 |
| `:serveraliveintervalseconds` | `int` | Sets a timeout interval in seconds after which if no data has been received from the server, the task will send a message through the encrypted channel to request a response from the server. since Ant 1.9.7 | No, the default is 0, indicating that these messages will not be sent to the server |
| `:sshconfig` | `String` | Location of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8 | No |
| `:suppresssystemerr` | `boolean` | Whether to suppress System.err. since Ant 1.9.4 | No; defaults to false |
| `:suppresssystemout` | `boolean` | Whether to suppress system out. since Ant 1.9.0 | No; defaults to false |
| `:timeout` | `long` | Stop the command if it doesn't finish within the specified time (given in milliseconds unlike telnet, which expects a timeout in seconds). | No; defaults to 0 which means never |
| `:trust` | `boolean` | This trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists. | No; defaults to no |
| `:usepty` | `boolean` | Whether to allocate a pseudo-tty (like ssh -t). since Ant 1.8.3 | No; defaults to false |
| `:username` | `String` | The username on the remote host to which you are connecting. | Yes |
| `:usesystemin` | `boolean` | Whether to pass the current standard input to the remote process. since Ant 1.9.4 | No; defaults to false |
| `:verbose` | `boolean` | Determines whether sshexec outputs verbosely to the user. Similar output is generated as the ssh command line tool with the -v option. since Ant 1.8.0 | No; defaults to false |

**Nested elements**

- `:additionalconfig` (`Variable`)

**Reference**

https://ant.apache.org/manual/Tasks/sshexec.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ssh.SSHExec`
sourceraw docstring

sshsessionclj

(sshsession & args)

A Task which establishes an SSH connection with a remote machine running SSH daemon, optionally establishes any number of local or remote tunnels over that connection, then executes any nested tasks before taking down the connection. Note: This task depends on external libraries not included in the Ant distribution. See Library Dependencies for more information. This task has been tested with JSCh 0.1.33 and above and won't work with versions of JSCh earlier than 0.1.28. See also the sshexec and scp tasks

Attributes

AttributeTypeDescriptionRequired
:failonerrorbooleanWhether to halt the build if the command does not complete successfully.No; defaults to true
:hostStringThe hostname or IP address of the remote host to which you wish to connect.Yes
:keyfileStringLocation of the file holding the private key.Yes, if you are using key based authentication
:knownhostsStringThis sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No; defaults to ${user.home}/.ssh/known_hosts
:localtunnelsStringA comma-delimited list of colon-delimited lport:rhost:rport triplets defining local port forwarding. If nested localtunnel elements are also provided, both sets of tunnels will be established.No
:passphraseStringPassphrase for your private key.No; defaults to an empty string
:passwordStringThe password.Yes, unless you are using key based authentication or the password has been given in the file or todir attribute
:portintThe port to connect to on the remote host.No; defaults to 22
:remotetunnelsStringA comma-delimited list of colon-delimited rport:lhost:lport triplets defining remote port forwarding. If nested remotetunnel elements are also provided, both sets of tunnels will be established.No
:serveralivecountmaxint
:serveraliveintervalsecondsint
:sshconfigStringLocation of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8No
:timeoutlongGive up if the connection cannot be established within the specified time (given in milliseconds).No; defaults to 0 which means never
:trustbooleanThis trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists.No; defaults to no
:usernameStringThe username on the remote host to which you are connecting.Yes
:verboseboolean

Nested elements

  • :additionalconfig (Variable)
  • :localtunnel (LocalTunnel)
  • :remotetunnel (RemoteTunnel)
  • :sequential (NestedSequential)
  • :task (Task)

Reference

https://ant.apache.org/manual/Tasks/sshsession.html

Defined by

org.apache.tools.ant.taskdefs.optional.ssh.SSHSession

A Task which establishes an SSH connection with a remote machine running SSH daemon,
optionally establishes any number of local or remote tunnels over that connection, then
executes any nested tasks before taking down the connection. Note: This task depends on
external libraries not included in the Ant distribution. See Library Dependencies for
more information. This task has been tested with JSCh 0.1.33 and above and won't work
with versions of JSCh earlier than 0.1.28. See also the sshexec and scp tasks

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:failonerror` | `boolean` | Whether to halt the build if the command does not complete successfully. | No; defaults to true |
| `:host` | `String` | The hostname or IP address of the remote host to which you wish to connect. | Yes |
| `:keyfile` | `String` | Location of the file holding the private key. | Yes, if you are using key based authentication |
| `:knownhosts` | `String` | This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported. | No; defaults to ${user.home}/.ssh/known_hosts |
| `:localtunnels` | `String` | A comma-delimited list of colon-delimited lport:rhost:rport triplets defining local port forwarding. If nested localtunnel elements are also provided, both sets of tunnels will be established. | No |
| `:passphrase` | `String` | Passphrase for your private key. | No; defaults to an empty string |
| `:password` | `String` | The password. | Yes, unless you are using key based authentication or the password has been given in the file or todir attribute |
| `:port` | `int` | The port to connect to on the remote host. | No; defaults to 22 |
| `:remotetunnels` | `String` | A comma-delimited list of colon-delimited rport:lhost:lport triplets defining remote port forwarding. If nested remotetunnel elements are also provided, both sets of tunnels will be established. | No |
| `:serveralivecountmax` | `int` |  |  |
| `:serveraliveintervalseconds` | `int` |  |  |
| `:sshconfig` | `String` | Location of the file holding the OpenSSH style configuration (e.g. ${user.home}/.ssh/config). The username and the key file are read from the configuration file, unless they are already specified in the task parameters. since Ant 1.10.8 | No |
| `:timeout` | `long` | Give up if the connection cannot be established within the specified time (given in milliseconds). | No; defaults to 0 which means never |
| `:trust` | `boolean` | This trusts all unknown hosts if set to yes or true. Note: If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists. | No; defaults to no |
| `:username` | `String` | The username on the remote host to which you are connecting. | Yes |
| `:verbose` | `boolean` |  |  |

**Nested elements**

- `:additionalconfig` (`Variable`)
- `:localtunnel` (`LocalTunnel`)
- `:remotetunnel` (`RemoteTunnel`)
- `:sequential` (`NestedSequential`)
- `:task` (`Task`)

**Reference**

https://ant.apache.org/manual/Tasks/sshsession.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ssh.SSHSession`
sourceraw docstring

stringclj

(string & args)

Ant type string. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:directoryboolean
:encodingString
:existsboolean
:lastmodifiedlong
:nameString
:refidReference
:sizelong
:valueString

Body text

Accepts a free-form text body.

Reference

https://ant.apache.org/manual/Types/string.html

Defined by

org.apache.tools.ant.types.resources.StringResource

Ant type string. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:directory` | `boolean` |  |  |
| `:encoding` | `String` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |
| `:value` | `String` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

https://ant.apache.org/manual/Types/string.html

**Defined by**

`org.apache.tools.ant.types.resources.StringResource`
sourceraw docstring

stringtokenizerclj

(stringtokenizer & args)

Ant type stringtokenizer. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:delimsString
:delimsaretokensboolean
:includedelimsboolean
:suppressdelimsboolean

Reference

https://ant.apache.org/manual/Types/stringtokenizer.html

Defined by

org.apache.tools.ant.util.StringTokenizer

Ant type stringtokenizer. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:delims` | `String` |  |  |
| `:delimsaretokens` | `boolean` |  |  |
| `:includedelims` | `boolean` |  |  |
| `:suppressdelims` | `boolean` |  |  |

**Reference**

https://ant.apache.org/manual/Types/stringtokenizer.html

**Defined by**

`org.apache.tools.ant.util.StringTokenizer`
sourceraw docstring

stripjavacommentsclj

(stripjavacomments & args)

Ant nested stripjavacomments. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.StripJavaComments

Ant nested stripjavacomments. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.StripJavaComments`
sourceraw docstring

striplinebreaksclj

(striplinebreaks & args)

Ant nested striplinebreaks. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:linebreaksString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.StripLineBreaks

Ant nested striplinebreaks. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:linebreaks` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.StripLineBreaks`
sourceraw docstring

striplinecommentsclj

(striplinecomments & args)

Ant nested striplinecomments. (No description bundled.)

Nested elements

  • :comment (Comment)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.StripLineComments

Ant nested striplinecomments. (No description bundled.)

**Nested elements**

- `:comment` (`Comment`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.StripLineComments`
sourceraw docstring

styleclj

(style & args)

Process a set of documents via XSLT. This is useful for building views of XML based documentation, or for generating code. It is possible to refine the set of files that are being processed. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements. Note: Unlike other similar tasks, this task treats directories that have been matched by the include/exclude patterns of the implicit fileset in a special way. It will apply the stylesheets to all files contain in them as well. Since the default includes pattern is ** this means it will apply the stylesheet to all files. If you specify an excludes pattern, it may still work on the files matched by those patterns because the parent directory has been matched. If this behavior is not what you want, set the scanincludedirectories attribute to false. Since Ant 1.7, this task supports nested resource collections in addition to (or instead of, depending on the useImplicitFileset attribute) the implicit fileset formed by this task. This task supports the use of a nested <param> element which is used to pass values to an xsl:param declaration. This task supports the use of a nested xmlcatalog element which is used to perform Entity and URI resolution. Note on XSLT extension functions: when using the default TrAX implementation of the Java class library and a SecurityManager is active-e.g. when running from within an IDE-XSLT extension functions cannot be used as "secure processing" is active in Java 7 and above. Ant contains a special "hack" that allows XSLT extensions to be used in Java 7 and 8, but this hack fails for Java 9. If you want to use extensions like the redirect extension that are provided by the Java class library itself, you can allow them by enabling the feature http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions in Java 9 and above. If you need to use an extension function not provided by Java itself you can set the attribute jdk.xml.transform.extensionClassLoader to a classloader (reference to an Ant path-like structure).

Attributes

AttributeTypeDescriptionRequired
:basedirFilewhere to find the source XML file.No; defaults to the project's basedir
:casesensitiveboolean
:classpathPaththe classpath to use when looking up the XSLT processor.No
:classpathrefReferencethe classpath to use, given as reference to a path defined elsewhere.No
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destdirFiledirectory in which to store the results.Yes, unless in and out have been specified.
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:extensionStringdesired file extension to be used for the targets.No; default is .html, ignored if a nested <mapper> or both in and out have been specified
:failonerrorbooleanWhether the build should fail if any error occurs. Note that transformation errors can still be suppressed by setting failOnTransformationError to false even if this attribute is true. Since Ant 1.8.0.No; default is true
:failonnoresourcesbooleanWhether the build should fail if the nested resource collection is empty. Note that this attribute has no effect of failOnError is false. Since Ant 1.8.0.No; default is true
:failontransformationerrorbooleanWhether the build should fail if an error occurs while transforming the document. Note that this attribute has no effect if failOnError is false. Since Ant 1.8.0.No; default is true
:filedirparameterStringSpecifies a XSL parameter for accessing the directory of the current processed file. For files in the current directory, a value of. will be passed to the transformation. If not set, the directory is not passed to the transformation. Since Ant 1.7.No
:filenameparameterStringSpecifies an XSL parameter for accessing the name of the current processed file. If not set, the file name is not passed to the transformation. Since Ant 1.7.No
:followsymlinksboolean
:forcebooleanRecreate target files, even if they are newer than their corresponding source files or the stylesheet.No; default is false
:granularitylongThe number of milliseconds leeway to give before deciding a file is out of date with respect of the source file or stylesheet. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.10.16.No; default is 1 second, or 2 seconds on DOS systems
:inFilespecifies a single XML document to be styled. Should be used with the out attribute.No
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:outFilespecifies the output name for the styled result from the in attribute.No
:processorStringname of the XSLT processor to use. Permissible value is: trax for a TraX compliant processor (ie JAXP interface implementation such as Xalan 2 or Saxon) Support for Xalan 1 has been removed since Ant 1.7.No; defaults to trax
:reloadstylesheetbooleanControl whether the stylesheet transformer is created anew for every transform operation. If you set this to true, performance may suffer, but you may work around a bug in certain Xalan versions. Since Ant 1.5.2.No; default is false
:scanincludeddirectoriesbooleanIf any directories are matched by the includes/excludes patterns, try to transform all files in these directories. No; default is true
:styleStringname of the stylesheet to use-given either relative to the project's basedir or as an absolute path. Alternatively, a nested element which Ant can interpret as a resource can be used to indicate where to find the stylesheet. Deprecated variation: If the stylesheet cannot be found, and if you have specified the attribute basedir for the task, Ant will assume that the style attribute is relative to the basedir of the task.No, if the location of the stylesheet is specified using a nested <style> element
:suppresswarningsbooleanWhether processor warnings shall be suppressed. This option requires support by the processor, it is supported by the TrAX processor bundled with Ant. Since Ant 1.8.0.No; default is false
:useimplicitfilesetbooleanWhether the implicit fileset formed by this task shall be used. If you set this to false you must use nested resource collections-or the in attribute, in which case this attribute has no impact anyway. Since Ant 1.7.No; default is true
:xslresourceResource

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :factory (Factory)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :mapper (Mapper)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :outputproperty (OutputProperty)
  • :param (Param)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :style (Resources)
  • :sysproperty (Variable)
  • :syspropertyset (PropertySet)
  • :trace (TraceConfiguration)
  • :type (TypeSelector)
  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Tasks/style.html

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess

Process a set of documents via XSLT. This is useful for building views of XML based
documentation, or for generating code. It is possible to refine the set of files that
are being processed. This can be done with the includes, includesfile, excludes,
excludesfile and defaultexcludes attributes. With the includes or includesfile attribute
you specify the files you want to have included by using patterns. The exclude or
excludesfile attribute is used to specify the files you want to have excluded. This is
also done with patterns. And finally with the defaultexcludes attribute, you can specify
whether you want to use default exclusions or not. See the section on directory based
tasks, on how the inclusion/exclusion of files works, and how to write patterns. This
task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes
basedir) as well as the nested <include>, <exclude> and <patternset> elements. Note:
Unlike other similar tasks, this task treats directories that have been matched by the
include/exclude patterns of the implicit fileset in a special way. It will apply the
stylesheets to all files contain in them as well. Since the default includes pattern is
** this means it will apply the stylesheet to all files. If you specify an excludes
pattern, it may still work on the files matched by those patterns because the parent
directory has been matched. If this behavior is not what you want, set the
scanincludedirectories attribute to false. Since Ant 1.7, this task supports nested
resource collections in addition to (or instead of, depending on the useImplicitFileset
attribute) the implicit fileset formed by this task. This task supports the use of a
nested <param> element which is used to pass values to an <xsl:param> declaration. This
task supports the use of a nested xmlcatalog element which is used to perform Entity and
URI resolution. Note on XSLT extension functions: when using the default TrAX
implementation of the Java class library and a SecurityManager is active-e.g. when
running from within an IDE-XSLT extension functions cannot be used as "secure
processing" is active in Java 7 and above. Ant contains a special "hack" that allows
XSLT extensions to be used in Java 7 and 8, but this hack fails for Java 9. If you want
to use extensions like the redirect extension that are provided by the Java class
library itself, you can allow them by enabling the feature
http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions in Java 9 and above.
If you need to use an extension function not provided by Java itself you can set the
attribute jdk.xml.transform.extensionClassLoader to a classloader (reference to an Ant
path-like structure).

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | where to find the source XML file. | No; defaults to the project's basedir |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | the classpath to use when looking up the XSLT processor. | No |
| `:classpathref` | `Reference` | the classpath to use, given as reference to a path defined elsewhere. | No |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | directory in which to store the results. | Yes, unless in and out have been specified. |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:extension` | `String` | desired file extension to be used for the targets. | No; default is .html, ignored if a nested <mapper> or both in and out have been specified |
| `:failonerror` | `boolean` | Whether the build should fail if any error occurs. Note that transformation errors can still be suppressed by setting failOnTransformationError to false even if this attribute is true. Since Ant 1.8.0. | No; default is true |
| `:failonnoresources` | `boolean` | Whether the build should fail if the nested resource collection is empty. Note that this attribute has no effect of failOnError is false. Since Ant 1.8.0. | No; default is true |
| `:failontransformationerror` | `boolean` | Whether the build should fail if an error occurs while transforming the document. Note that this attribute has no effect if failOnError is false. Since Ant 1.8.0. | No; default is true |
| `:filedirparameter` | `String` | Specifies a XSL parameter for accessing the directory of the current processed file. For files in the current directory, a value of. will be passed to the transformation. If not set, the directory is not passed to the transformation. Since Ant 1.7. | No |
| `:filenameparameter` | `String` | Specifies an XSL parameter for accessing the name of the current processed file. If not set, the file name is not passed to the transformation. Since Ant 1.7. | No |
| `:followsymlinks` | `boolean` |  |  |
| `:force` | `boolean` | Recreate target files, even if they are newer than their corresponding source files or the stylesheet. | No; default is false |
| `:granularity` | `long` | The number of milliseconds leeway to give before deciding a file is out of date with respect of the source file or stylesheet. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.10.16. | No; default is 1 second, or 2 seconds on DOS systems |
| `:in` | `File` | specifies a single XML document to be styled. Should be used with the out attribute. | No |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:out` | `File` | specifies the output name for the styled result from the in attribute. | No |
| `:processor` | `String` | name of the XSLT processor to use. Permissible value is: trax for a TraX compliant processor (ie JAXP interface implementation such as Xalan 2 or Saxon) Support for Xalan 1 has been removed since Ant 1.7. | No; defaults to trax |
| `:reloadstylesheet` | `boolean` | Control whether the stylesheet transformer is created anew for every transform operation. If you set this to true, performance may suffer, but you may work around a bug in certain Xalan versions. Since Ant 1.5.2. | No; default is false |
| `:scanincludeddirectories` | `boolean` | If any directories are matched by the includes/excludes patterns, try to transform all files in these directories. No; default is true |  |
| `:style` | `String` | name of the stylesheet to use-given either relative to the project's basedir or as an absolute path. Alternatively, a nested element which Ant can interpret as a resource can be used to indicate where to find the stylesheet. Deprecated variation: If the stylesheet cannot be found, and if you have specified the attribute basedir for the task, Ant will assume that the style attribute is relative to the basedir of the task. | No, if the location of the stylesheet is specified using a nested <style> element |
| `:suppresswarnings` | `boolean` | Whether processor warnings shall be suppressed. This option requires support by the processor, it is supported by the TrAX processor bundled with Ant. Since Ant 1.8.0. | No; default is false |
| `:useimplicitfileset` | `boolean` | Whether the implicit fileset formed by this task shall be used. If you set this to false you must use nested resource collections-or the in attribute, in which case this attribute has no impact anyway. Since Ant 1.7. | No; default is true |
| `:xslresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:factory` (`Factory`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:mapper` (`Mapper`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:outputproperty` (`OutputProperty`)
- `:param` (`Param`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:style` (`Resources`)
- `:sysproperty` (`Variable`)
- `:syspropertyset` (`PropertySet`)
- `:trace` (`TraceConfiguration`)
- `:type` (`TypeSelector`)
- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Tasks/style.html

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess`
sourceraw docstring

subantclj

(subant & args)

Calls a given target for all defined sub-builds. This is an extension of Ant for bulk project execution. This task must not be used outside of a target if it invokes the same build file it is part of. subant uses ant internally so many things said in ant's manual page apply here as well.

Attributes

AttributeTypeDescriptionRequired
:antfileStringBuild file name, to use in conjunction with directories.String
:buildpathPathSet the buildpath to be used to find sub-projects.Path
:buildpathrefReferenceBuildpath to use, by reference.Reference
:failonerrorbooleanSets whether to fail with a build exception on error, or go on.boolean
:genericantfileFileBuild file path, to use in conjunction with directories. Use genericantfile, in order to run the same build file with different basedirs. If this attribute is set, antfile is ignored.File
:inheritallbooleanCorresponds to <ant>'s inheritall attribute but defaults to false in this task.boolean
:inheritrefsbooleanCorresponds to <ant>'s inheritrefs attribute.boolean
:outputStringCorresponds to <ant>'s output attribute.String
:targetString
:verbosebooleanEnable/disable log messages showing when each sub-build path is entered/exited.boolean

Nested elements

  • :buildpath (Path)
  • :buildpathelement (PathElement)
  • :dirset (DirSet)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :property (Property)
  • :propertyset (PropertySet)
  • :reference (Reference)
  • :target (TargetElement)

Reference

https://ant.apache.org/manual/Tasks/subant.html

Defined by

org.apache.tools.ant.taskdefs.SubAnt

Calls a given target for all defined sub-builds. This is an extension of Ant for bulk
project execution. This task must not be used outside of a target if it invokes the same
build file it is part of. subant uses ant internally so many things said in ant's manual
page apply here as well.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:antfile` | `String` | Build file name, to use in conjunction with directories. | String |
| `:buildpath` | `Path` | Set the buildpath to be used to find sub-projects. | Path |
| `:buildpathref` | `Reference` | Buildpath to use, by reference. | Reference |
| `:failonerror` | `boolean` | Sets whether to fail with a build exception on error, or go on. | boolean |
| `:genericantfile` | `File` | Build file path, to use in conjunction with directories. Use genericantfile, in order to run the same build file with different basedirs. If this attribute is set, antfile is ignored. | File |
| `:inheritall` | `boolean` | Corresponds to <ant>'s inheritall attribute but defaults to false in this task. | boolean |
| `:inheritrefs` | `boolean` | Corresponds to <ant>'s inheritrefs attribute. | boolean |
| `:output` | `String` | Corresponds to <ant>'s output attribute. | String |
| `:target` | `String` |  |  |
| `:verbose` | `boolean` | Enable/disable log messages showing when each sub-build path is entered/exited. | boolean |

**Nested elements**

- `:buildpath` (`Path`)
- `:buildpathelement` (`PathElement`)
- `:dirset` (`DirSet`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:property` (`Property`)
- `:propertyset` (`PropertySet`)
- `:reference` (`Reference`)
- `:target` (`TargetElement`)

**Reference**

https://ant.apache.org/manual/Tasks/subant.html

**Defined by**

`org.apache.tools.ant.taskdefs.SubAnt`
sourceraw docstring

substitutionclj

(substitution & args)

Ant type substitution. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:expressionString
:refidReference

Reference

https://ant.apache.org/manual/Types/substitution.html

Defined by

org.apache.tools.ant.types.Substitution

Ant type substitution. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:expression` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/substitution.html

**Defined by**

`org.apache.tools.ant.types.Substitution`
sourceraw docstring

suffixlinesclj

(suffixlines & args)

Ant nested suffixlines. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:suffixString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.SuffixLines

Ant nested suffixlines. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:suffix` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.SuffixLines`
sourceraw docstring

supportclj

(support & args)

Ant nested support. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested support. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

(symlink & args)

Manages symbolic links on platforms where Java supports symbolic links. Can be used to make an individual link, delete a link, create multiple links from properties files, or create properties files describing links in the specified directories. Existing files are not overwritten by default. FileSets are used to select a set of links to record, or a set of property files to create links from.

Attributes

AttributeTypeDescriptionRequired
:actionStringThe type of action to perform, may be single, "record, recreate or delete.No; defaults to single
:failonerrorbooleanStop build if true, log a warning message, but do not stop the build, when the an error occurs if false.No; defaults to true
:linkStringThe name of the link to be created or deleted. Note: this attribute is resolved against the current working directory rather than the project's basedir for historical reasons. It is recommended you always use an absolute path or a path like ${basedir}/some-path as its value.Yes, for action=single or delete; ignored in other actions
:linkfilenameStringThe name of the properties file to create in each included directory.Yes, for action=record; ignored in other actions
:overwritebooleanOverwrite existing files or not. If overwrite is set to true, then any existing file, specified by the link attribute, will be overwritten irrespective of whether or not the existing file is a symbolic link.No; defaults to false
:resourceStringThe resource the link should point to.Yes, for action=single; ignored in other actions

Nested elements

  • :fileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/symlink.html

Defined by

org.apache.tools.ant.taskdefs.optional.unix.Symlink

Manages symbolic links on platforms where Java supports symbolic links. Can be used to
make an individual link, delete a link, create multiple links from properties files, or
create properties files describing links in the specified directories. Existing files
are not overwritten by default. FileSets are used to select a set of links to record, or
a set of property files to create links from.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:action` | `String` | The type of action to perform, may be single, "record, recreate or delete. | No; defaults to single |
| `:failonerror` | `boolean` | Stop build if true, log a warning message, but do not stop the build, when the an error occurs if false. | No; defaults to true |
| `:link` | `String` | The name of the link to be created or deleted. Note: this attribute is resolved against the current working directory rather than the project's basedir for historical reasons. It is recommended you always use an absolute path or a path like ${basedir}/some-path as its value. | Yes, for action=single or delete; ignored in other actions |
| `:linkfilename` | `String` | The name of the properties file to create in each included directory. | Yes, for action=record; ignored in other actions |
| `:overwrite` | `boolean` | Overwrite existing files or not. If overwrite is set to true, then any existing file, specified by the link attribute, will be overwritten irrespective of whether or not the existing file is a symbolic link. | No; defaults to false |
| `:resource` | `String` | The resource the link should point to. | Yes, for action=single; ignored in other actions |

**Nested elements**

- `:fileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/symlink.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.unix.Symlink`
sourceraw docstring

syncclj

(sync & args)

Synchronize a target directory from the files defined in one or more resource collections. Any file in the target directory that has not been matched by at least one of the nested resource collections gets removed. I.e. if you exclude a file in your sources and a file of that name is present in the target dir, it will get removed from the target.

Attributes

AttributeTypeDescriptionRequired
:failonerrorbooleanIf set to false, log a warning message, but do not stop the build, when one of the nested filesets points to a directory that doesn't exist.No; defaults to true
:granularitylongThe number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6.2.No; default is 0 milliseconds, or 2 seconds on DOS systems.
:includeemptydirsbooleanCopy any empty directories included in the resource collection(s). Note: this attribute also controls the behavior for any nested <preserveintarget> element. If this attribute is false (the default) empty directories that only exist in the target directory will be removed even if they are matched by the patterns of <preserveintarget>. This can be overridden by <preserveintarget>'s preserveEmptyDirs attribute.No; defaults to false
:overwritebooleanOverwrite existing files even if the destination files are newer.No; defaults to false
:todirFilethe target directory to sync with the resource collectionsYes
:verbosebooleanLog the files that are being copied.No; defaults to false

Nested elements

  • :fileset (FileSet)
  • :preserveintarget (SyncTarget)

Reference

https://ant.apache.org/manual/Tasks/sync.html

Defined by

org.apache.tools.ant.taskdefs.Sync

Synchronize a target directory from the files defined in one or more resource
collections. Any file in the target directory that has not been matched by at least one
of the nested resource collections gets removed. I.e. if you exclude a file in your
sources and a file of that name is present in the target dir, it will get removed from
the target.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:failonerror` | `boolean` | If set to false, log a warning message, but do not stop the build, when one of the nested filesets points to a directory that doesn't exist. | No; defaults to true |
| `:granularity` | `long` | The number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.6.2. | No; default is 0 milliseconds, or 2 seconds on DOS systems. |
| `:includeemptydirs` | `boolean` | Copy any empty directories included in the resource collection(s). Note: this attribute also controls the behavior for any nested <preserveintarget> element. If this attribute is false (the default) empty directories that only exist in the target directory will be removed even if they are matched by the patterns of <preserveintarget>. This can be overridden by <preserveintarget>'s preserveEmptyDirs attribute. | No; defaults to false |
| `:overwrite` | `boolean` | Overwrite existing files even if the destination files are newer. | No; defaults to false |
| `:todir` | `File` | the target directory to sync with the resource collections | Yes |
| `:verbose` | `boolean` | Log the files that are being copied. | No; defaults to false |

**Nested elements**

- `:fileset` (`FileSet`)
- `:preserveintarget` (`SyncTarget`)

**Reference**

https://ant.apache.org/manual/Tasks/sync.html

**Defined by**

`org.apache.tools.ant.taskdefs.Sync`
sourceraw docstring

syspropertyclj

(sysproperty & args)

Ant nested sysproperty. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:fileFile
:keyString
:pathPath
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Environment$Variable

Ant nested sysproperty. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:file` | `File` |  |  |
| `:key` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Environment$Variable`
sourceraw docstring

syspropertysetclj

(syspropertyset & args)

Ant nested syspropertyset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:dynamicboolean
:negateboolean
:refidReference

Nested elements

  • :mapper (Mapper)
  • :propertyref (PropertyRef)
  • :propertyset (PropertySet)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.PropertySet

Ant nested syspropertyset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dynamic` | `boolean` |  |  |
| `:negate` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:mapper` (`Mapper`)
- `:propertyref` (`PropertyRef`)
- `:propertyset` (`PropertySet`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.PropertySet`
sourceraw docstring

tabstospacesclj

(tabstospaces & args)

Ant nested tabstospaces. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:tablengthint

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TabsToSpaces

Ant nested tabstospaces. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:tablength` | `int` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TabsToSpaces`
sourceraw docstring

tagclj

(tag & args)

Ant nested tag. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:enabledboolean
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:nameString
:refidReference
:scopeString

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$TagArgument

Ant nested tag. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:enabled` | `boolean` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:scope` | `String` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$TagArgument`
sourceraw docstring

tagletclj

(taglet & args)

Ant nested taglet. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString
:pathPath
:pathrefReference

Nested elements

  • :path (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$ExtensionInfo

Ant nested taglet. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |
| `:path` | `Path` |  |  |
| `:pathref` | `Reference` |  |  |

**Nested elements**

- `:path` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$ExtensionInfo`
sourceraw docstring

tailfilterclj

(tailfilter & args)

Ant nested tailfilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:lineslong
:skiplong

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TailFilter

Ant nested tailfilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:lines` | `long` |  |  |
| `:skip` | `long` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TailFilter`
sourceraw docstring

tarclj

(tar & args)

Creates a tar archive. The basedir attribute is the reference directory from where to tar. This task is a directory based task and, as such, forms an implicit Fileset. This defines which files, relative to the basedir, will be included in the archive. The tar task supports all the attributes of Fileset to refine the set of files to be included in the implicit fileset. In addition to the implicit fileset, the tar task supports nested resource collections and a special form of filesets. These filesets are extended to allow control over the access mode, username and groupname to be applied to the tar entries. This is useful, for example, when preparing archives for Unix systems where some files need to have execute permission. By default this task will use Unix permissions of 644 for files and 755 for directories. Early versions of tar utility did not support paths longer than 100 characters. Over time several incompatible extensions have been developed until a new POSIX standard was created that added so called PAX extension headers (as the pax utility first introduced them) that among another things addressed file names longer than 100 characters. All modern implementations of tar support PAX extension headers. Ant's tar support predates the standard with PAX extension headers, it supports different dialects that can be enabled using the longfile attribute. If the longfile attribute is set to fail, any long paths will cause the tar task to fail. If the longfile attribute is set to truncate, any long paths will be truncated to the 100 character maximum length prior to adding to the archive. If the value of the longfile attribute is set to omit then files containing long paths will be omitted from the archive. Either option ensures that the archive can be untarred by any compliant version of tar. If the loss of path or file information is not acceptable, and it rarely is, longfile may be set to the value gnu or posix. With posix Ant will add PAX extension headers, with gnu it adds GNU tar specific extensions that newer versions of GNU tar call oldgnu. GNU tar still creates these extensions by default but supports PAX extension headers as well. Either choice will produce a tar file which can have arbitrary length paths. Note however, that the resulting archive will only be able to be untarred with tar tools that support the chosen format. The default for the longfile attribute is warn which behaves just like the gnu option except that it produces a warning for each filepath encountered that does not match the limit. It uses gnu rather than posix for backwards compatibility reasons. To achieve best interoperability you should use either fail or posix for the longfile attribute. This task can perform compression by setting the compression attribute to gzip, bzip2, or xz.

Attributes

AttributeTypeDescriptionRequired
:basedirFilethe directory from which to tar the files.No
:casesensitiveboolean
:compressionTarCompressionMethodcompression method. Allowable values are none, gzip, xz and bzip2.No; default is none
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destfileFilethe tar file to create.Yes
:encodingStringThe character encoding to use for filenames inside the tar file. For a list of possible values see the Supported Encodings. In general the tar format expects names to use a single byte encoding and specifying a multi-byte encoding here may lead to archives that cannot be properly extracted by my tar tools. Since Ant 1.9.5 No; defaults to default JVM character encoding
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:longfileTarLongFileModeDetermines how long filenames (> 100 chars) are to be handled. Allowed values are truncate, fail, warn, omit, gnu and posix.No; default is warn
:tarfileFile

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :tarfileset (TarFileSet)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/tar.html

Defined by

org.apache.tools.ant.taskdefs.Tar

Creates a tar archive. The basedir attribute is the reference directory from where to
tar. This task is a directory based task and, as such, forms an implicit Fileset. This
defines which files, relative to the basedir, will be included in the archive. The tar
task supports all the attributes of Fileset to refine the set of files to be included in
the implicit fileset. In addition to the implicit fileset, the tar task supports nested
resource collections and a special form of filesets. These filesets are extended to
allow control over the access mode, username and groupname to be applied to the tar
entries. This is useful, for example, when preparing archives for Unix systems where
some files need to have execute permission. By default this task will use Unix
permissions of 644 for files and 755 for directories. Early versions of tar utility did
not support paths longer than 100 characters. Over time several incompatible extensions
have been developed until a new POSIX standard was created that added so called PAX
extension headers (as the pax utility first introduced them) that among another things
addressed file names longer than 100 characters. All modern implementations of tar
support PAX extension headers. Ant's tar support predates the standard with PAX
extension headers, it supports different dialects that can be enabled using the longfile
attribute. If the longfile attribute is set to fail, any long paths will cause the tar
task to fail. If the longfile attribute is set to truncate, any long paths will be
truncated to the 100 character maximum length prior to adding to the archive. If the
value of the longfile attribute is set to omit then files containing long paths will be
omitted from the archive. Either option ensures that the archive can be untarred by any
compliant version of tar. If the loss of path or file information is not acceptable, and
it rarely is, longfile may be set to the value gnu or posix. With posix Ant will add PAX
extension headers, with gnu it adds GNU tar specific extensions that newer versions of
GNU tar call oldgnu. GNU tar still creates these extensions by default but supports PAX
extension headers as well. Either choice will produce a tar file which can have
arbitrary length paths. Note however, that the resulting archive will only be able to be
untarred with tar tools that support the chosen format. The default for the longfile
attribute is warn which behaves just like the gnu option except that it produces a
warning for each filepath encountered that does not match the limit. It uses gnu rather
than posix for backwards compatibility reasons. To achieve best interoperability you
should use either fail or posix for the longfile attribute. This task can perform
compression by setting the compression attribute to gzip, bzip2, or xz.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | the directory from which to tar the files. | No |
| `:casesensitive` | `boolean` |  |  |
| `:compression` | `TarCompressionMethod` | compression method. Allowable values are none, gzip, xz and bzip2. | No; default is none |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destfile` | `File` | the tar file to create. | Yes |
| `:encoding` | `String` | The character encoding to use for filenames inside the tar file. For a list of possible values see the Supported Encodings. In general the tar format expects names to use a single byte encoding and specifying a multi-byte encoding here may lead to archives that cannot be properly extracted by my tar tools. Since Ant 1.9.5 No; defaults to default JVM character encoding |  |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:longfile` | `TarLongFileMode` | Determines how long filenames (> 100 chars) are to be handled. Allowed values are truncate, fail, warn, omit, gnu and posix. | No; default is warn |
| `:tarfile` | `File` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:tarfileset` (`TarFileSet`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/tar.html

**Defined by**

`org.apache.tools.ant.taskdefs.Tar`
sourceraw docstring

tarentryclj

(tarentry & args)

Ant type tarentry. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:archiveFile
:directoryboolean
:existsboolean
:lastmodifiedlong
:modeint
:nameString
:refidReference
:sizelong

Reference

https://ant.apache.org/manual/Types/tarentry.html

Defined by

org.apache.tools.ant.types.resources.TarResource

Ant type tarentry. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:archive` | `File` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:mode` | `int` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |

**Reference**

https://ant.apache.org/manual/Types/tarentry.html

**Defined by**

`org.apache.tools.ant.types.resources.TarResource`
sourceraw docstring

tarfilesetclj

(tarfileset & args)

TarFileSet has been a stand-alone type since Apache Ant 1.7. A <tarfileset> is a special form of a <fileset> which can behave in 2 different ways: When the src attribute is used-or a nested resource collection has been specified, the tarfileset is populated with tar entries found in the file src. When the dir attribute is used, the tarfileset is populated with filesystem files found under dir. <tarfileset> supports all attributes of <fileset> in addition to those listed below. Note that tar archives in general don't contain entries with leading slashes so you shouldn't use include/exclude patterns that start with slashes either. Since Ant 1.7, a tarfileset can be defined with the id attribute and referred to with the refid attribute.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories.No; default is 755
:encodingStringThe character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings. Since Ant 1.9.5No; defaults to default JVM character encoding
:erroronmissingarchivebooleanSpecify what happens if the archive does not exist. If true, a build error will happen; if false, the fileset will be ignored/empty. Since Ant 1.8.0No; defaults to true
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files.No; default is 644
:followsymlinksboolean
:fullpathStringthe file described by the fileset is placed at that exact location in the archive.No
:gidintThe group identifier (GID) for the tar entry.No
:groupStringThe groupname for the tar entry. This is not the same as the GID.No
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixStringall files in the fileset are prefixed with that path in the archive.No
:refidReference
:srcFilemay be used in place of the dir attribute to specify a tar file whose contents will be extracted and included in the archive.No
:srcresourceResource
:uidintThe user identifier (UID) for the tar entry. This is an integer value and is not the same as the username.No
:usernameStringThe username for the tar entry. This is not the same as the UID.No

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/tarfileset.html

Defined by

org.apache.tools.ant.types.TarFileSet

TarFileSet has been a stand-alone type since Apache Ant 1.7. A <tarfileset> is a special
form of a <fileset> which can behave in 2 different ways: When the src attribute is
used-or a nested resource collection has been specified, the tarfileset is populated
with tar entries found in the file src. When the dir attribute is used, the tarfileset
is populated with filesystem files found under dir. <tarfileset> supports all attributes
of <fileset> in addition to those listed below. Note that tar archives in general don't
contain entries with leading slashes so you shouldn't use include/exclude patterns that
start with slashes either. Since Ant 1.7, a tarfileset can be defined with the id
attribute and referred to with the refid attribute.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories. | No; default is 755 |
| `:encoding` | `String` | The character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings. Since Ant 1.9.5 | No; defaults to default JVM character encoding |
| `:erroronmissingarchive` | `boolean` | Specify what happens if the archive does not exist. If true, a build error will happen; if false, the fileset will be ignored/empty. Since Ant 1.8.0 | No; defaults to true |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files. | No; default is 644 |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` | the file described by the fileset is placed at that exact location in the archive. | No |
| `:gid` | `int` | The group identifier (GID) for the tar entry. | No |
| `:group` | `String` | The groupname for the tar entry. This is not the same as the GID. | No |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` | all files in the fileset are prefixed with that path in the archive. | No |
| `:refid` | `Reference` |  |  |
| `:src` | `File` | may be used in place of the dir attribute to specify a tar file whose contents will be extracted and included in the archive. | No |
| `:srcresource` | `Resource` |  |  |
| `:uid` | `int` | The user identifier (UID) for the tar entry. This is an integer value and is not the same as the username. | No |
| `:username` | `String` | The username for the tar entry. This is not the same as the UID. | No |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/tarfileset.html

**Defined by**

`org.apache.tools.ant.types.TarFileSet`
sourceraw docstring

targetclj

(target & args)

Ant nested target. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Ant$TargetElement

Ant nested target. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Ant$TargetElement`
sourceraw docstring

targetfileclj

(targetfile & args)

Ant nested targetfile. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:prefixString
:suffixString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Commandline$Marker

Ant nested targetfile. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:prefix` | `String` |  |  |
| `:suffix` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Commandline$Marker`
sourceraw docstring

targetfilelistclj

(targetfilelist & args)

Ant nested targetfilelist. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:dirFile
:filesString
:refidReference

Nested elements

  • :file (FileName)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileList

Ant nested targetfilelist. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dir` | `File` |  |  |
| `:files` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:file` (`FileName`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileList`
sourceraw docstring

targetfilesetclj

(targetfileset & args)

Ant nested targetfileset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested targetfileset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

targetsclj

(targets & args)

Ant nested targets. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested targets. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

tarsclj

(tars & args)

Ant nested tars. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.resources.Union

Ant nested tars. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.resources.Union`
sourceraw docstring

taskclj

(task & args)

Ant nested task. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.Task

Ant nested task. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.Task`
sourceraw docstring

taskdefclj

(taskdef & args)

Adds a task definition to the current project, such that this new task can be used in the current project. This task is a form of Typedef with the attributes adapter and adaptto set to the values org.apache.tools.ant.TaskAdapter and org.apache.tools.ant.Task respectively. Anything said in the manual page of typedef applies to taskdef as well.

Attributes

AttributeTypeDescriptionRequired
:adapterString
:adapttoString
:antlibString
:classnameString
:classpathPath
:classpathrefReference
:fileFile
:formatFormat
:loaderrefReference
:nameString
:onerrorOnError
:resourceString
:reverseloaderboolean
:uriString

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/taskdef.html

Defined by

org.apache.tools.ant.taskdefs.Taskdef

Adds a task definition to the current project, such that this new task can be used in
the current project. This task is a form of Typedef with the attributes adapter and
adaptto set to the values org.apache.tools.ant.TaskAdapter and org.apache.tools.ant.Task
respectively. Anything said in the manual page of typedef applies to taskdef as well.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:adapter` | `String` |  |  |
| `:adaptto` | `String` |  |  |
| `:antlib` | `String` |  |  |
| `:classname` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:file` | `File` |  |  |
| `:format` | `Format` |  |  |
| `:loaderref` | `Reference` |  |  |
| `:name` | `String` |  |  |
| `:onerror` | `OnError` |  |  |
| `:resource` | `String` |  |  |
| `:reverseloader` | `boolean` |  |  |
| `:uri` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/taskdef.html

**Defined by**

`org.apache.tools.ant.taskdefs.Taskdef`
sourceraw docstring

tempfileclj

(tempfile & args)

This task sets a property to the name of a temporary file. Unlike java.io.File.createTempFile, this task does not actually create the temporary file, but it does guarantee that the file did not exist when the task was executed.

Attributes

AttributeTypeDescriptionRequired
:createfilebooleanWhether the temp file should be created by this task. Since Ant 1.8boolean
:deleteonexitbooleanWhether the temp file will be marked for deletion on normal exit of JVM (even though the file may never be created). Since Apache Ant 1.7boolean
:destdirFileSets the destination directory.File
:prefixStringSets the optional prefix string for the temp file.String
:propertyStringSets the property you wish to assign the temporary file to.String
:suffixStringSets the optional suffix string for the temp file.String

Reference

https://ant.apache.org/manual/Tasks/tempfile.html

Defined by

org.apache.tools.ant.taskdefs.TempFile

This task sets a property to the name of a temporary file. Unlike
java.io.File.createTempFile, this task does not actually create the temporary file, but
it does guarantee that the file did not exist when the task was executed.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:createfile` | `boolean` | Whether the temp file should be created by this task. Since Ant 1.8 | boolean |
| `:deleteonexit` | `boolean` | Whether the temp file will be marked for deletion on normal exit of JVM (even though the file may never be created). Since Apache Ant 1.7 | boolean |
| `:destdir` | `File` | Sets the destination directory. | File |
| `:prefix` | `String` | Sets the optional prefix string for the temp file. | String |
| `:property` | `String` | Sets the property you wish to assign the temporary file to. | String |
| `:suffix` | `String` | Sets the optional suffix string for the temp file. | String |

**Reference**

https://ant.apache.org/manual/Tasks/tempfile.html

**Defined by**

`org.apache.tools.ant.taskdefs.TempFile`
sourceraw docstring

textclj

(text & args)

Ant nested text. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:defaultString
:nameString
:optionalboolean
:trimboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.MacroDef$Text

Ant nested text. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:default` | `String` |  |  |
| `:name` | `String` |  |  |
| `:optional` | `boolean` |  |  |
| `:trim` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.MacroDef$Text`
sourceraw docstring

titleclj

(title & args)

Ant nested title. (No description bundled.)

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.Javadoc$Html

Ant nested title. (No description bundled.)

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.Javadoc$Html`
sourceraw docstring

toclj

(to & args)

Ant nested to. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:addressString
:nameString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.email.EmailAddress

Ant nested to. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:address` | `String` |  |  |
| `:name` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.email.EmailAddress`
sourceraw docstring

tokenclj

(token & args)

Ant nested token. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:keyString
:valueString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.ReplaceTokens$Token

Ant nested token. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:key` | `String` |  |  |
| `:value` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.ReplaceTokens$Token`
sourceraw docstring

tokenfilterclj

(tokenfilter & args)

Ant nested tokenfilter. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:delimoutputString

Nested elements

  • :containsregex (ContainsRegex)
  • :containsstring (ContainsString)
  • :deletecharacters (DeleteCharacters)
  • :filetokenizer (FileTokenizer)
  • :ignoreblank (IgnoreBlank)
  • :linetokenizer (LineTokenizer)
  • :replaceregex (ReplaceRegex)
  • :replacestring (ReplaceString)
  • :stringtokenizer (StringTokenizer)
  • :trim (Trim)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter

Ant nested tokenfilter. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:delimoutput` | `String` |  |  |

**Nested elements**

- `:containsregex` (`ContainsRegex`)
- `:containsstring` (`ContainsString`)
- `:deletecharacters` (`DeleteCharacters`)
- `:filetokenizer` (`FileTokenizer`)
- `:ignoreblank` (`IgnoreBlank`)
- `:linetokenizer` (`LineTokenizer`)
- `:replaceregex` (`ReplaceRegex`)
- `:replacestring` (`ReplaceString`)
- `:stringtokenizer` (`StringTokenizer`)
- `:trim` (`Trim`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter`
sourceraw docstring

tokensclj

(tokens & args)

Ant type tokens. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:encodingString
:refidReference

Reference

https://ant.apache.org/manual/Types/tokens.html

Defined by

org.apache.tools.ant.types.resources.Tokens

Ant type tokens. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:encoding` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/tokens.html

**Defined by**

`org.apache.tools.ant.types.resources.Tokens`
sourceraw docstring

touchclj

(touch & args)

Changes the modification time of a resource and possibly creates it at the same time. In addition to working with a single file, this Task can also work on resources and resource collections (which also includes directories). Prior to Apache Ant 1.7 only FileSet or Filelist (since Ant 1.6) were supported. Ant uses the API of java.io.File to set the last modification time which has some limitations. For example, the timestamp granularity depends on the operating system and sometimes the operating system may allow a granularity smaller than milliseconds. If you need more control you have to fall back to the <exec> task and native commands. Since Ant 1.8.2, a warning message is logged upon failure to change the file modification time. This will happen if you try to change the modification time of a file you do not own on many Unix systems, for example.

Attributes

AttributeTypeDescriptionRequired
:datetimeStringSpecifies the new modification time of the file. Since Ant 1.8, the special value now indicates the current time.No; datetime takes precedence, however if both are omitted then current time is assumed
:fileFileThe name of the file.Unless a nested resource collection element has been specified
:millislongSpecifies the new modification time of the file in milliseconds since midnight Jan 1 1970.No; datetime takes precedence, however if both are omitted then current time is assumed
:mkdirsbooleanWhether to create nonexistent parent directories when touching new files. Since Ant 1.6.3No; default false
:patternStringSimpleDateFormat-compatible pattern string using the current locale. Since Ant 1.6.3No; defaults to MM/dd/YYYY hh:mm a or MM/dd/yyyy hh:mm:ss a using the US locale.
:verbosebooleanWhether to log the creation of new files. Since Ant 1.6.3No; default true

Nested elements

  • :filelist (FileList)
  • :fileset (FileSet)
  • :mapper (Mapper)

Reference

https://ant.apache.org/manual/Tasks/touch.html

Defined by

org.apache.tools.ant.taskdefs.Touch

Changes the modification time of a resource and possibly creates it at the same time. In
addition to working with a single file, this Task can also work on resources and
resource collections (which also includes directories). Prior to Apache Ant 1.7 only
FileSet or Filelist (since Ant 1.6) were supported. Ant uses the API of java.io.File to
set the last modification time which has some limitations. For example, the timestamp
granularity depends on the operating system and sometimes the operating system may allow
a granularity smaller than milliseconds. If you need more control you have to fall back
to the <exec> task and native commands. Since Ant 1.8.2, a warning message is logged
upon failure to change the file modification time. This will happen if you try to change
the modification time of a file you do not own on many Unix systems, for example.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:datetime` | `String` | Specifies the new modification time of the file. Since Ant 1.8, the special value now indicates the current time. | No; datetime takes precedence, however if both are omitted then current time is assumed |
| `:file` | `File` | The name of the file. | Unless a nested resource collection element has been specified |
| `:millis` | `long` | Specifies the new modification time of the file in milliseconds since midnight Jan 1 1970. | No; datetime takes precedence, however if both are omitted then current time is assumed |
| `:mkdirs` | `boolean` | Whether to create nonexistent parent directories when touching new files. Since Ant 1.6.3 | No; default false |
| `:pattern` | `String` | SimpleDateFormat-compatible pattern string using the current locale. Since Ant 1.6.3 | No; defaults to MM/dd/YYYY hh:mm a or MM/dd/yyyy hh:mm:ss a using the US locale. |
| `:verbose` | `boolean` | Whether to log the creation of new files. Since Ant 1.6.3 | No; default true |

**Nested elements**

- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)

**Reference**

https://ant.apache.org/manual/Tasks/touch.html

**Defined by**

`org.apache.tools.ant.taskdefs.Touch`
sourceraw docstring

traceclj

(trace & args)

Ant nested trace. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:elementsboolean
:extensionboolean
:generationboolean
:selectionboolean
:templatesboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess$TraceConfiguration

Ant nested trace. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:elements` | `boolean` |  |  |
| `:extension` | `boolean` |  |  |
| `:generation` | `boolean` |  |  |
| `:selection` | `boolean` |  |  |
| `:templates` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess$TraceConfiguration`
sourceraw docstring

transactionclj

(transaction & args)

Ant nested transaction. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:srcFile
:srcresourceResource

Body text

Accepts a free-form text body.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.SQLExec$Transaction

Ant nested transaction. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:src` | `File` |  |  |
| `:srcresource` | `Resource` |  |  |

**Body text**

Accepts a free-form text body.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.SQLExec$Transaction`
sourceraw docstring

translateclj

(translate & args)

Identifies keys in files delimited by special tokens and translates them with values read from resource bundles. A resource bundle contains locale-specific key-value pairs. A resource bundle is a hierarchical set of property files. A bundle name makes up its base family name. Each file that makes up this bundle has this name plus its locale. For example, if the resource bundle name is MyResources, the file that contains German text will take the name MyResources_de. In addition to language, country and variant are also used to form the files in the bundle. The resource bundle lookup searches for resource files with various suffixes on the basis of (1) the desired locale and (2) the default locale (basebundlename), in the following order from lower-level (more specific) to parent-level (less specific): basebundlename + "" + language1 + "" + country1 + "" + variant1 basebundlename + "" + language1 + "" + country1 basebundlename + "" + language1 basebundlename basebundlename + "" + language2 + "" + country2 + "" + variant2 basebundlename + "" + language2 + "" + country2 basebundlename + "" + language2 The file names generated thus are appended with the string .properties to make up the file names that are to be used. File encoding is supported. The encoding scheme of the source files, destination files and the bundle files can be specified. Destination files can be explicitly overwritten using the forceoverwrite attribute. If forceoverwrite is false, the destination file is overwritten only if either the source file or any of the files that make up the bundle have been modified after the destination file was last modified. Since Apache Ant 1.6 line endings of source files are preserved in the translated files. FileSets are used to select files to translate.

Attributes

AttributeTypeDescriptionRequired
:bundleStringFamily name of resource bundle.Yes
:bundlecountryStringLocale specific country of resource bundle.No; defaults to default locale's country
:bundleencodingStringResource Bundle file encoding scheme.No; defaults to srcencoding
:bundlelanguageStringLocale specific language of resource bundle.No; defaults to default locale's language
:bundlevariantStringLocale specific variant of resource bundle.No; defaults to bundlelanguage_bundlecountry
:casesensitiveboolean
:defaultexcludesboolean
:destencodingStringDestination file encoding scheme.No; defaults to srcencoding
:endtokenStringThe ending token to identify keys.Yes
:excludesString
:excludesfileFile
:followsymlinksboolean
:forceoverwritebooleanOverwrite existing files even if the destination files are newer.No; defaults to no
:includesString
:includesfileFile
:srcencodingStringSource file encoding scheme.No; defaults to default JVM character encoding
:starttokenStringThe starting token to identify keys.Yes
:todirFileDestination directory where destination files are to be created.Yes

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/translate.html

Defined by

org.apache.tools.ant.taskdefs.optional.i18n.Translate

Identifies keys in files delimited by special tokens and translates them with values
read from resource bundles. A resource bundle contains locale-specific key-value pairs.
A resource bundle is a hierarchical set of property files. A bundle name makes up its
base family name. Each file that makes up this bundle has this name plus its locale. For
example, if the resource bundle name is MyResources, the file that contains German text
will take the name MyResources_de. In addition to language, country and variant are also
used to form the files in the bundle. The resource bundle lookup searches for resource
files with various suffixes on the basis of (1) the desired locale and (2) the default
locale (basebundlename), in the following order from lower-level (more specific) to
parent-level (less specific): basebundlename + "_" + language1 + "_" + country1 + "_" +
variant1 basebundlename + "_" + language1 + "_" + country1 basebundlename + "_" +
language1 basebundlename basebundlename + "_" + language2 + "_" + country2 + "_" +
variant2 basebundlename + "_" + language2 + "_" + country2 basebundlename + "_" +
language2 The file names generated thus are appended with the string .properties to make
up the file names that are to be used. File encoding is supported. The encoding scheme
of the source files, destination files and the bundle files can be specified.
Destination files can be explicitly overwritten using the forceoverwrite attribute. If
forceoverwrite is false, the destination file is overwritten only if either the source
file or any of the files that make up the bundle have been modified after the
destination file was last modified. Since Apache Ant 1.6 line endings of source files
are preserved in the translated files. FileSets are used to select files to translate.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:bundle` | `String` | Family name of resource bundle. | Yes |
| `:bundlecountry` | `String` | Locale specific country of resource bundle. | No; defaults to default locale's country |
| `:bundleencoding` | `String` | Resource Bundle file encoding scheme. | No; defaults to srcencoding |
| `:bundlelanguage` | `String` | Locale specific language of resource bundle. | No; defaults to default locale's language |
| `:bundlevariant` | `String` | Locale specific variant of resource bundle. | No; defaults to bundlelanguage_bundlecountry |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:destencoding` | `String` | Destination file encoding scheme. | No; defaults to srcencoding |
| `:endtoken` | `String` | The ending token to identify keys. | Yes |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:forceoverwrite` | `boolean` | Overwrite existing files even if the destination files are newer. | No; defaults to no |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:srcencoding` | `String` | Source file encoding scheme. | No; defaults to default JVM character encoding |
| `:starttoken` | `String` | The starting token to identify keys. | Yes |
| `:todir` | `File` | Destination directory where destination files are to be created. | Yes |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/translate.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.i18n.Translate`
sourceraw docstring

trimclj

(trim & args)

Ant nested trim. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:bylineboolean

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.filters.TokenFilter$Trim

Ant nested trim. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:byline` | `boolean` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.filters.TokenFilter$Trim`
sourceraw docstring

truncateclj

(truncate & args)

Set the length of one or more files, as the truncate Unix function or GNU utility. In addition to working with a single file, this Task can also work on resources and resource collections.

Attributes

AttributeTypeDescriptionRequired
:adjustLongSpecifies the number of bytes (and positive/negative direction) by which to adjust file lengths. The same suffixes are supported for this attribute as for the length attribute.At most one of these; omitting both implies length=0
:createbooleanWhether to create nonexistent files.No; default true
:fileFileThe name of the file.Unless a nested resource collection element has been specified
:lengthLongSpecifies the new file length (in bytes) to set. The following suffixes are supported: K: Kilobytes (1024 bytes) M: Megabytes (1024 K) G: Gigabytes (1024 M) T: Terabytes (1024 G) P: Petabytes (1024 T)At most one of these; omitting both implies length=0
:mkdirsbooleanWhether to create nonexistent parent directories when creating new files.No; default false

Reference

https://ant.apache.org/manual/Tasks/truncate.html

Defined by

org.apache.tools.ant.taskdefs.Truncate

Set the length of one or more files, as the truncate Unix function or GNU utility. In
addition to working with a single file, this Task can also work on resources and
resource collections.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:adjust` | `Long` | Specifies the number of bytes (and positive/negative direction) by which to adjust file lengths. The same suffixes are supported for this attribute as for the length attribute. | At most one of these; omitting both implies length=0 |
| `:create` | `boolean` | Whether to create nonexistent files. | No; default true |
| `:file` | `File` | The name of the file. | Unless a nested resource collection element has been specified |
| `:length` | `Long` | Specifies the new file length (in bytes) to set. The following suffixes are supported: K: Kilobytes (1024 bytes) M: Megabytes (1024 K) G: Gigabytes (1024 M) T: Terabytes (1024 G) P: Petabytes (1024 T) | At most one of these; omitting both implies length=0 |
| `:mkdirs` | `boolean` | Whether to create nonexistent parent directories when creating new files. | No; default false |

**Reference**

https://ant.apache.org/manual/Tasks/truncate.html

**Defined by**

`org.apache.tools.ant.taskdefs.Truncate`
sourceraw docstring

tstampclj

(tstamp & args)

Sets the DSTAMP, TSTAMP, and TODAY properties in the current project. By default, the DSTAMP property is in the format yyyyMMdd, TSTAMP is in the format HHmm, and TODAY is in the format MMMM d yyyy. Use the nested <format> element to specify a different format. These properties can be used in the build file, for instance, to create timestamped filenames, or used to replace placeholder tags inside documents to indicate, for example, the release date. The best place for this task is probably in an initialization target. Since Ant 1.10.2 the magic property ant.tstamp.now can be used to specify a fixed date value in order to create reproducible builds. Its value must be a number and is interpreted as seconds since the epoch (midnight 1970-01-01). With ant.tstamp.now.iso you could also specify that value in ISO-8601 format (1972-04-17T08:07:00Z). If you specify a value in an invalid format an INFO message will be logged and the value will be ignored. Since Ant 1.10.8 the SOURCE_DATE_EPOCH environment variable value (if set) will be honoured for reproducible builds. Ant will log a DEBUG message if an invalid value (value that cannot be parsed to an integer), is specified for that environment variable and will instead use the "current" date.

Attributes

AttributeTypeDescriptionRequired
:prefixStringPrefix used for all properties set.No; default is no prefix

Nested elements

  • :format (CustomFormat)

Reference

https://ant.apache.org/manual/Tasks/tstamp.html

Defined by

org.apache.tools.ant.taskdefs.Tstamp

Sets the DSTAMP, TSTAMP, and TODAY properties in the current project. By default, the
DSTAMP property is in the format yyyyMMdd, TSTAMP is in the format HHmm, and TODAY is in
the format MMMM d yyyy. Use the nested <format> element to specify a different format.
These properties can be used in the build file, for instance, to create timestamped
filenames, or used to replace placeholder tags inside documents to indicate, for
example, the release date. The best place for this task is probably in an initialization
target. Since Ant 1.10.2 the magic property ant.tstamp.now can be used to specify a
fixed date value in order to create reproducible builds. Its value must be a number and
is interpreted as seconds since the epoch (midnight 1970-01-01). With ant.tstamp.now.iso
you could also specify that value in ISO-8601 format (1972-04-17T08:07:00Z). If you
specify a value in an invalid format an INFO message will be logged and the value will
be ignored. Since Ant 1.10.8 the SOURCE_DATE_EPOCH environment variable value (if set)
will be honoured for reproducible builds. Ant will log a DEBUG message if an invalid
value (value that cannot be parsed to an integer), is specified for that environment
variable and will instead use the "current" date.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:prefix` | `String` | Prefix used for all properties set. | No; default is no prefix |

**Nested elements**

- `:format` (`CustomFormat`)

**Reference**

https://ant.apache.org/manual/Tasks/tstamp.html

**Defined by**

`org.apache.tools.ant.taskdefs.Tstamp`
sourceraw docstring

typeclj

(type & args)

Ant nested type. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:errorString
:refidReference
:typeFileType

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.TypeSelector

Ant nested type. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:error` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:type` | `FileType` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.TypeSelector`
sourceraw docstring

typedefclj

(typedef & args)

Adds a task or a data type definition to the current project such that this new type or task can be used in the current project. A Task is any class that extends org.apache.tools.ant.Task or can be adapted as a Task using an adapter class. Data types are things like paths or filesets that can be defined at the project level and referenced via their id attribute. Custom data types usually need custom tasks to put them to good use. Two attributes are needed to make a definition: the name that identifies this data type uniquely, and the full name of the class (including its package name) that implements this type. You can also define a group of definitions at once using the file or resource attributes. These attributes point to files in the format of Java property files or an xml format. For property files each line defines a single data type in the format: typename=fully.qualified.java.classname The xml format is described in the Antlib section. If you are defining tasks or types that share the same classpath with multiple taskdef or typedef tasks, the corresponding classes will be loaded by different Java ClassLoaders. Two classes with the same name loaded via different ClassLoaders are not the same class from the point of view of JVM, they don't share static variables and instances of these classes can't access private methods or attributes of instances defined by "the other class" of the same name. They don't even belong to the same Java package and can't access package private code, either. The best way to load several tasks/types that are supposed to cooperate with each other via shared Java code is to use the resource attribute and an antlib descriptor. If this is not possible, the second best option is to use the loaderref attribute and specify the same name for each and every typedef/taskdef-this way the classes will share the same ClassLoader. Note that the typedef/taskdef tasks must use identical classpath definitions (this includes the order of path components) for the loaderref attribute to work.

Attributes

AttributeTypeDescriptionRequired
:adapterStringA class that is used to adapt the defined class to another interface/class. The adapter class must implement the interface org.apache.tools.ant.TypeAdapter. The adapter class will be used to wrap the defined class unless the defined class implements/extends the class defined by the attribute adaptto. If adaptto is not set, the defined class will always be wrapped. Since Ant 1.6No
:adapttoStringThis attribute is used in conjunction with the adapter attribute. If the defined class does not implement/extend the interface/class specified by this attribute, the adaptor class will be used to wrap the class. Since Ant 1.6No
:antlibString
:classnameStringthe full class name implementing the data typeYes, unless file or resource attributes have been specified.
:classpathPaththe classpath to use when looking up classname.No
:classpathrefReferencea reference to a classpath to use when looking up classname.No
:fileFileName of the file to load definitions from.No
:formatFormatThe format of the file or resource. The values are properties" or xml. If the value is properties the file/resource is a property file contains name-classname pairs. If the value is xml, the file/resource is an XML file/resource structured according to Antlib. The default is properties unless the file/resource name ends with .xml, in which case the format attribute will have the value xml. Since Ant 1.6No
:loaderrefReferencethe name of the loader that is used to load the class, constructed from the specified classpath. Use this to allow multiple tasks/types to be loaded with the same loader, so they can call each other. Since Ant 1.5No
:nameStringthe name of the data typeYes, unless file or resource attributes have been specified.
:onerrorOnErrorThe action to take if there was a failure in defining the type. The values are fail: cause a build exception; report: output a warning, but continue; ignore: do nothing. Since Ant 1.6, an additional value is failall: cause all behavior of fail, as well as a build exception for the resource or file attribute if the resource or file is not found.No; default is fail (since Ant 1.7)
:resourceStringName of the resource to load definitions from. If multiple resources by this name are found along the classpath, and format is properties, the first resource will be loaded; otherwise all such resources will be loaded.No
:reverseloaderboolean
:uriStringThe uri that this definition should live in. Since Ant 1.6No

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/typedef.html

Defined by

org.apache.tools.ant.taskdefs.Typedef

Adds a task or a data type definition to the current project such that this new type or
task can be used in the current project. A Task is any class that extends
org.apache.tools.ant.Task or can be adapted as a Task using an adapter class. Data types
are things like paths or filesets that can be defined at the project level and
referenced via their id attribute. Custom data types usually need custom tasks to put
them to good use. Two attributes are needed to make a definition: the name that
identifies this data type uniquely, and the full name of the class (including its
package name) that implements this type. You can also define a group of definitions at
once using the file or resource attributes. These attributes point to files in the
format of Java property files or an xml format. For property files each line defines a
single data type in the format: typename=fully.qualified.java.classname The xml format
is described in the Antlib section. If you are defining tasks or types that share the
same classpath with multiple taskdef or typedef tasks, the corresponding classes will be
loaded by different Java ClassLoaders. Two classes with the same name loaded via
different ClassLoaders are not the same class from the point of view of JVM, they don't
share static variables and instances of these classes can't access private methods or
attributes of instances defined by "the other class" of the same name. They don't even
belong to the same Java package and can't access package private code, either. The best
way to load several tasks/types that are supposed to cooperate with each other via
shared Java code is to use the resource attribute and an antlib descriptor. If this is
not possible, the second best option is to use the loaderref attribute and specify the
same name for each and every typedef/taskdef-this way the classes will share the same
ClassLoader. Note that the typedef/taskdef tasks must use identical classpath
definitions (this includes the order of path components) for the loaderref attribute to
work.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:adapter` | `String` | A class that is used to adapt the defined class to another interface/class. The adapter class must implement the interface org.apache.tools.ant.TypeAdapter. The adapter class will be used to wrap the defined class unless the defined class implements/extends the class defined by the attribute adaptto. If adaptto is not set, the defined class will always be wrapped. Since Ant 1.6 | No |
| `:adaptto` | `String` | This attribute is used in conjunction with the adapter attribute. If the defined class does not implement/extend the interface/class specified by this attribute, the adaptor class will be used to wrap the class. Since Ant 1.6 | No |
| `:antlib` | `String` |  |  |
| `:classname` | `String` | the full class name implementing the data type | Yes, unless file or resource attributes have been specified. |
| `:classpath` | `Path` | the classpath to use when looking up classname. | No |
| `:classpathref` | `Reference` | a reference to a classpath to use when looking up classname. | No |
| `:file` | `File` | Name of the file to load definitions from. | No |
| `:format` | `Format` | The format of the file or resource. The values are properties" or xml. If the value is properties the file/resource is a property file contains name-classname pairs. If the value is xml, the file/resource is an XML file/resource structured according to Antlib. The default is properties unless the file/resource name ends with .xml, in which case the format attribute will have the value xml. Since Ant 1.6 | No |
| `:loaderref` | `Reference` | the name of the loader that is used to load the class, constructed from the specified classpath. Use this to allow multiple tasks/types to be loaded with the same loader, so they can call each other. Since Ant 1.5 | No |
| `:name` | `String` | the name of the data type | Yes, unless file or resource attributes have been specified. |
| `:onerror` | `OnError` | The action to take if there was a failure in defining the type. The values are fail: cause a build exception; report: output a warning, but continue; ignore: do nothing. Since Ant 1.6, an additional value is failall: cause all behavior of fail, as well as a build exception for the resource or file attribute if the resource or file is not found. | No; default is fail (since Ant 1.7) |
| `:resource` | `String` | Name of the resource to load definitions from. If multiple resources by this name are found along the classpath, and format is properties, the first resource will be loaded; otherwise all such resources will be loaded. | No |
| `:reverseloader` | `boolean` |  |  |
| `:uri` | `String` | The uri that this definition should live in. Since Ant 1.6 | No |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/typedef.html

**Defined by**

`org.apache.tools.ant.taskdefs.Typedef`
sourceraw docstring

unionclj

(union & args)

Ant type union. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

https://ant.apache.org/manual/Types/union.html

Defined by

org.apache.tools.ant.types.resources.Union

Ant type union. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

https://ant.apache.org/manual/Types/union.html

**Defined by**

`org.apache.tools.ant.types.resources.Union`
sourceraw docstring

unjarclj

(unjar & args)

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from the archive. If no patternset is used, all files are extracted. resource collections may be used to select archived files to perform unarchival upon. Only file system based resource collections are supported by Unjar/Unwar/Unzip, this includes fileset, filelist, path, and files. Untar supports arbitrary resource collections. Prior to Apache Ant 1.7 only fileset has been supported as a nested element. You can define filename transformations by using a nested mapper element. The default mapper is the identity mapper. File permissions will not be restored on extracted files. The untar task recognizes the long pathname entries used by GNU tar. Please note that different ZIP tools handle timestamps differently when it comes to applying timezone offset calculations of files. Some ZIP libraries will store the timestamps as they've been read from the filesystem while others will modify the timestamps both when reading and writing the files to make all timestamps use the same timezone. A ZIP archive created by one library may extract files with "wrong timestamps" when extracted by another library. Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get adjusted), Windows' "compressed folders" function and WinZIP don't change the timestamps. This means that using the unzip task on files created by Windows' compressed folders function may create files with timestamps that are "wrong", the same is true if you use Windows' functions to extract an Ant generated ZIP archive.

Attributes

AttributeTypeDescriptionRequired
:allowfilestoescapedestbooleanWhether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec.
:destFiledirectory where to store the expanded files.Yes
:encodingStringThe character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task pageNo; defaults to UTF8 for unzip and default JVM character encoding for untar task
:failonemptyarchivebooleanwhether trying to extract an empty archive is an error. since Ant 1.8.0No; defaults to false
:overwritebooleanOverwrite files, even if they are newer than the corresponding entries in the archive (true|false).No; default is true
:scanforunicodeextrafieldsbooleanNote: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task pageNo; defaults to true
:srcFilearchive file to expand.Yes, unless filesets are used
:stripabsolutepathspecbooleanwhether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0No; defaults to true since Ant 1.10.4 (used to default to false prior to that)

Nested elements

  • :fileset (FileSet)
  • :mapper (Mapper)
  • :patternset (PatternSet)

Reference

https://ant.apache.org/manual/Tasks/unzip.html

Defined by

org.apache.tools.ant.taskdefs.Expand

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from
the archive. If no patternset is used, all files are extracted. resource collections may
be used to select archived files to perform unarchival upon. Only file system based
resource collections are supported by Unjar/Unwar/Unzip, this includes fileset,
filelist, path, and files. Untar supports arbitrary resource collections. Prior to
Apache Ant 1.7 only fileset has been supported as a nested element. You can define
filename transformations by using a nested mapper element. The default mapper is the
identity mapper. File permissions will not be restored on extracted files. The untar
task recognizes the long pathname entries used by GNU tar. Please note that different
ZIP tools handle timestamps differently when it comes to applying timezone offset
calculations of files. Some ZIP libraries will store the timestamps as they've been read
from the filesystem while others will modify the timestamps both when reading and
writing the files to make all timestamps use the same timezone. A ZIP archive created by
one library may extract files with "wrong timestamps" when extracted by another library.
Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get
adjusted), Windows' "compressed folders" function and WinZIP don't change the
timestamps. This means that using the unzip task on files created by Windows' compressed
folders function may create files with timestamps that are "wrong", the same is true if
you use Windows' functions to extract an Ant generated ZIP archive.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:allowfilestoescapedest` | `boolean` | Whether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4 | No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec. |
| `:dest` | `File` | directory where to store the expanded files. | Yes |
| `:encoding` | `String` | The character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task page | No; defaults to UTF8 for unzip and default JVM character encoding for untar task |
| `:failonemptyarchive` | `boolean` | whether trying to extract an empty archive is an error. since Ant 1.8.0 | No; defaults to false |
| `:overwrite` | `boolean` | Overwrite files, even if they are newer than the corresponding entries in the archive (true\|false). | No; default is true |
| `:scanforunicodeextrafields` | `boolean` | Note: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task page | No; defaults to true |
| `:src` | `File` | archive file to expand. | Yes, unless filesets are used |
| `:stripabsolutepathspec` | `boolean` | whether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0 | No; defaults to true since Ant 1.10.4 (used to default to false prior to that) |

**Nested elements**

- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:patternset` (`PatternSet`)

**Reference**

https://ant.apache.org/manual/Tasks/unzip.html

**Defined by**

`org.apache.tools.ant.taskdefs.Expand`
sourceraw docstring

unpackagemapperclj

(unpackagemapper & args)

Ant type unpackagemapper. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:fromString
:handledirsepboolean
:toString

Reference

https://ant.apache.org/manual/Types/unpackagemapper.html

Defined by

org.apache.tools.ant.util.UnPackageNameMapper

Ant type unpackagemapper. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:from` | `String` |  |  |
| `:handledirsep` | `boolean` |  |  |
| `:to` | `String` |  |  |

**Reference**

https://ant.apache.org/manual/Types/unpackagemapper.html

**Defined by**

`org.apache.tools.ant.util.UnPackageNameMapper`
sourceraw docstring

untarclj

(untar & args)

Untars a tarfile. This document has moved here

Attributes

AttributeTypeDescriptionRequired
:allowfilestoescapedestboolean
:compressionUntarCompressionMethod
:destFile
:encodingString
:failonemptyarchiveboolean
:overwriteboolean
:scanforunicodeextrafieldsboolean
:srcFile
:stripabsolutepathspecboolean

Nested elements

  • :fileset (FileSet)
  • :mapper (Mapper)
  • :patternset (PatternSet)

Reference

https://ant.apache.org/manual/Tasks/untar.html

Defined by

org.apache.tools.ant.taskdefs.Untar

Untars a tarfile. This document has moved here

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:allowfilestoescapedest` | `boolean` |  |  |
| `:compression` | `UntarCompressionMethod` |  |  |
| `:dest` | `File` |  |  |
| `:encoding` | `String` |  |  |
| `:failonemptyarchive` | `boolean` |  |  |
| `:overwrite` | `boolean` |  |  |
| `:scanforunicodeextrafields` | `boolean` |  |  |
| `:src` | `File` |  |  |
| `:stripabsolutepathspec` | `boolean` |  |  |

**Nested elements**

- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:patternset` (`PatternSet`)

**Reference**

https://ant.apache.org/manual/Tasks/untar.html

**Defined by**

`org.apache.tools.ant.taskdefs.Untar`
sourceraw docstring

unwarclj

(unwar & args)

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from the archive. If no patternset is used, all files are extracted. resource collections may be used to select archived files to perform unarchival upon. Only file system based resource collections are supported by Unjar/Unwar/Unzip, this includes fileset, filelist, path, and files. Untar supports arbitrary resource collections. Prior to Apache Ant 1.7 only fileset has been supported as a nested element. You can define filename transformations by using a nested mapper element. The default mapper is the identity mapper. File permissions will not be restored on extracted files. The untar task recognizes the long pathname entries used by GNU tar. Please note that different ZIP tools handle timestamps differently when it comes to applying timezone offset calculations of files. Some ZIP libraries will store the timestamps as they've been read from the filesystem while others will modify the timestamps both when reading and writing the files to make all timestamps use the same timezone. A ZIP archive created by one library may extract files with "wrong timestamps" when extracted by another library. Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get adjusted), Windows' "compressed folders" function and WinZIP don't change the timestamps. This means that using the unzip task on files created by Windows' compressed folders function may create files with timestamps that are "wrong", the same is true if you use Windows' functions to extract an Ant generated ZIP archive.

Attributes

AttributeTypeDescriptionRequired
:allowfilestoescapedestbooleanWhether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec.
:destFiledirectory where to store the expanded files.Yes
:encodingStringThe character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task pageNo; defaults to UTF8 for unzip and default JVM character encoding for untar task
:failonemptyarchivebooleanwhether trying to extract an empty archive is an error. since Ant 1.8.0No; defaults to false
:overwritebooleanOverwrite files, even if they are newer than the corresponding entries in the archive (true|false).No; default is true
:scanforunicodeextrafieldsbooleanNote: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task pageNo; defaults to true
:srcFilearchive file to expand.Yes, unless filesets are used
:stripabsolutepathspecbooleanwhether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0No; defaults to true since Ant 1.10.4 (used to default to false prior to that)

Nested elements

  • :fileset (FileSet)
  • :mapper (Mapper)
  • :patternset (PatternSet)

Reference

https://ant.apache.org/manual/Tasks/unzip.html

Defined by

org.apache.tools.ant.taskdefs.Expand

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from
the archive. If no patternset is used, all files are extracted. resource collections may
be used to select archived files to perform unarchival upon. Only file system based
resource collections are supported by Unjar/Unwar/Unzip, this includes fileset,
filelist, path, and files. Untar supports arbitrary resource collections. Prior to
Apache Ant 1.7 only fileset has been supported as a nested element. You can define
filename transformations by using a nested mapper element. The default mapper is the
identity mapper. File permissions will not be restored on extracted files. The untar
task recognizes the long pathname entries used by GNU tar. Please note that different
ZIP tools handle timestamps differently when it comes to applying timezone offset
calculations of files. Some ZIP libraries will store the timestamps as they've been read
from the filesystem while others will modify the timestamps both when reading and
writing the files to make all timestamps use the same timezone. A ZIP archive created by
one library may extract files with "wrong timestamps" when extracted by another library.
Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get
adjusted), Windows' "compressed folders" function and WinZIP don't change the
timestamps. This means that using the unzip task on files created by Windows' compressed
folders function may create files with timestamps that are "wrong", the same is true if
you use Windows' functions to extract an Ant generated ZIP archive.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:allowfilestoescapedest` | `boolean` | Whether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4 | No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec. |
| `:dest` | `File` | directory where to store the expanded files. | Yes |
| `:encoding` | `String` | The character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task page | No; defaults to UTF8 for unzip and default JVM character encoding for untar task |
| `:failonemptyarchive` | `boolean` | whether trying to extract an empty archive is an error. since Ant 1.8.0 | No; defaults to false |
| `:overwrite` | `boolean` | Overwrite files, even if they are newer than the corresponding entries in the archive (true\|false). | No; default is true |
| `:scanforunicodeextrafields` | `boolean` | Note: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task page | No; defaults to true |
| `:src` | `File` | archive file to expand. | Yes, unless filesets are used |
| `:stripabsolutepathspec` | `boolean` | whether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0 | No; defaults to true since Ant 1.10.4 (used to default to false prior to that) |

**Nested elements**

- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:patternset` (`PatternSet`)

**Reference**

https://ant.apache.org/manual/Tasks/unzip.html

**Defined by**

`org.apache.tools.ant.taskdefs.Expand`
sourceraw docstring

unzipclj

(unzip & args)

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from the archive. If no patternset is used, all files are extracted. resource collections may be used to select archived files to perform unarchival upon. Only file system based resource collections are supported by Unjar/Unwar/Unzip, this includes fileset, filelist, path, and files. Untar supports arbitrary resource collections. Prior to Apache Ant 1.7 only fileset has been supported as a nested element. You can define filename transformations by using a nested mapper element. The default mapper is the identity mapper. File permissions will not be restored on extracted files. The untar task recognizes the long pathname entries used by GNU tar. Please note that different ZIP tools handle timestamps differently when it comes to applying timezone offset calculations of files. Some ZIP libraries will store the timestamps as they've been read from the filesystem while others will modify the timestamps both when reading and writing the files to make all timestamps use the same timezone. A ZIP archive created by one library may extract files with "wrong timestamps" when extracted by another library. Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get adjusted), Windows' "compressed folders" function and WinZIP don't change the timestamps. This means that using the unzip task on files created by Windows' compressed folders function may create files with timestamps that are "wrong", the same is true if you use Windows' functions to extract an Ant generated ZIP archive.

Attributes

AttributeTypeDescriptionRequired
:allowfilestoescapedestbooleanWhether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec.
:destFiledirectory where to store the expanded files.Yes
:encodingStringThe character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task pageNo; defaults to UTF8 for unzip and default JVM character encoding for untar task
:failonemptyarchivebooleanwhether trying to extract an empty archive is an error. since Ant 1.8.0No; defaults to false
:overwritebooleanOverwrite files, even if they are newer than the corresponding entries in the archive (true|false).No; default is true
:scanforunicodeextrafieldsbooleanNote: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task pageNo; defaults to true
:srcFilearchive file to expand.Yes, unless filesets are used
:stripabsolutepathspecbooleanwhether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0No; defaults to true since Ant 1.10.4 (used to default to false prior to that)

Nested elements

  • :fileset (FileSet)
  • :mapper (Mapper)
  • :patternset (PatternSet)

Reference

https://ant.apache.org/manual/Tasks/unzip.html

Defined by

org.apache.tools.ant.taskdefs.Expand

Unzips a zip-, war-, or jar file. PatternSets are used to select files to extract from
the archive. If no patternset is used, all files are extracted. resource collections may
be used to select archived files to perform unarchival upon. Only file system based
resource collections are supported by Unjar/Unwar/Unzip, this includes fileset,
filelist, path, and files. Untar supports arbitrary resource collections. Prior to
Apache Ant 1.7 only fileset has been supported as a nested element. You can define
filename transformations by using a nested mapper element. The default mapper is the
identity mapper. File permissions will not be restored on extracted files. The untar
task recognizes the long pathname entries used by GNU tar. Please note that different
ZIP tools handle timestamps differently when it comes to applying timezone offset
calculations of files. Some ZIP libraries will store the timestamps as they've been read
from the filesystem while others will modify the timestamps both when reading and
writing the files to make all timestamps use the same timezone. A ZIP archive created by
one library may extract files with "wrong timestamps" when extracted by another library.
Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get
adjusted), Windows' "compressed folders" function and WinZIP don't change the
timestamps. This means that using the unzip task on files created by Windows' compressed
folders function may create files with timestamps that are "wrong", the same is true if
you use Windows' functions to extract an Ant generated ZIP archive.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:allowfilestoescapedest` | `boolean` | Whether to allow the extracted file or directory to be outside of the dest directory. since Ant 1.10.4 | No, defaults to false unless stripAbsolutePathSpec is false and the entry's name starts with a leading path spec. |
| `:dest` | `File` | directory where to store the expanded files. | Yes |
| `:encoding` | `String` | The character encoding that has been used for filenames inside the zip file. For a list of possible values see the Supported Encodings. Use the magic value native-encoding for default JVM character encoding. See also the discussion in the zip task page | No; defaults to UTF8 for unzip and default JVM character encoding for untar task |
| `:failonemptyarchive` | `boolean` | whether trying to extract an empty archive is an error. since Ant 1.8.0 | No; defaults to false |
| `:overwrite` | `boolean` | Overwrite files, even if they are newer than the corresponding entries in the archive (true\|false). | No; default is true |
| `:scanforunicodeextrafields` | `boolean` | Note: This attribute is not available for the untar task. If the archive contains Unicode extra fields then use them to set the file names, ignoring the specified encoding. See also the discussion in the zip task page | No; defaults to true |
| `:src` | `File` | archive file to expand. | Yes, unless filesets are used |
| `:stripabsolutepathspec` | `boolean` | whether Ant should remove leading / or \ characters from the extracted file name before extracting it. Note that this changes the entry name before applying include/exclude patterns and before using the nested mappers (if any). since Ant 1.8.0 | No; defaults to true since Ant 1.10.4 (used to default to false prior to that) |

**Nested elements**

- `:fileset` (`FileSet`)
- `:mapper` (`Mapper`)
- `:patternset` (`PatternSet`)

**Reference**

https://ant.apache.org/manual/Tasks/unzip.html

**Defined by**

`org.apache.tools.ant.taskdefs.Expand`
sourceraw docstring

upgrademodulepathclj

(upgrademodulepath & args)

Ant nested upgrademodulepath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested upgrademodulepath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

uptodateclj

(uptodate & args)

Sets a property if a target file or set of target files is more up-to-date than a source file or set of source files. A single source file is specified using the srcfile attribute. A set of source files is specified using the nested <srcfiles> elements. These are FileSets, whereas multiple target files are specified using a nested <mapper> element. By default, the value of the property is set to true if the timestamp of the source file(s) is not more recent than the timestamp of the corresponding target file(s). You can set the value to something other than the default by specifying the value attribute. If a <srcfiles> element is used, without also specifying a <mapper> element, the default behavior is to use a merge mapper, with the to attribute set to the value of the targetfile attribute. Normally, this task is used to set properties that are useful to avoid target execution depending on the relative age of the specified files.

Attributes

AttributeTypeDescriptionRequired
:propertyStringThe name of the property to set.Yes
:srcfileFileThe file to check against the target file(s).Yes, unless a nested <srcfiles> or <srcresources> element is present.
:targetfileFileThe file for which we want to determine the status.Yes, unless a nested <mapper> element is present.
:valueStringThe value to set the property to.No; defaults to true.

Nested elements

  • :mapper (Mapper)
  • :srcfiles (FileSet)
  • :srcresources (Union)

Reference

https://ant.apache.org/manual/Tasks/uptodate.html

Defined by

org.apache.tools.ant.taskdefs.UpToDate

Sets a property if a target file or set of target files is more up-to-date than a source
file or set of source files. A single source file is specified using the srcfile
attribute. A set of source files is specified using the nested <srcfiles> elements.
These are FileSets, whereas multiple target files are specified using a nested <mapper>
element. By default, the value of the property is set to true if the timestamp of the
source file(s) is not more recent than the timestamp of the corresponding target
file(s). You can set the value to something other than the default by specifying the
value attribute. If a <srcfiles> element is used, without also specifying a <mapper>
element, the default behavior is to use a merge mapper, with the to attribute set to the
value of the targetfile attribute. Normally, this task is used to set properties that
are useful to avoid target execution depending on the relative age of the specified
files.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:property` | `String` | The name of the property to set. | Yes |
| `:srcfile` | `File` | The file to check against the target file(s). | Yes, unless a nested <srcfiles> or <srcresources> element is present. |
| `:targetfile` | `File` | The file for which we want to determine the status. | Yes, unless a nested <mapper> element is present. |
| `:value` | `String` | The value to set the property to. | No; defaults to true. |

**Nested elements**

- `:mapper` (`Mapper`)
- `:srcfiles` (`FileSet`)
- `:srcresources` (`Union`)

**Reference**

https://ant.apache.org/manual/Tasks/uptodate.html

**Defined by**

`org.apache.tools.ant.taskdefs.UpToDate`
sourceraw docstring

urlclj

(url & args)

Ant type url. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:baseurlURL
:directoryboolean
:existsboolean
:fileFile
:lastmodifiedlong
:nameString
:refidReference
:relativepathString
:sizelong
:urlURL

Reference

https://ant.apache.org/manual/Types/url.html

Defined by

org.apache.tools.ant.types.resources.URLResource

Ant type url. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:baseurl` | `URL` |  |  |
| `:directory` | `boolean` |  |  |
| `:exists` | `boolean` |  |  |
| `:file` | `File` |  |  |
| `:lastmodified` | `long` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:relativepath` | `String` |  |  |
| `:size` | `long` |  |  |
| `:url` | `URL` |  |  |

**Reference**

https://ant.apache.org/manual/Types/url.html

**Defined by**

`org.apache.tools.ant.types.resources.URLResource`
sourceraw docstring

userclj

(user & args)

Ant nested user. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:displaynameString
:useridString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.cvslib.CvsUser

Ant nested user. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:displayname` | `String` |  |  |
| `:userid` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.cvslib.CvsUser`
sourceraw docstring

verifyjarclj

(verifyjar & args)

Verifies JAR files with the jarsigner command line tool. It will take a named file in the jar attribute. Nested paths are also supported.

Attributes

AttributeTypeDescriptionRequired
:aliasStringthe alias to verify underYes
:certificatesboolean(true|false) display information about certificatesNo; default false
:executableStringSpecify a particular jarsigner executable to use in place of the default binary (found in the same JDK as Apache Ant is running in). Must support the same command line options as the Sun JDK jarsigner command. since Ant 1.8.0.No
:jarFilethe jar file to verifyYes, unless nested paths have been used
:keypassStringpassword for private key (if different)No
:keystoreStringkeystore locationNo
:maxmemoryStringSpecifies the maximum memory the jarsigner JVM will use. Specified in the style of standard Java memory specs (e.g. 128m = 128 MBytes)No
:providerargStringRepresents an optional string input argument for the constructor of provider_class_name. Ignored if providerclass is not set. since Ant 1.10.6.No
:providerclassStringname of a cryptographic service provider's master class file when the service provider is not listed in the security properties file. since Ant 1.10.6.No
:providernameStringname of a cryptographic service provider's name when listed in the security properties file. since Ant 1.10.6.No
:storepassStringpassword for keystore integrity. Note that jarsigner does not read the password from stdin during verification, so the password must be send via a command line interface and may be visible to other users of the system.No
:storetypeStringkeystore typeNo
:strictboolean(true|false) strict checking when verifying. since Ant 1.9.1.No; default false
:verboseboolean(true|false) verbose output when verifyingNo; default false

Nested elements

  • :arg (Argument)
  • :fileset (FileSet)
  • :path (Path)
  • :sysproperty (Variable)

Reference

https://ant.apache.org/manual/Tasks/verifyjar.html

Defined by

org.apache.tools.ant.taskdefs.VerifyJar

Verifies JAR files with the jarsigner command line tool. It will take a named file in
the jar attribute. Nested paths are also supported.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:alias` | `String` | the alias to verify under | Yes |
| `:certificates` | `boolean` | (true\|false) display information about certificates | No; default false |
| `:executable` | `String` | Specify a particular jarsigner executable to use in place of the default binary (found in the same JDK as Apache Ant is running in). Must support the same command line options as the Sun JDK jarsigner command. since Ant 1.8.0. | No |
| `:jar` | `File` | the jar file to verify | Yes, unless nested paths have been used |
| `:keypass` | `String` | password for private key (if different) | No |
| `:keystore` | `String` | keystore location | No |
| `:maxmemory` | `String` | Specifies the maximum memory the jarsigner JVM will use. Specified in the style of standard Java memory specs (e.g. 128m = 128 MBytes) | No |
| `:providerarg` | `String` | Represents an optional string input argument for the constructor of provider_class_name. Ignored if providerclass is not set. since Ant 1.10.6. | No |
| `:providerclass` | `String` | name of a cryptographic service provider's master class file when the service provider is not listed in the security properties file. since Ant 1.10.6. | No |
| `:providername` | `String` | name of a cryptographic service provider's name when listed in the security properties file. since Ant 1.10.6. | No |
| `:storepass` | `String` | password for keystore integrity. Note that jarsigner does not read the password from stdin during verification, so the password must be send via a command line interface and may be visible to other users of the system. | No |
| `:storetype` | `String` | keystore type | No |
| `:strict` | `boolean` | (true\|false) strict checking when verifying. since Ant 1.9.1. | No; default false |
| `:verbose` | `boolean` | (true\|false) verbose output when verifying | No; default false |

**Nested elements**

- `:arg` (`Argument`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:sysproperty` (`Variable`)

**Reference**

https://ant.apache.org/manual/Tasks/verifyjar.html

**Defined by**

`org.apache.tools.ant.taskdefs.VerifyJar`
sourceraw docstring

versionclj

(version & args)

Ant nested version. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:buildString
:numberString
:prereleaseString

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ModuleVersion

Ant nested version. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:build` | `String` |  |  |
| `:number` | `String` |  |  |
| `:prerelease` | `String` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ModuleVersion`
sourceraw docstring

vssaddclj

(vssadd & args)

Task to perform ADD commands to Microsoft Visual SourceSafe.

Attributes

AttributeTypeDescriptionRequired
:autoresponseStringY, N or empty. Specify how to reply to questions from VSS.No
:commentStringComment to use for the files that where checked in.No
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100.No; defaults to true
:localpathPathSpecify the local file(s) to add to VSSYes
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:recursivebooleantrue|falseNo
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:vsspathString
:writablebooleantrue|falseNo

Reference

https://ant.apache.org/manual/Tasks/vss.html#vssadd

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD

Task to perform ADD commands to Microsoft Visual SourceSafe.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` | Y, N or empty. Specify how to reply to questions from VSS. | No |
| `:comment` | `String` | Comment to use for the files that where checked in. | No |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100. | No; defaults to true |
| `:localpath` | `Path` | Specify the local file(s) to add to VSS | Yes |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:recursive` | `boolean` | true\|false | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:vsspath` | `String` |  |  |
| `:writable` | `boolean` | true\|false | No |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vssadd

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD`
sourceraw docstring

vsscheckinclj

(vsscheckin & args)

Task to perform CHECKIN commands to Microsoft Visual SourceSafe.

Attributes

AttributeTypeDescriptionRequired
:autoresponseStringY, N or empty. Specify how to reply to questions from VSS.No
:commentStringComment to use for the files that where checked in.No
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100.No; defaults to true
:localpathPathOverride the working directory and get to the specified pathNo
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:recursivebooleantrue|falseNo
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:vsspathStringSourceSafe path which specifies the project/file(s) you wish to perform the action on.Yes
:writablebooleantrue|falseNo

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsscheckin

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN

Task to perform CHECKIN commands to Microsoft Visual SourceSafe.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` | Y, N or empty. Specify how to reply to questions from VSS. | No |
| `:comment` | `String` | Comment to use for the files that where checked in. | No |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100. | No; defaults to true |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:recursive` | `boolean` | true\|false | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:vsspath` | `String` | SourceSafe path which specifies the project/file(s) you wish to perform the action on. | Yes |
| `:writable` | `boolean` | true\|false | No |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsscheckin

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN`
sourceraw docstring

vsscheckoutclj

(vsscheckout & args)

Task to perform CHECKOUT commands to Microsoft Visual SourceSafe. If you specify two or more attributes from version, date and label only one will be used in the order version, date, label.

Attributes

AttributeTypeDescriptionRequired
:autoresponseString
:dateStringa date stamp to get atNo; only one of these may be used
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100.No; defaults to true
:filetimestampCurrentModUpdatedSet the behavior for timestamps of local files. Valid options are current, modified, or updated.No; defaults to current
:getlocalcopybooleanSet the behavior to retrieve local copies of the files.No; defaults to true
:labelStringa label to get forNo; only one of these may be used
:localpathPathOverride the working directory and get to the specified pathNo
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:recursivebooleantrue|falseNo
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:versionStringa version number to getNo; only one of these may be used
:vsspathStringSourceSafe path which specifies the project/file(s) you wish to perform the action on.Yes
:writablefilesWritableFilesBehavior when local files are writable. Valid options are: replace, skip and fail; skip implies failonerror=falseNo; defaults to fail

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsscheckout

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT

Task to perform CHECKOUT commands to Microsoft Visual SourceSafe. If you specify two or
more attributes from version, date and label only one will be used in the order version,
date, label.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` |  |  |
| `:date` | `String` | a date stamp to get at | No; only one of these may be used |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100. | No; defaults to true |
| `:filetimestamp` | `CurrentModUpdated` | Set the behavior for timestamps of local files. Valid options are current, modified, or updated. | No; defaults to current |
| `:getlocalcopy` | `boolean` | Set the behavior to retrieve local copies of the files. | No; defaults to true |
| `:label` | `String` | a label to get for | No; only one of these may be used |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:recursive` | `boolean` | true\|false | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:version` | `String` | a version number to get | No; only one of these may be used |
| `:vsspath` | `String` | SourceSafe path which specifies the project/file(s) you wish to perform the action on. | Yes |
| `:writablefiles` | `WritableFiles` | Behavior when local files are writable. Valid options are: replace, skip and fail; skip implies failonerror=false | No; defaults to fail |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsscheckout

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT`
sourceraw docstring

vsscpclj

(vsscp & args)

Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe. This task is typically used before a VssAdd in order to set the target project

Attributes

AttributeTypeDescriptionRequired
:autoresponseString
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100.No; defaults to true
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:vsspathStringSourceSafe path which specifies the project you wish to make the current project.Yes

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsscp

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP

Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe. This task
is typically used before a VssAdd in order to set the target project

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` |  |  |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100. | No; defaults to true |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:vsspath` | `String` | SourceSafe path which specifies the project you wish to make the current project. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsscp

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP`
sourceraw docstring

vsscreateclj

(vsscreate & args)

Task to perform CREATE commands to Microsoft Visual Source Safe. Creates a new project in VSS.

Attributes

AttributeTypeDescriptionRequired
:autoresponseStringWhat to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.No
:commentStringThe comment to use for this label. Empty or - for no comment.No
:failonerrorbooleanfail if there is an error creating the project.No; defaults to true
:loginStringusername, passwordNo
:quietbooleansuppress outputNo; defaults to off
:serverpathString
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:vsspathStringSourceSafe path of project to be createdYes

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsscreate

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE

Task to perform CREATE commands to Microsoft Visual Source Safe. Creates a new project
in VSS.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` | What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this. | No |
| `:comment` | `String` | The comment to use for this label. Empty or - for no comment. | No |
| `:failonerror` | `boolean` | fail if there is an error creating the project. | No; defaults to true |
| `:login` | `String` | username, password | No |
| `:quiet` | `boolean` | suppress output | No; defaults to off |
| `:serverpath` | `String` |  |  |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:vsspath` | `String` | SourceSafe path of project to be created | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsscreate

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE`
sourceraw docstring

vssgetclj

(vssget & args)

Task to perform GET commands to Microsoft Visual SourceSafe. If you specify two or more attributes from version, date and label only one will be used in the order version, date, label.

Attributes

AttributeTypeDescriptionRequired
:autoresponseStringWhat to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.No
:dateStringa date stamp to get atNo; only one of these may be used
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100No; defaults to true
:filetimestampCurrentModUpdatedSet the behavior for timestamps of local files. Valid options are current, modified, or updated.No; defaults to current
:labelStringa label to get forNo; only one of these may be used
:localpathPathOverride the working directory and get to the specified pathNo
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:quietbooleansuppress outputNo; defaults to off
:recursivebooleantrue|false. Note however that in the SourceSafe UI there is a setting accessed via Tools/Options/GeneralTab called Act on projects recursively. If this setting is checked, then the recursive attribute is effectively ignored, and get will always be done recursivelyNo; default false
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:versionStringa version number to getNo; only one of these may be used
:vsspathStringSourceSafe path which specifies the project/file(s) you wish to perform the action on.Yes
:writablebooleantrue|falseNo; default false
:writablefilesWritableFilesBehavior when local files are writable. Valid options are: replace, skip and fail; skip implies failonerror=falseNo; defaults to fail

Reference

https://ant.apache.org/manual/Tasks/vss.html#vssget

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET

Task to perform GET commands to Microsoft Visual SourceSafe. If you specify two or more
attributes from version, date and label only one will be used in the order version,
date, label.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` | What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this. | No |
| `:date` | `String` | a date stamp to get at | No; only one of these may be used |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100 | No; defaults to true |
| `:filetimestamp` | `CurrentModUpdated` | Set the behavior for timestamps of local files. Valid options are current, modified, or updated. | No; defaults to current |
| `:label` | `String` | a label to get for | No; only one of these may be used |
| `:localpath` | `Path` | Override the working directory and get to the specified path | No |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:quiet` | `boolean` | suppress output | No; defaults to off |
| `:recursive` | `boolean` | true\|false. Note however that in the SourceSafe UI there is a setting accessed via Tools/Options/GeneralTab called Act on projects recursively. If this setting is checked, then the recursive attribute is effectively ignored, and get will always be done recursively | No; default false |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:version` | `String` | a version number to get | No; only one of these may be used |
| `:vsspath` | `String` | SourceSafe path which specifies the project/file(s) you wish to perform the action on. | Yes |
| `:writable` | `boolean` | true\|false | No; default false |
| `:writablefiles` | `WritableFiles` | Behavior when local files are writable. Valid options are: replace, skip and fail; skip implies failonerror=false | No; defaults to fail |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vssget

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET`
sourceraw docstring

vsshistoryclj

(vsshistory & args)

Task to perform HISTORY commands to Microsoft Visual SourceSafe.

Attributes

AttributeTypeDescriptionRequired
:dateformatStringFormat of dates in fromDate and toDate. Used when calculating dates with the numdays attribute. This string uses the formatting rules of SimpleDateFormat.No; defaults to DateFormat.SHORT
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100No; defaults to true
:fromdateStringStart date for comparisonSee below
:fromlabelStringStart label for comparisonNo
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:numdaysintThe number of days for comparison.See below
:outputFileFile to write the diff.No
:recursivebooleantrue|falseNo
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:styleBriefCodediffNofilebrief, codediff, default or nofile.No; defaults to default
:todateStringEnd date for comparisonSee below
:tolabelStringStart label for comparisonNo
:userStringName the user whose changes we would like to seeNo
:vsspathStringSourceSafe path which specifies the project/file(s) you wish to perform the action on.Yes

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsshistory

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY

Task to perform HISTORY commands to Microsoft Visual SourceSafe.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:dateformat` | `String` | Format of dates in fromDate and toDate. Used when calculating dates with the numdays attribute. This string uses the formatting rules of SimpleDateFormat. | No; defaults to DateFormat.SHORT |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100 | No; defaults to true |
| `:fromdate` | `String` | Start date for comparison | See below |
| `:fromlabel` | `String` | Start label for comparison | No |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:numdays` | `int` | The number of days for comparison. | See below |
| `:output` | `File` | File to write the diff. | No |
| `:recursive` | `boolean` | true\|false | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:style` | `BriefCodediffNofile` | brief, codediff, default or nofile. | No; defaults to default |
| `:todate` | `String` | End date for comparison | See below |
| `:tolabel` | `String` | Start label for comparison | No |
| `:user` | `String` | Name the user whose changes we would like to see | No |
| `:vsspath` | `String` | SourceSafe path which specifies the project/file(s) you wish to perform the action on. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsshistory

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY`
sourceraw docstring

vsslabelclj

(vsslabel & args)

Task to perform LABEL commands to Microsoft Visual SourceSafe. Assigns a label to the specified version or current version of a file or project.

Attributes

AttributeTypeDescriptionRequired
:autoresponseStringWhat to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.No
:commentStringThe comment to use for this label. Empty or - for no comment.No
:failonerrorbooleanStop the build process if ss.exe exits with a return code 100.No; defaults to true
:labelStringA label to apply to the hierarchyYes
:loginStringusername[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password.No
:serverpathStringdirectory where srcsafe.ini resides.No
:ssdirStringdirectory where ss.exe resides.No; by default expected to be in PATH
:versionStringAn existing file or project version to label. By default the current version is labeled.No
:vsspathStringSourceSafe path which specifies the project/file(s) you wish to perform the action on.Yes

Reference

https://ant.apache.org/manual/Tasks/vss.html#vsslabel

Defined by

org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL

Task to perform LABEL commands to Microsoft Visual SourceSafe. Assigns a label to the
specified version or current version of a file or project.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:autoresponse` | `String` | What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this. | No |
| `:comment` | `String` | The comment to use for this label. Empty or - for no comment. | No |
| `:failonerror` | `boolean` | Stop the build process if ss.exe exits with a return code 100. | No; defaults to true |
| `:label` | `String` | A label to apply to the hierarchy | Yes |
| `:login` | `String` | username[, password]-The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password)-Ant/VSS will hang if you leave the password out and VSS does not accept login without a password. | No |
| `:serverpath` | `String` | directory where srcsafe.ini resides. | No |
| `:ssdir` | `String` | directory where ss.exe resides. | No; by default expected to be in PATH |
| `:version` | `String` | An existing file or project version to label. By default the current version is labeled. | No |
| `:vsspath` | `String` | SourceSafe path which specifies the project/file(s) you wish to perform the action on. | Yes |

**Reference**

https://ant.apache.org/manual/Tasks/vss.html#vsslabel

**Defined by**

`org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL`
sourceraw docstring

waitforclj

(waitfor & args)

Blocks execution until a set of specified conditions become true. This is intended to be used with the parallel task to synchronize a set of processes. The conditions to wait for are defined in nested elements, if multiple conditions are specified, then the task will wait until all conditions are true. If both maxwait and maxwaitunit are not specified, default maxwait is 3 minutes (180000 milliseconds). If the timeoutproperty attribute has been set, a property of that name will be created if the condition didn't come true within the specified time.

Attributes

AttributeTypeDescriptionRequired
:checkeverylongThe amount of time to wait between each test of the conditions.No; defaults to 500 checkeveryunits
:checkeveryunitUnitThe unit of time that must be used to interpret the value of the checkevery attribute. Valid values are millisecond second minute hour day weekNo; defaults to millisecond
:maxwaitlongThe maximum amount of time to wait for all the required conditions to become true before failing the task.No; defaults to 180000 maxwaitunits
:maxwaitunitUnitThe unit of time that must be used to interpret the value of the maxwait attribute. Valid values are millisecond second minute hour day weekNo; defaults to millisecond
:timeoutpropertyStringthe name of the property to set if maxwait has been exceeded.No

Nested elements

  • :and (And)
  • :available (Available)
  • :checksum (Checksum)
  • :contains (Contains)
  • :equals (Equals)
  • :filesmatch (FilesMatch)
  • :http (Http)
  • :isfalse (IsFalse)
  • :isfileselected (IsFileSelected)
  • :isreference (IsReference)
  • :isset (IsSet)
  • :istrue (IsTrue)
  • :not (Not)
  • :or (Or)
  • :os (Os)
  • :socket (Socket)
  • :uptodate (UpToDate)

Reference

https://ant.apache.org/manual/Tasks/waitfor.html

Defined by

org.apache.tools.ant.taskdefs.WaitFor

Blocks execution until a set of specified conditions become true. This is intended to be
used with the parallel task to synchronize a set of processes. The conditions to wait
for are defined in nested elements, if multiple conditions are specified, then the task
will wait until all conditions are true. If both maxwait and maxwaitunit are not
specified, default maxwait is 3 minutes (180000 milliseconds). If the timeoutproperty
attribute has been set, a property of that name will be created if the condition didn't
come true within the specified time.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:checkevery` | `long` | The amount of time to wait between each test of the conditions. | No; defaults to 500 checkeveryunits |
| `:checkeveryunit` | `Unit` | The unit of time that must be used to interpret the value of the checkevery attribute. Valid values are millisecond second minute hour day week | No; defaults to millisecond |
| `:maxwait` | `long` | The maximum amount of time to wait for all the required conditions to become true before failing the task. | No; defaults to 180000 maxwaitunits |
| `:maxwaitunit` | `Unit` | The unit of time that must be used to interpret the value of the maxwait attribute. Valid values are millisecond second minute hour day week | No; defaults to millisecond |
| `:timeoutproperty` | `String` | the name of the property to set if maxwait has been exceeded. | No |

**Nested elements**

- `:and` (`And`)
- `:available` (`Available`)
- `:checksum` (`Checksum`)
- `:contains` (`Contains`)
- `:equals` (`Equals`)
- `:filesmatch` (`FilesMatch`)
- `:http` (`Http`)
- `:isfalse` (`IsFalse`)
- `:isfileselected` (`IsFileSelected`)
- `:isreference` (`IsReference`)
- `:isset` (`IsSet`)
- `:istrue` (`IsTrue`)
- `:not` (`Not`)
- `:or` (`Or`)
- `:os` (`Os`)
- `:socket` (`Socket`)
- `:uptodate` (`UpToDate`)

**Reference**

https://ant.apache.org/manual/Tasks/waitfor.html

**Defined by**

`org.apache.tools.ant.taskdefs.WaitFor`
sourceraw docstring

warclj

(war & args)

An extension of the Jar task with special treatment for files that should end up in the WEB-INF/lib, WEB-INF/classes or WEB-INF directories of the Web Application Archive. (The War task is a shortcut for specifying the particular layout of a WAR file. The same thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in a Zip or Jar task.) The extended zipfileset element from the zip task (with attributes prefix, fullpath, and src) is available in the War task. The task is also resource-enabled and will add nested resources and resource collections to the archive. Before Servlet API 2.5/Java EE 5, a WEB-INF/web.xml file was mandatory in a WAR file, so this task failed if the webxml attribute was missing. As the web.xml file is now optional, the webxml attribute may now be made optional. However, as most real web applications do need a web.xml file, it is not optional by default. The task will fail if the file is not included, unless the needxmlfile attribute is set to false. The task will warn if more than one web.xml file is added to the JAR through the filesets. Please note that the Zip format allows multiple files of the same fully-qualified name to exist within a single archive. This has been documented as causing various problems for unsuspecting users. If you wish to avoid this behavior you must set the duplicate attribute to a value other than its default, add.

Attributes

AttributeTypeDescriptionRequired
:basedirFilethe directory from which to jar the files.No
:casesensitiveboolean
:commentString
:compressbooleanNot only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating.No; defaults to true
:createunicodeextrafieldsUnicodeExtraFieldWhether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is never
:defaultexcludesbooleanIndicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destfileFilethe WAR file to create.Exactly one of the two
:duplicateDuplicatebehavior when a duplicate file is found. Valid values are add, preserve, and fail.No; defaults to add
:encodingStringThe character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task pageNo; defaults to UTF8
:excludesStringComma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFileName of a file. Each line of this file is taken to be an exclude patternNo
:fallbacktoutf8booleanWhether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is false
:fileFile
:filesetmanifestFilesetManifestConfigbehavior when a manifest is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests.No; defaults to skip
:filesonlybooleanStore only file entriesNo; defaults to false
:flattenattributesbooleanWhether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0.No; default is false
:followsymlinksboolean
:includesStringComma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFileName of a file. Each line of this file is taken to be an include patternNo
:indexboolean
:indexmetainfboolean
:jarfileFile
:keepcompressionbooleanFor entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6No; defaults to false
:levelintNon-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7No
:manifestFilethe manifest file to use.No
:manifestencodingString
:mergeclasspathattributesbooleanWhether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification.No; default is false
:modificationtimeStringSet all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2.No
:needxmlfilebooleanFlag to indicate whether or not the web.xml file is needed. It should be set to false when generating servlet 2.5+ WAR files without a web.xml file. Since Apache Ant 1.7No; default is true
:preserve0permissionsbooleanwhen updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. since Ant 1.8.0No; default is false
:roundupbooleanWhether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2No; defaults to true
:strictStrictMode
:updatebooleanindicates whether to update or overwrite the destination file if it already exists.No; defaults to false
:uselanguageencodingflagbooleanWhether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task pageNo; default is true
:warfileFileDeprecated name of the file to create-use destfile instead.Exactly one of the two
:webxmlFileThe servlet configuration descriptor to use (WEB-INF/web.xml).Yes, unless needxmlfile is true, the file is pulled in via a nested fileset, or an existing WAR file is being updated.
:whenemptyWhenEmpty
:whenmanifestonlyWhenEmptybehavior when no files match. Valid values are fail, skip, and create.No; defaults to create
:zip64modeZip64ModeAttributeWhen to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task pageNo; default is never
:zipfileFile

Nested elements

  • :and (AndSelector)
  • :classes (ZipFileSet)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :indexjars (Path)
  • :indexjarsmapper (Mapper)
  • :lib (ZipFileSet)
  • :majority (MajoritySelector)
  • :manifest (Manifest)
  • :metainf (ZipFileSet)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :service (Service)
  • :size (SizeSelector)
  • :type (TypeSelector)
  • :webinf (ZipFileSet)
  • :zipfileset (ZipFileSet)
  • :zipgroupfileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/war.html

Defined by

org.apache.tools.ant.taskdefs.War

An extension of the Jar task with special treatment for files that should end up in the
WEB-INF/lib, WEB-INF/classes or WEB-INF directories of the Web Application Archive. (The
War task is a shortcut for specifying the particular layout of a WAR file. The same
thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in
a Zip or Jar task.) The extended zipfileset element from the zip task (with attributes
prefix, fullpath, and src) is available in the War task. The task is also
resource-enabled and will add nested resources and resource collections to the archive.
Before Servlet API 2.5/Java EE 5, a WEB-INF/web.xml file was mandatory in a WAR file, so
this task failed if the webxml attribute was missing. As the web.xml file is now
optional, the webxml attribute may now be made optional. However, as most real web
applications do need a web.xml file, it is not optional by default. The task will fail
if the file is not included, unless the needxmlfile attribute is set to false. The task
will warn if more than one web.xml file is added to the JAR through the filesets. Please
note that the Zip format allows multiple files of the same fully-qualified name to exist
within a single archive. This has been documented as causing various problems for
unsuspecting users. If you wish to avoid this behavior you must set the duplicate
attribute to a value other than its default, add.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | the directory from which to jar the files. | No |
| `:casesensitive` | `boolean` |  |  |
| `:comment` | `String` |  |  |
| `:compress` | `boolean` | Not only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating. | No; defaults to true |
| `:createunicodeextrafields` | `UnicodeExtraField` | Whether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is never |
| `:defaultexcludes` | `boolean` | Indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destfile` | `File` | the WAR file to create. | Exactly one of the two |
| `:duplicate` | `Duplicate` | behavior when a duplicate file is found. Valid values are add, preserve, and fail. | No; defaults to add |
| `:encoding` | `String` | The character encoding to use for filenames inside the archive. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. See also the discussion in the zip task page | No; defaults to UTF8 |
| `:excludes` | `String` | Comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | Name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:fallbacktoutf8` | `boolean` | Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is false |
| `:file` | `File` |  |  |
| `:filesetmanifest` | `FilesetManifestConfig` | behavior when a manifest is found in a zipfileset or zipgroupfileset file. Valid values are skip, merge, and mergewithoutmain. merge will merge all of the manifests together, and merge this into any other specified manifests. mergewithoutmain merges everything but the Main section of the manifests. | No; defaults to skip |
| `:filesonly` | `boolean` | Store only file entries | No; defaults to false |
| `:flattenattributes` | `boolean` | Whether to merge attributes occurring more than once in a section (this can only happen for the Class-Path attribute) into a single attribute. Since Ant 1.8.0. | No; default is false |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | Comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | Name of a file. Each line of this file is taken to be an include pattern | No |
| `:index` | `boolean` |  |  |
| `:indexmetainf` | `boolean` |  |  |
| `:jarfile` | `File` |  |  |
| `:keepcompression` | `boolean` | For entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6 | No; defaults to false |
| `:level` | `int` | Non-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7 | No |
| `:manifest` | `File` | the manifest file to use. | No |
| `:manifestencoding` | `String` |  |  |
| `:mergeclasspathattributes` | `boolean` | Whether to merge the Class-Path attributes found in different manifests (if merging manifests). If false, only the attribute of the last merged manifest will be preserved. Since Ant 1.8.0. Unless you also set flattenAttributes to true this may result in manifests containing multiple Class-Path attributes which violates the manifest specification. | No; default is false |
| `:modificationtime` | `String` | Set all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2. | No |
| `:needxmlfile` | `boolean` | Flag to indicate whether or not the web.xml file is needed. It should be set to false when generating servlet 2.5+ WAR files without a web.xml file. Since Apache Ant 1.7 | No; default is true |
| `:preserve0permissions` | `boolean` | when updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. since Ant 1.8.0 | No; default is false |
| `:roundup` | `boolean` | Whether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2 | No; defaults to true |
| `:strict` | `StrictMode` |  |  |
| `:update` | `boolean` | indicates whether to update or overwrite the destination file if it already exists. | No; defaults to false |
| `:uselanguageencodingflag` | `boolean` | Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion in the zip task page | No; default is true |
| `:warfile` | `File` | Deprecated name of the file to create-use destfile instead. | Exactly one of the two |
| `:webxml` | `File` | The servlet configuration descriptor to use (WEB-INF/web.xml). | Yes, unless needxmlfile is true, the file is pulled in via a nested fileset, or an existing WAR file is being updated. |
| `:whenempty` | `WhenEmpty` |  |  |
| `:whenmanifestonly` | `WhenEmpty` | behavior when no files match. Valid values are fail, skip, and create. | No; defaults to create |
| `:zip64mode` | `Zip64ModeAttribute` | When to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion in the zip task page | No; default is never |
| `:zipfile` | `File` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:classes` (`ZipFileSet`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:indexjars` (`Path`)
- `:indexjarsmapper` (`Mapper`)
- `:lib` (`ZipFileSet`)
- `:majority` (`MajoritySelector`)
- `:manifest` (`Manifest`)
- `:metainf` (`ZipFileSet`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:service` (`Service`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)
- `:webinf` (`ZipFileSet`)
- `:zipfileset` (`ZipFileSet`)
- `:zipgroupfileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/war.html

**Defined by**

`org.apache.tools.ant.taskdefs.War`
sourceraw docstring

wasclasspathclj

(wasclasspath & args)

Ant nested wasclasspath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested wasclasspath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

webappclj

(webapp & args)

Ant nested webapp. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:basedirFile

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.jsp.JspC$WebAppParameter

Ant nested webapp. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.jsp.JspC$WebAppParameter`
sourceraw docstring

webinfclj

(webinf & args)

Ant nested webinf. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeString
:encodingString
:erroronmissingarchiveboolean
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeString
:followsymlinksboolean
:fullpathString
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixString
:refidReference
:srcFile
:srcresourceResource

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.ZipFileSet

Ant nested webinf. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` |  |  |
| `:encoding` | `String` |  |  |
| `:erroronmissingarchive` | `boolean` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:src` | `File` |  |  |
| `:srcresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.ZipFileSet`
sourceraw docstring

weblogicclj

(weblogic & args)

Ant nested weblogic. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:argsString
:classpathPath
:compilerString
:destdirFile
:ejbcclassString
:ejbdtdString
:genericjarsuffixString
:jvmargsString
:jvmdebuglevelInteger
:keepgeneratedString
:keepgenericboolean
:newcmpboolean
:noejbcboolean
:oldcmpboolean
:outputdirFile
:rebuildboolean
:suffixString
:weblogicdtdString
:wlclasspathPath
:wldtdString

Nested elements

  • :classpath (Path)
  • :sysproperty (Variable)
  • :wlclasspath (Path)

Parent context

This tag has multiple meanings depending on parent context. Other classes seen:

  • org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

The runner picks the right class at execute time; attribute docs above are for the first one.

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool

Ant nested weblogic. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:args` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:compiler` | `String` |  |  |
| `:destdir` | `File` |  |  |
| `:ejbcclass` | `String` |  |  |
| `:ejbdtd` | `String` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:jvmargs` | `String` |  |  |
| `:jvmdebuglevel` | `Integer` |  |  |
| `:keepgenerated` | `String` |  |  |
| `:keepgeneric` | `boolean` |  |  |
| `:newcmp` | `boolean` |  |  |
| `:noejbc` | `boolean` |  |  |
| `:oldcmp` | `boolean` |  |  |
| `:outputdir` | `File` |  |  |
| `:rebuild` | `boolean` |  |  |
| `:suffix` | `String` |  |  |
| `:weblogicdtd` | `String` |  |  |
| `:wlclasspath` | `Path` |  |  |
| `:wldtd` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:sysproperty` (`Variable`)
- `:wlclasspath` (`Path`)

**Parent context**

This tag has multiple meanings depending on parent context. Other classes seen:

- `org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool`

The runner picks the right class at execute time; attribute docs above are for the first one.

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool`
sourceraw docstring

(weblogictoplink & args)

Ant nested weblogictoplink. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:argsString
:classpathPath
:compilerString
:destdirFile
:ejbcclassString
:ejbdtdString
:genericjarsuffixString
:jvmargsString
:jvmdebuglevelInteger
:keepgeneratedString
:keepgenericboolean
:newcmpboolean
:noejbcboolean
:oldcmpboolean
:outputdirFile
:rebuildboolean
:suffixString
:toplinkdescriptorString
:toplinkdtdString
:weblogicdtdString
:wlclasspathPath
:wldtdString

Nested elements

  • :classpath (Path)
  • :sysproperty (Variable)
  • :wlclasspath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool

Ant nested weblogictoplink. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:args` | `String` |  |  |
| `:classpath` | `Path` |  |  |
| `:compiler` | `String` |  |  |
| `:destdir` | `File` |  |  |
| `:ejbcclass` | `String` |  |  |
| `:ejbdtd` | `String` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:jvmargs` | `String` |  |  |
| `:jvmdebuglevel` | `Integer` |  |  |
| `:keepgenerated` | `String` |  |  |
| `:keepgeneric` | `boolean` |  |  |
| `:newcmp` | `boolean` |  |  |
| `:noejbc` | `boolean` |  |  |
| `:oldcmp` | `boolean` |  |  |
| `:outputdir` | `File` |  |  |
| `:rebuild` | `boolean` |  |  |
| `:suffix` | `String` |  |  |
| `:toplinkdescriptor` | `String` |  |  |
| `:toplinkdtd` | `String` |  |  |
| `:weblogicdtd` | `String` |  |  |
| `:wlclasspath` | `Path` |  |  |
| `:wldtd` | `String` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:sysproperty` (`Variable`)
- `:wlclasspath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool`
sourceraw docstring

websphereclj

(websphere & args)

Ant nested websphere. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:classpathPath
:codegenboolean
:dbnameString
:dbschemaString
:dbvendorString
:destdirFile
:ejbdeployboolean
:ejbdtdString
:genericjarsuffixString
:keepgenericboolean
:newcmpboolean
:noinformboolean
:novalidateboolean
:nowarnboolean
:oldcmpboolean
:quietboolean
:rebuildboolean
:rmicoptionsString
:suffixString
:tempdirString
:traceboolean
:use35boolean
:wasclasspathPath

Nested elements

  • :classpath (Path)
  • :wasclasspath (Path)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool

Ant nested websphere. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classpath` | `Path` |  |  |
| `:codegen` | `boolean` |  |  |
| `:dbname` | `String` |  |  |
| `:dbschema` | `String` |  |  |
| `:dbvendor` | `String` |  |  |
| `:destdir` | `File` |  |  |
| `:ejbdeploy` | `boolean` |  |  |
| `:ejbdtd` | `String` |  |  |
| `:genericjarsuffix` | `String` |  |  |
| `:keepgeneric` | `boolean` |  |  |
| `:newcmp` | `boolean` |  |  |
| `:noinform` | `boolean` |  |  |
| `:novalidate` | `boolean` |  |  |
| `:nowarn` | `boolean` |  |  |
| `:oldcmp` | `boolean` |  |  |
| `:quiet` | `boolean` |  |  |
| `:rebuild` | `boolean` |  |  |
| `:rmicoptions` | `String` |  |  |
| `:suffix` | `String` |  |  |
| `:tempdir` | `String` |  |  |
| `:trace` | `boolean` |  |  |
| `:use35` | `boolean` |  |  |
| `:wasclasspath` | `Path` |  |  |

**Nested elements**

- `:classpath` (`Path`)
- `:wasclasspath` (`Path`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool`
sourceraw docstring

whichresourceclj

(whichresource & args)

Find a class or resource on the supplied classpath, or the system classpath if none is supplied. The named property is set if the item can be found. For example: <whichresource resource="/log4j.properties" property="log4j.url"/>

Attributes

AttributeTypeDescriptionRequired
:classStringThe name of the class to look for.Exactly one of these
:classpathPathThe classpath to use when looking up class or resource.No
:classpathrefReferenceThe classpath to use, given as a reference to a path defined elsewhere. Since Apache Ant 1.7.1.No
:propertyStringThe property to fill with the URL of the resource of class.Yes
:resourceStringThe name of the resource to look for.Exactly one of these

Nested elements

  • :classpath (Path)

Reference

https://ant.apache.org/manual/Tasks/whichresource.html

Defined by

org.apache.tools.ant.taskdefs.WhichResource

Find a class or resource on the supplied classpath, or the system classpath if none is
supplied. The named property is set if the item can be found. For example:
<whichresource resource="/log4j.properties" property="log4j.url"/>

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:class` | `String` | The name of the class to look for. | Exactly one of these |
| `:classpath` | `Path` | The classpath to use when looking up class or resource. | No |
| `:classpathref` | `Reference` | The classpath to use, given as a reference to a path defined elsewhere. Since Apache Ant 1.7.1. | No |
| `:property` | `String` | The property to fill with the URL of the resource of class. | Yes |
| `:resource` | `String` | The name of the resource to look for. | Exactly one of these |

**Nested elements**

- `:classpath` (`Path`)

**Reference**

https://ant.apache.org/manual/Tasks/whichresource.html

**Defined by**

`org.apache.tools.ant.taskdefs.WhichResource`
sourceraw docstring

windowsjunctionclj

(windowsjunction & args)

Ant nested windowsjunction. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.WindowsJunctionSelector

Ant nested windowsjunction. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.WindowsJunctionSelector`
sourceraw docstring

wlclasspathclj

(wlclasspath & args)

Ant nested wlclasspath. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:pathString
:refidReference

Nested elements

  • :dirset (DirSet)
  • :existing (Path)
  • :extdirs (Path)
  • :filelist (FileList)
  • :fileset (FileSet)
  • :path (Path)
  • :pathelement (PathElement)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.Path

Ant nested wlclasspath. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:path` | `String` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:dirset` (`DirSet`)
- `:existing` (`Path`)
- `:extdirs` (`Path`)
- `:filelist` (`FileList`)
- `:fileset` (`FileSet`)
- `:path` (`Path`)
- `:pathelement` (`PathElement`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.Path`
sourceraw docstring

wljspcclj

(wljspc & args)

Class to precompile JSP's using WebLogic JSP compiler (weblogic.jspc) Tested only on WebLogic 4.5.1-NT 4.0 and Solaris 7 & 8

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:classpathPathClass path to use when compiling JSPsYes
:defaultexcludesboolean
:destFileroot of destination directory, what you have set as WorkingDir in the WebLogic propertiesYes
:excludesString
:excludesfileFile
:followsymlinksboolean
:includesString
:includesfileFile
:packageStringstart package name under which your JSPs would be compiledYes
:srcFileroot of source tree for JSP, ie, the document root for your WebLogic serverYes

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)

Reference

https://ant.apache.org/manual/Tasks/wljspc.html

Defined by

org.apache.tools.ant.taskdefs.optional.jsp.WLJspc

Class to precompile JSP's using WebLogic JSP compiler (weblogic.jspc) Tested only on
WebLogic 4.5.1-NT 4.0 and Solaris 7 & 8

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | Class path to use when compiling JSPs | Yes |
| `:defaultexcludes` | `boolean` |  |  |
| `:dest` | `File` | root of destination directory, what you have set as WorkingDir in the WebLogic properties | Yes |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:package` | `String` | start package name under which your JSPs would be compiled | Yes |
| `:src` | `File` | root of source tree for JSP, ie, the document root for your WebLogic server | Yes |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)

**Reference**

https://ant.apache.org/manual/Tasks/wljspc.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.jsp.WLJspc`
sourceraw docstring

writableclj

(writable & args)

Ant nested writable. (No description bundled.)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.selectors.WritableSelector

Ant nested writable. (No description bundled.)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.selectors.WritableSelector`
sourceraw docstring

xmlcatalogclj

(xmlcatalog & args)

An XMLCatalog is a catalog of public resources such as DTDs or entities that are referenced in an XML document. Catalogs are typically used to make web references to resources point to a locally cached copy of the resource. This allows the XML Parser, XSLT Processor or other consumer of XML documents to efficiently allow a local substitution for a resource available on the web. Note: This task uses, but does not depend on external libraries not included in the Apache Ant distribution. See Library Dependencies for more information. This data type provides a catalog of resource locations based on the OASIS XML Catalog standard. The catalog entries are used both for Entity resolution and URI resolution, in accordance with the org.xml.sax.EntityResolver and javax.xml.transform.URIResolver interfaces as defined in the Java API for XML Processing (JAXP) Specification. For example, in a web.xml file, the DTD is referenced as: <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd"> The XML processor, without XMLCatalog support, would need to retrieve the DTD from the URL specified whenever validation of the document was required. This can be very time consuming during the build process, especially where network throughput is limited. Alternatively, you can do the following: Copy web-app_2_2.dtd onto your local disk somewhere (either in the filesystem or even embedded inside a jar or zip file on the classpath). Create an <xmlcatalog> with a <dtd> element whose location attribute points to the file. Success! The XML processor will now use the local copy instead of calling out to the internet. XMLCatalogs can appear inside tasks that support this feature or at the same level as target-i.e., as children of project for reuse across different tasks, e.g. XML Validation and XSLT Transformation. The XML Validate task uses XMLCatalogs for entity resolution. The XSLT Transformation task uses XMLCatalogs for both entity and URI resolution. XMLCatalogs are specified as either a reference to another XMLCatalog, defined previously in a build file, or as a list of dtd or entity locations. In addition, external catalog files may be specified in a nested catalogpath, but they will be ignored unless the resolver library from xml-commons is available in the system classpath. Due to backwards incompatible changes in the resolver code after the release of resolver 1.0, Ant supports only resolver 1.1 or later. A separate classpath for entity resolution may be specified inline via nested classpath elements; otherwise the system classpath is used for this as well. XMLCatalogs can also be nested inside other XMLCatalogs. For example, a "superset" XMLCatalog could be made by including several nested XMLCatalogs that referred to other, previously defined XMLCatalogs. Resource locations can be specified either in-line or in external catalog file(s), or both. In order to use an external catalog file, the xml-commons resolver library (resolver.jar) must be in your path. External catalog files may be either plain text format or XML format. If the xml-commons resolver library is not found in the classpath, external catalog files, specified in catalogpath, will be ignored and a warning will be logged. In this case, however, processing of inline entries will proceed normally. Currently, only <dtd> and <entity> elements may be specified inline; these roughly correspond to OASIS catalog entry types PUBLIC and URI respectively. By contrast, external catalog files may use any of the entry types defined in the OASIS specification.

Attributes

AttributeTypeDescriptionRequired
:catalogpathrefReference
:classpathPath
:classpathrefReference
:refidReferencethe id of another XMLCatalog whose contents you would like to be used for this XMLCatalogNo

Nested elements

  • :catalogpath (Path)
  • :classpath (Path)
  • :dtd (ResourceLocation)
  • :entity (ResourceLocation)
  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Types/xmlcatalog.html

Defined by

org.apache.tools.ant.types.XMLCatalog

An XMLCatalog is a catalog of public resources such as DTDs or entities that are
referenced in an XML document. Catalogs are typically used to make web references to
resources point to a locally cached copy of the resource. This allows the XML Parser,
XSLT Processor or other consumer of XML documents to efficiently allow a local
substitution for a resource available on the web. Note: This task uses, but does not
depend on external libraries not included in the Apache Ant distribution. See Library
Dependencies for more information. This data type provides a catalog of resource
locations based on the OASIS XML Catalog standard. The catalog entries are used both for
Entity resolution and URI resolution, in accordance with the org.xml.sax.EntityResolver
and javax.xml.transform.URIResolver interfaces as defined in the Java API for XML
Processing (JAXP) Specification. For example, in a web.xml file, the DTD is referenced
as: <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
"http://java.sun.com/j2ee/dtds/web-app_2_2.dtd"> The XML processor, without XMLCatalog
support, would need to retrieve the DTD from the URL specified whenever validation of
the document was required. This can be very time consuming during the build process,
especially where network throughput is limited. Alternatively, you can do the following:
Copy web-app_2_2.dtd onto your local disk somewhere (either in the filesystem or even
embedded inside a jar or zip file on the classpath). Create an <xmlcatalog> with a <dtd>
element whose location attribute points to the file. Success! The XML processor will now
use the local copy instead of calling out to the internet. XMLCatalogs can appear inside
tasks that support this feature or at the same level as target-i.e., as children of
project for reuse across different tasks, e.g. XML Validation and XSLT Transformation.
The XML Validate task uses XMLCatalogs for entity resolution. The XSLT Transformation
task uses XMLCatalogs for both entity and URI resolution. XMLCatalogs are specified as
either a reference to another XMLCatalog, defined previously in a build file, or as a
list of dtd or entity locations. In addition, external catalog files may be specified in
a nested catalogpath, but they will be ignored unless the resolver library from
xml-commons is available in the system classpath. Due to backwards incompatible changes
in the resolver code after the release of resolver 1.0, Ant supports only resolver 1.1
or later. A separate classpath for entity resolution may be specified inline via nested
classpath elements; otherwise the system classpath is used for this as well. XMLCatalogs
can also be nested inside other XMLCatalogs. For example, a "superset" XMLCatalog could
be made by including several nested XMLCatalogs that referred to other, previously
defined XMLCatalogs. Resource locations can be specified either in-line or in external
catalog file(s), or both. In order to use an external catalog file, the xml-commons
resolver library (resolver.jar) must be in your path. External catalog files may be
either plain text format or XML format. If the xml-commons resolver library is not found
in the classpath, external catalog files, specified in catalogpath, will be ignored and
a warning will be logged. In this case, however, processing of inline entries will
proceed normally. Currently, only <dtd> and <entity> elements may be specified inline;
these roughly correspond to OASIS catalog entry types PUBLIC and URI respectively. By
contrast, external catalog files may use any of the entry types defined in the OASIS
specification.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:catalogpathref` | `Reference` |  |  |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` |  |  |
| `:refid` | `Reference` | the id of another XMLCatalog whose contents you would like to be used for this XMLCatalog | No |

**Nested elements**

- `:catalogpath` (`Path`)
- `:classpath` (`Path`)
- `:dtd` (`ResourceLocation`)
- `:entity` (`ResourceLocation`)
- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Types/xmlcatalog.html

**Defined by**

`org.apache.tools.ant.types.XMLCatalog`
sourceraw docstring

xmlpropertyclj

(xmlproperty & args)

Loads property values from a well-formed xml file. There are no other restrictions than "well-formed". You can choose the layout you want. For example this XML property file: <root> <properties> <foo>bar</foo> </properties> </root> is roughly equivalent to this Java property file: root.properties.foo = bar By default, this load does no processing of the input. In particular, unlike the Property task, property references (i.e., ${foo}) are not resolved.

Attributes

AttributeTypeDescriptionRequired
:collapseattributesbooleanTreat attributes as nested elements.No; default is false
:delimiterStringDelimiter for splitting multiple values. since Apache Ant 1.7.1No; defaults to, (comma)
:fileFileThe XML file to parse.Yes, or a nested resource collection
:includesemanticattributebooleanInclude the semantic attribute name as part of the property name. Ignored if semanticAttributes is not set to true. See the Semantic Attributes section for more information.No; default is false
:keeprootbooleanKeep the XML root tag as the first value in the property name.No; default is true
:prefixStringThe prefix to prepend to each property.No
:rootdirectoryFileThe directory to use for resolving file references. Ignored if semanticAttributes is not set to true.No; default is basedir
:semanticattributesbooleanEnable special handling of certain attribute names. See the Semantic Attributes section for more information.No; default is false
:srcresourceResource
:validatebooleanValidate the input file (e.g. by a DTD). Otherwise the XML must only be well-formed.No; default is false

Nested elements

  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Tasks/xmlproperty.html

Defined by

org.apache.tools.ant.taskdefs.XmlProperty

Loads property values from a well-formed xml file. There are no other restrictions than
"well-formed". You can choose the layout you want. For example this XML property file:
<root> <properties> <foo>bar</foo> </properties> </root> is roughly equivalent to this
Java property file: root.properties.foo = bar By default, this load does no processing
of the input. In particular, unlike the Property task, property references (i.e.,
${foo}) are not resolved.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:collapseattributes` | `boolean` | Treat attributes as nested elements. | No; default is false |
| `:delimiter` | `String` | Delimiter for splitting multiple values. since Apache Ant 1.7.1 | No; defaults to, (comma) |
| `:file` | `File` | The XML file to parse. | Yes, or a nested resource collection |
| `:includesemanticattribute` | `boolean` | Include the semantic attribute name as part of the property name. Ignored if semanticAttributes is not set to true. See the Semantic Attributes section for more information. | No; default is false |
| `:keeproot` | `boolean` | Keep the XML root tag as the first value in the property name. | No; default is true |
| `:prefix` | `String` | The prefix to prepend to each property. | No |
| `:rootdirectory` | `File` | The directory to use for resolving file references. Ignored if semanticAttributes is not set to true. | No; default is basedir |
| `:semanticattributes` | `boolean` | Enable special handling of certain attribute names. See the Semantic Attributes section for more information. | No; default is false |
| `:srcresource` | `Resource` |  |  |
| `:validate` | `boolean` | Validate the input file (e.g. by a DTD). Otherwise the XML must only be well-formed. | No; default is false |

**Nested elements**

- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Tasks/xmlproperty.html

**Defined by**

`org.apache.tools.ant.taskdefs.XmlProperty`
sourceraw docstring

xmlvalidateclj

(xmlvalidate & args)

This task checks that XML files are valid (or only well formed). The task uses the SAX2 parser implementation provided by JAXP by default (probably the one that is used by Apache Ant itself), but one can specify any SAX1/2 parser if needed. This task supports the use of nested <xmlcatalog> elements <dtd> elements which are used to resolve DTDs and entities <attribute> elements which are used to set features on the parser. These can be any number of http://xml.org/sax/features/ or other features that your parser may support. <property> elements, containing string properties Warning: By default, JAXP creates a non namespace aware parser. The http://xml.org/sax/features/namespaces feature is set by default to false by the JAXP implementation used by Ant. To validate a document containing namespaces, set the namespaces feature to true explicitly by nesting the following element: <attribute name="http://xml.org/sax/features/namespaces" value="true"/> If you are using for instance a xsi:noNamespaceSchemaLocation attribute in your XML files, you will need this namespace support feature. If you are using a parser not generated by JAXP, by using the classname attribute of xmlvalidate, this warning may not apply.

Attributes

AttributeTypeDescriptionRequired
:classnameStringthe parser to use.No
:classpathPath
:classpathrefReferencewhere to find the parser class.No, can use an embedded <classpath> element
:failonerrorbooleanfails on a error if set to true.No; defaults to true
:fileFilethe file(s) you want to check.Yes, unless an embedded <fileset> is specified
:lenientbooleanif true, only check the XML document is well formed (ignored if the specified parser is a SAX1 parser).No
:warnbooleanlog parser warn events.No

Nested elements

  • :attribute (Attribute)
  • :classpath (Path)
  • :dtd (DTDLocation)
  • :fileset (FileSet)
  • :property (Property)
  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Tasks/xmlvalidate.html

Defined by

org.apache.tools.ant.taskdefs.optional.XMLValidateTask

This task checks that XML files are valid (or only well formed). The task uses the SAX2
parser implementation provided by JAXP by default (probably the one that is used by
Apache Ant itself), but one can specify any SAX1/2 parser if needed. This task supports
the use of nested <xmlcatalog> elements <dtd> elements which are used to resolve DTDs
and entities <attribute> elements which are used to set features on the parser. These
can be any number of http://xml.org/sax/features/ or other features that your parser may
support. <property> elements, containing string properties Warning: By default, JAXP
creates a non namespace aware parser. The http://xml.org/sax/features/namespaces feature
is set by default to false by the JAXP implementation used by Ant. To validate a
document containing namespaces, set the namespaces feature to true explicitly by nesting
the following element: <attribute name="http://xml.org/sax/features/namespaces"
value="true"/> If you are using for instance a xsi:noNamespaceSchemaLocation attribute
in your XML files, you will need this namespace support feature. If you are using a
parser not generated by JAXP, by using the classname attribute of xmlvalidate, this
warning may not apply.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:classname` | `String` | the parser to use. | No |
| `:classpath` | `Path` |  |  |
| `:classpathref` | `Reference` | where to find the parser class. | No, can use an embedded <classpath> element |
| `:failonerror` | `boolean` | fails on a error if set to true. | No; defaults to true |
| `:file` | `File` | the file(s) you want to check. | Yes, unless an embedded <fileset> is specified |
| `:lenient` | `boolean` | if true, only check the XML document is well formed (ignored if the specified parser is a SAX1 parser). | No |
| `:warn` | `boolean` | log parser warn events. | No |

**Nested elements**

- `:attribute` (`Attribute`)
- `:classpath` (`Path`)
- `:dtd` (`DTDLocation`)
- `:fileset` (`FileSet`)
- `:property` (`Property`)
- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Tasks/xmlvalidate.html

**Defined by**

`org.apache.tools.ant.taskdefs.optional.XMLValidateTask`
sourceraw docstring

xsltclj

(xslt & args)

Process a set of documents via XSLT. This is useful for building views of XML based documentation, or for generating code. It is possible to refine the set of files that are being processed. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements. Note: Unlike other similar tasks, this task treats directories that have been matched by the include/exclude patterns of the implicit fileset in a special way. It will apply the stylesheets to all files contain in them as well. Since the default includes pattern is ** this means it will apply the stylesheet to all files. If you specify an excludes pattern, it may still work on the files matched by those patterns because the parent directory has been matched. If this behavior is not what you want, set the scanincludedirectories attribute to false. Since Ant 1.7, this task supports nested resource collections in addition to (or instead of, depending on the useImplicitFileset attribute) the implicit fileset formed by this task. This task supports the use of a nested <param> element which is used to pass values to an xsl:param declaration. This task supports the use of a nested xmlcatalog element which is used to perform Entity and URI resolution. Note on XSLT extension functions: when using the default TrAX implementation of the Java class library and a SecurityManager is active-e.g. when running from within an IDE-XSLT extension functions cannot be used as "secure processing" is active in Java 7 and above. Ant contains a special "hack" that allows XSLT extensions to be used in Java 7 and 8, but this hack fails for Java 9. If you want to use extensions like the redirect extension that are provided by the Java class library itself, you can allow them by enabling the feature http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions in Java 9 and above. If you need to use an extension function not provided by Java itself you can set the attribute jdk.xml.transform.extensionClassLoader to a classloader (reference to an Ant path-like structure).

Attributes

AttributeTypeDescriptionRequired
:basedirFilewhere to find the source XML file.No; defaults to the project's basedir
:casesensitiveboolean
:classpathPaththe classpath to use when looking up the XSLT processor.No
:classpathrefReferencethe classpath to use, given as reference to a path defined elsewhere.No
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destdirFiledirectory in which to store the results.Yes, unless in and out have been specified.
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude patternNo
:extensionStringdesired file extension to be used for the targets.No; default is .html, ignored if a nested <mapper> or both in and out have been specified
:failonerrorbooleanWhether the build should fail if any error occurs. Note that transformation errors can still be suppressed by setting failOnTransformationError to false even if this attribute is true. Since Ant 1.8.0.No; default is true
:failonnoresourcesbooleanWhether the build should fail if the nested resource collection is empty. Note that this attribute has no effect of failOnError is false. Since Ant 1.8.0.No; default is true
:failontransformationerrorbooleanWhether the build should fail if an error occurs while transforming the document. Note that this attribute has no effect if failOnError is false. Since Ant 1.8.0.No; default is true
:filedirparameterStringSpecifies a XSL parameter for accessing the directory of the current processed file. For files in the current directory, a value of. will be passed to the transformation. If not set, the directory is not passed to the transformation. Since Ant 1.7.No
:filenameparameterStringSpecifies an XSL parameter for accessing the name of the current processed file. If not set, the file name is not passed to the transformation. Since Ant 1.7.No
:followsymlinksboolean
:forcebooleanRecreate target files, even if they are newer than their corresponding source files or the stylesheet.No; default is false
:granularitylongThe number of milliseconds leeway to give before deciding a file is out of date with respect of the source file or stylesheet. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.10.16.No; default is 1 second, or 2 seconds on DOS systems
:inFilespecifies a single XML document to be styled. Should be used with the out attribute.No
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include patternNo
:outFilespecifies the output name for the styled result from the in attribute.No
:processorStringname of the XSLT processor to use. Permissible value is: trax for a TraX compliant processor (ie JAXP interface implementation such as Xalan 2 or Saxon) Support for Xalan 1 has been removed since Ant 1.7.No; defaults to trax
:reloadstylesheetbooleanControl whether the stylesheet transformer is created anew for every transform operation. If you set this to true, performance may suffer, but you may work around a bug in certain Xalan versions. Since Ant 1.5.2.No; default is false
:scanincludeddirectoriesbooleanIf any directories are matched by the includes/excludes patterns, try to transform all files in these directories. No; default is true
:styleStringname of the stylesheet to use-given either relative to the project's basedir or as an absolute path. Alternatively, a nested element which Ant can interpret as a resource can be used to indicate where to find the stylesheet. Deprecated variation: If the stylesheet cannot be found, and if you have specified the attribute basedir for the task, Ant will assume that the style attribute is relative to the basedir of the task.No, if the location of the stylesheet is specified using a nested <style> element
:suppresswarningsbooleanWhether processor warnings shall be suppressed. This option requires support by the processor, it is supported by the TrAX processor bundled with Ant. Since Ant 1.8.0.No; default is false
:useimplicitfilesetbooleanWhether the implicit fileset formed by this task shall be used. If you set this to false you must use nested resource collections-or the in attribute, in which case this attribute has no impact anyway. Since Ant 1.7.No; default is true
:xslresourceResource

Nested elements

  • :and (AndSelector)
  • :classpath (Path)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :factory (Factory)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :mapper (Mapper)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :outputproperty (OutputProperty)
  • :param (Param)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :style (Resources)
  • :sysproperty (Variable)
  • :syspropertyset (PropertySet)
  • :trace (TraceConfiguration)
  • :type (TypeSelector)
  • :xmlcatalog (XMLCatalog)

Reference

https://ant.apache.org/manual/Tasks/style.html

Defined by

org.apache.tools.ant.taskdefs.XSLTProcess

Process a set of documents via XSLT. This is useful for building views of XML based
documentation, or for generating code. It is possible to refine the set of files that
are being processed. This can be done with the includes, includesfile, excludes,
excludesfile and defaultexcludes attributes. With the includes or includesfile attribute
you specify the files you want to have included by using patterns. The exclude or
excludesfile attribute is used to specify the files you want to have excluded. This is
also done with patterns. And finally with the defaultexcludes attribute, you can specify
whether you want to use default exclusions or not. See the section on directory based
tasks, on how the inclusion/exclusion of files works, and how to write patterns. This
task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes
basedir) as well as the nested <include>, <exclude> and <patternset> elements. Note:
Unlike other similar tasks, this task treats directories that have been matched by the
include/exclude patterns of the implicit fileset in a special way. It will apply the
stylesheets to all files contain in them as well. Since the default includes pattern is
** this means it will apply the stylesheet to all files. If you specify an excludes
pattern, it may still work on the files matched by those patterns because the parent
directory has been matched. If this behavior is not what you want, set the
scanincludedirectories attribute to false. Since Ant 1.7, this task supports nested
resource collections in addition to (or instead of, depending on the useImplicitFileset
attribute) the implicit fileset formed by this task. This task supports the use of a
nested <param> element which is used to pass values to an <xsl:param> declaration. This
task supports the use of a nested xmlcatalog element which is used to perform Entity and
URI resolution. Note on XSLT extension functions: when using the default TrAX
implementation of the Java class library and a SecurityManager is active-e.g. when
running from within an IDE-XSLT extension functions cannot be used as "secure
processing" is active in Java 7 and above. Ant contains a special "hack" that allows
XSLT extensions to be used in Java 7 and 8, but this hack fails for Java 9. If you want
to use extensions like the redirect extension that are provided by the Java class
library itself, you can allow them by enabling the feature
http://www.oracle.com/xml/jaxp/properties/enableExtensionFunctions in Java 9 and above.
If you need to use an extension function not provided by Java itself you can set the
attribute jdk.xml.transform.extensionClassLoader to a classloader (reference to an Ant
path-like structure).

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | where to find the source XML file. | No; defaults to the project's basedir |
| `:casesensitive` | `boolean` |  |  |
| `:classpath` | `Path` | the classpath to use when looking up the XSLT processor. | No |
| `:classpathref` | `Reference` | the classpath to use, given as reference to a path defined elsewhere. | No |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destdir` | `File` | directory in which to store the results. | Yes, unless in and out have been specified. |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern | No |
| `:extension` | `String` | desired file extension to be used for the targets. | No; default is .html, ignored if a nested <mapper> or both in and out have been specified |
| `:failonerror` | `boolean` | Whether the build should fail if any error occurs. Note that transformation errors can still be suppressed by setting failOnTransformationError to false even if this attribute is true. Since Ant 1.8.0. | No; default is true |
| `:failonnoresources` | `boolean` | Whether the build should fail if the nested resource collection is empty. Note that this attribute has no effect of failOnError is false. Since Ant 1.8.0. | No; default is true |
| `:failontransformationerror` | `boolean` | Whether the build should fail if an error occurs while transforming the document. Note that this attribute has no effect if failOnError is false. Since Ant 1.8.0. | No; default is true |
| `:filedirparameter` | `String` | Specifies a XSL parameter for accessing the directory of the current processed file. For files in the current directory, a value of. will be passed to the transformation. If not set, the directory is not passed to the transformation. Since Ant 1.7. | No |
| `:filenameparameter` | `String` | Specifies an XSL parameter for accessing the name of the current processed file. If not set, the file name is not passed to the transformation. Since Ant 1.7. | No |
| `:followsymlinks` | `boolean` |  |  |
| `:force` | `boolean` | Recreate target files, even if they are newer than their corresponding source files or the stylesheet. | No; default is false |
| `:granularity` | `long` | The number of milliseconds leeway to give before deciding a file is out of date with respect of the source file or stylesheet. This is needed because not every file system supports tracking the last modified time to the millisecond level. This can also be useful if source and target files live on separate machines with clocks being out of sync. since Ant 1.10.16. | No; default is 1 second, or 2 seconds on DOS systems |
| `:in` | `File` | specifies a single XML document to be styled. Should be used with the out attribute. | No |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern | No |
| `:out` | `File` | specifies the output name for the styled result from the in attribute. | No |
| `:processor` | `String` | name of the XSLT processor to use. Permissible value is: trax for a TraX compliant processor (ie JAXP interface implementation such as Xalan 2 or Saxon) Support for Xalan 1 has been removed since Ant 1.7. | No; defaults to trax |
| `:reloadstylesheet` | `boolean` | Control whether the stylesheet transformer is created anew for every transform operation. If you set this to true, performance may suffer, but you may work around a bug in certain Xalan versions. Since Ant 1.5.2. | No; default is false |
| `:scanincludeddirectories` | `boolean` | If any directories are matched by the includes/excludes patterns, try to transform all files in these directories. No; default is true |  |
| `:style` | `String` | name of the stylesheet to use-given either relative to the project's basedir or as an absolute path. Alternatively, a nested element which Ant can interpret as a resource can be used to indicate where to find the stylesheet. Deprecated variation: If the stylesheet cannot be found, and if you have specified the attribute basedir for the task, Ant will assume that the style attribute is relative to the basedir of the task. | No, if the location of the stylesheet is specified using a nested <style> element |
| `:suppresswarnings` | `boolean` | Whether processor warnings shall be suppressed. This option requires support by the processor, it is supported by the TrAX processor bundled with Ant. Since Ant 1.8.0. | No; default is false |
| `:useimplicitfileset` | `boolean` | Whether the implicit fileset formed by this task shall be used. If you set this to false you must use nested resource collections-or the in attribute, in which case this attribute has no impact anyway. Since Ant 1.7. | No; default is true |
| `:xslresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:classpath` (`Path`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:factory` (`Factory`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:mapper` (`Mapper`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:outputproperty` (`OutputProperty`)
- `:param` (`Param`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:style` (`Resources`)
- `:sysproperty` (`Variable`)
- `:syspropertyset` (`PropertySet`)
- `:trace` (`TraceConfiguration`)
- `:type` (`TypeSelector`)
- `:xmlcatalog` (`XMLCatalog`)

**Reference**

https://ant.apache.org/manual/Tasks/style.html

**Defined by**

`org.apache.tools.ant.taskdefs.XSLTProcess`
sourceraw docstring

zipclj

(zip & args)

Creates a zipfile. The basedir attribute is the reference directory from where to zip. Note that file permissions will not be stored in the resulting zipfile. It is possible to refine the set of files that are being zipped. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns. This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements. Or, you may place within it nested file sets, or references to file sets. In this case basedir is optional; the implicit file set is only used if basedir is set. You may use any mixture of the implicit file set (with basedir set, and optional attributes like includes and optional subelements like <include>); explicit nested <fileset> elements so long as at least one fileset total is specified. The ZIP file will only reflect the relative paths of files within each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below). The Zip task also supports the merging of multiple zip files into the zip file. This is possible through either the src attribute of any nested filesets or by using the special nested fileset zipgroupfileset. The update parameter controls what happens if the ZIP file already exists. When set to yes, the ZIP file is updated with the files specified. (New files are added; old files are replaced with the new versions.) When set to no (the default) the ZIP file is overwritten if any of the files that would be added to the archive are newer than the entries inside the archive. Please note that ZIP files store file modification times with a granularity of 2 seconds. If a file is less than 2 seconds newer than the entry in the archive, Apache Ant will not consider it newer. The whenempty parameter controls what happens when no files match. If skip (the default), the ZIP is not created and a warning is issued. If fail, the ZIP is not created and the build is halted with an error. If create, an empty ZIP file (explicitly zero entries) is created, which should be recognized as such by compliant ZIP manipulation tools. This task will now use default JVM character encoding for filenames-this is consistent with the command line ZIP tools, but causes problems if you try to open them from within Java and your filenames contain non US-ASCII characters. Use the encoding attribute and set it to UTF8 to create zip files that can safely be read by Java. For a more complete discussion, see below Since Ant 1.5.2, <zip> can store Unix permissions inside the archive (see description of the filemode and dirmode attributes for <zipfileset>). Unfortunately there is no portable way to store these permissions. Ant uses the algorithm used by Info-Zip's implementation of the zip and unzip commands-these are the default versions of zip and unzip for many Unix(-like) systems. Please note that the zip format allows multiple files of the same fully-qualified name to exist within a single archive. This has been documented as causing various problems for unsuspecting users. If you wish to avoid this behavior you must set the duplicate attribute to a value other than its default, add. Please also note that different ZIP tools handle timestamps differently when it comes to applying timezone offset calculations of files. Some ZIP libraries will store the timestamps as they've been read from the filesystem while others will modify the timestamps both when reading and writing the files to make all timestamps use the same timezone. A ZIP archive created by one library may extract files with "wrong timestamps" when extracted by another library. Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get adjusted), Windows' "compressed folders" function and WinZIP don't change the timestamps. This means that using the unzip task on files created by Windows' compressed folders function may create files with timestamps that are "wrong", the same is true if you use Windows' functions to extract an Ant generated ZIP archive.

Attributes

AttributeTypeDescriptionRequired
:basedirFilethe directory from which to zip the files.No
:casesensitiveboolean
:commentStringComment to store in the archive. Since Ant 1.6.3No
:compressbooleanNot only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating.No; defaults to true
:createunicodeextrafieldsUnicodeExtraFieldWhether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion belowNo; default is never
:defaultexcludesbooleanindicates whether default excludes should be used or not (yes|no).No; defaults to yes
:destfileFilethe zip file to create.Exactly one of the two
:duplicateDuplicatebehavior when a duplicate file is found. Valid values are add, preserve, and fail.No; default is add
:encodingStringThe character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings.No; defaults to default JVM character encoding
:excludesStringcomma- or space-separated list of patterns of files that must be excluded.No; defaults to default excludes or none if defaultexcludes is no
:excludesfileFilename of a file. Each line of this file is taken to be an exclude pattern.No
:fallbacktoutf8booleanWhether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion belowNo; default is false
:fileFile
:filesonlybooleanStore only file entries.No; defaults to false
:followsymlinksboolean
:includesStringcomma- or space-separated list of patterns of files that must be included.No; defaults to all (**)
:includesfileFilename of a file. Each line of this file is taken to be an include pattern.No
:keepcompressionbooleanFor entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6No; defaults to false
:levelintNon-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7No
:modificationtimeStringSet all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2.No
:preserve0permissionsbooleanwhen updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. Since Ant 1.8.0No; default is false
:roundupbooleanWhether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2No; defaults to true
:updatebooleanindicates whether to update or overwrite the destination file if it already exists.No; default is false
:uselanguageencodingflagbooleanWhether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion belowNo; default is true
:whenemptyWhenEmptybehavior when no files match. Valid values are fail, skip, and create.No; default is skip
:zip64modeZip64ModeAttributeWhen to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion belowNo; default is as-needed
:zipfileFiledeprecated old name of destfile.Exactly one of the two

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :filename (FilenameSelector)
  • :fileset (FileSet)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :patternset (PatternSet)
  • :present (PresentSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :type (TypeSelector)
  • :zipfileset (ZipFileSet)
  • :zipgroupfileset (FileSet)

Reference

https://ant.apache.org/manual/Tasks/zip.html

Defined by

org.apache.tools.ant.taskdefs.Zip

Creates a zipfile. The basedir attribute is the reference directory from where to zip.
Note that file permissions will not be stored in the resulting zipfile. It is possible
to refine the set of files that are being zipped. This can be done with the includes,
includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes
or includesfile attribute you specify the files you want to have included by using
patterns. The exclude or excludesfile attribute is used to specify the files you want to
have excluded. This is also done with patterns. And finally with the defaultexcludes
attribute, you can specify whether you want to use default exclusions or not. See the
section on directory based tasks, on how the inclusion/exclusion of files works, and how
to write patterns. This task forms an implicit FileSet and supports most attributes of
<fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and
<patternset> elements. Or, you may place within it nested file sets, or references to
file sets. In this case basedir is optional; the implicit file set is only used if
basedir is set. You may use any mixture of the implicit file set (with basedir set, and
optional attributes like includes and optional subelements like <include>); explicit
nested <fileset> elements so long as at least one fileset total is specified. The ZIP
file will only reflect the relative paths of files within each fileset. The Zip task and
its derivatives know a special form of a fileset named zipfileset that has additional
attributes (described below). The Zip task also supports the merging of multiple zip
files into the zip file. This is possible through either the src attribute of any nested
filesets or by using the special nested fileset zipgroupfileset. The update parameter
controls what happens if the ZIP file already exists. When set to yes, the ZIP file is
updated with the files specified. (New files are added; old files are replaced with the
new versions.) When set to no (the default) the ZIP file is overwritten if any of the
files that would be added to the archive are newer than the entries inside the archive.
Please note that ZIP files store file modification times with a granularity of 2
seconds. If a file is less than 2 seconds newer than the entry in the archive, Apache
Ant will not consider it newer. The whenempty parameter controls what happens when no
files match. If skip (the default), the ZIP is not created and a warning is issued. If
fail, the ZIP is not created and the build is halted with an error. If create, an empty
ZIP file (explicitly zero entries) is created, which should be recognized as such by
compliant ZIP manipulation tools. This task will now use default JVM character encoding
for filenames-this is consistent with the command line ZIP tools, but causes problems if
you try to open them from within Java and your filenames contain non US-ASCII
characters. Use the encoding attribute and set it to UTF8 to create zip files that can
safely be read by Java. For a more complete discussion, see below Since Ant 1.5.2, <zip>
can store Unix permissions inside the archive (see description of the filemode and
dirmode attributes for <zipfileset>). Unfortunately there is no portable way to store
these permissions. Ant uses the algorithm used by Info-Zip's implementation of the zip
and unzip commands-these are the default versions of zip and unzip for many Unix(-like)
systems. Please note that the zip format allows multiple files of the same
fully-qualified name to exist within a single archive. This has been documented as
causing various problems for unsuspecting users. If you wish to avoid this behavior you
must set the duplicate attribute to a value other than its default, add. Please also
note that different ZIP tools handle timestamps differently when it comes to applying
timezone offset calculations of files. Some ZIP libraries will store the timestamps as
they've been read from the filesystem while others will modify the timestamps both when
reading and writing the files to make all timestamps use the same timezone. A ZIP
archive created by one library may extract files with "wrong timestamps" when extracted
by another library. Ant's ZIP classes use the same algorithm as the InfoZIP tools and
zlib (timestamps get adjusted), Windows' "compressed folders" function and WinZIP don't
change the timestamps. This means that using the unzip task on files created by Windows'
compressed folders function may create files with timestamps that are "wrong", the same
is true if you use Windows' functions to extract an Ant generated ZIP archive.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:basedir` | `File` | the directory from which to zip the files. | No |
| `:casesensitive` | `boolean` |  |  |
| `:comment` | `String` | Comment to store in the archive. Since Ant 1.6.3 | No |
| `:compress` | `boolean` | Not only store data but also compress them. Unless you set the keepcompression attribute to false, this will apply to the entire archive, not only the files you've added while updating. | No; defaults to true |
| `:createunicodeextrafields` | `UnicodeExtraField` | Whether to create Unicode extra fields to store the file names a second time inside the entry's metadata. Possible values are never, always and not-encodeable which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion below | No; default is never |
| `:defaultexcludes` | `boolean` | indicates whether default excludes should be used or not (yes\|no). | No; defaults to yes |
| `:destfile` | `File` | the zip file to create. | Exactly one of the two |
| `:duplicate` | `Duplicate` | behavior when a duplicate file is found. Valid values are add, preserve, and fail. | No; default is add |
| `:encoding` | `String` | The character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings. | No; defaults to default JVM character encoding |
| `:excludes` | `String` | comma- or space-separated list of patterns of files that must be excluded. | No; defaults to default excludes or none if defaultexcludes is no |
| `:excludesfile` | `File` | name of a file. Each line of this file is taken to be an exclude pattern. | No |
| `:fallbacktoutf8` | `boolean` | Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. Since Ant 1.8.0. See also the discussion below | No; default is false |
| `:file` | `File` |  |  |
| `:filesonly` | `boolean` | Store only file entries. | No; defaults to false |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` | comma- or space-separated list of patterns of files that must be included. | No; defaults to all (**) |
| `:includesfile` | `File` | name of a file. Each line of this file is taken to be an include pattern. | No |
| `:keepcompression` | `boolean` | For entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the compress attribute. Since Ant 1.6 | No; defaults to false |
| `:level` | `int` | Non-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) to 9 (maximum compression/slowest). Since Ant 1.7 | No |
| `:modificationtime` | `String` | Set all stored file modification times to the given time. This can either be a number interpreted as milliseconds since 1970-01-01T00:00:00Z or a string that can be parsed as a ISO 8601 timestamp with optional timezone. Since Ant 1.10.2. | No |
| `:preserve0permissions` | `boolean` | when updating an archive or adding entries from a different archive Ant will assume that a Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values. Set this attribute to true if you really want to preserve the original permission field. Since Ant 1.8.0 | No; default is false |
| `:roundup` | `boolean` | Whether the file modification times will be rounded up to the next even number of seconds. Zip archives store file modification times with a granularity of 2 seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless. Since Ant 1.6.2 | No; defaults to true |
| `:update` | `boolean` | indicates whether to update or overwrite the destination file if it already exists. | No; default is false |
| `:uselanguageencodingflag` | `boolean` | Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. Since Ant 1.8.0. See also the discussion below | No; default is true |
| `:whenempty` | `WhenEmpty` | behavior when no files match. Valid values are fail, skip, and create. | No; default is skip |
| `:zip64mode` | `Zip64ModeAttribute` | When to use Zip64 extensions for entries. The possible values are never, always and as-needed. Since Ant 1.9.1. See also the discussion below | No; default is as-needed |
| `:zipfile` | `File` | deprecated old name of destfile. | Exactly one of the two |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:filename` (`FilenameSelector`)
- `:fileset` (`FileSet`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:patternset` (`PatternSet`)
- `:present` (`PresentSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:type` (`TypeSelector`)
- `:zipfileset` (`ZipFileSet`)
- `:zipgroupfileset` (`FileSet`)

**Reference**

https://ant.apache.org/manual/Tasks/zip.html

**Defined by**

`org.apache.tools.ant.taskdefs.Zip`
sourceraw docstring

zipentryclj

(zipentry & args)

Ant type zipentry. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:archiveFile
:directoryboolean
:encodingString
:existsboolean
:lastmodifiedlong
:modeint
:nameString
:refidReference
:sizelong
:zipfileFile

Reference

https://ant.apache.org/manual/Types/zipentry.html

Defined by

org.apache.tools.ant.types.resources.ZipResource

Ant type zipentry. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:archive` | `File` |  |  |
| `:directory` | `boolean` |  |  |
| `:encoding` | `String` |  |  |
| `:exists` | `boolean` |  |  |
| `:lastmodified` | `long` |  |  |
| `:mode` | `int` |  |  |
| `:name` | `String` |  |  |
| `:refid` | `Reference` |  |  |
| `:size` | `long` |  |  |
| `:zipfile` | `File` |  |  |

**Reference**

https://ant.apache.org/manual/Types/zipentry.html

**Defined by**

`org.apache.tools.ant.types.resources.ZipResource`
sourceraw docstring

zipfilesetclj

(zipfileset & args)

A <zipfileset> is a special form of a <fileset> which can behave in 2 different ways: When the src attribute is used-or a nested resource collection has been specified (since Apache Ant 1.7), the zipfileset is populated with zip entries found in the file src. When the dir attribute is used, the zipfileset is populated with filesystem files found under dir. <zipfileset> supports all attributes of <fileset> in addition to those listed below. Note that zip archives in general don't contain entries with leading slashes so you shouldn't use includes/excludes patterns that start with slashes either. Since Ant 1.6, a zipfileset can be defined with the id attribute and referred to with the refid attribute.

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:dirmodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories. Since Ant 1.5.2No; default is 755
:encodingStringThe character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings. No; defaults to default JVM character encoding
:erroronmissingarchivebooleanSpecify what happens if the archive does not exist. If true, a build error will happen; if false, the fileset will be ignored/empty. Since Ant 1.8.0No; defaults to true
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:filemodeStringA 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files. Since Ant 1.5.2No; default is 644
:followsymlinksboolean
:fullpathStringthe file described by the fileset is placed at that exact location in the archive.No
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:prefixStringall files in the fileset are prefixed with that path in the archive.No
:refidReference
:srcFilemay be used in place of the dir attribute to specify a zip file whose contents will be extracted and included in the archive.No
:srcresourceResource

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

https://ant.apache.org/manual/Types/zipfileset.html

Defined by

org.apache.tools.ant.types.ZipFileSet

A <zipfileset> is a special form of a <fileset> which can behave in 2 different ways:
When the src attribute is used-or a nested resource collection has been specified (since
Apache Ant 1.7), the zipfileset is populated with zip entries found in the file src.
When the dir attribute is used, the zipfileset is populated with filesystem files found
under dir. <zipfileset> supports all attributes of <fileset> in addition to those listed
below. Note that zip archives in general don't contain entries with leading slashes so
you shouldn't use includes/excludes patterns that start with slashes either. Since Ant
1.6, a zipfileset can be defined with the id attribute and referred to with the refid
attribute.

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:dirmode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories. Since Ant 1.5.2 | No; default is 755 |
| `:encoding` | `String` | The character encoding to use for filenames inside the zip file. For a list of possible values see the Supported Encodings. No; defaults to default JVM character encoding |  |
| `:erroronmissingarchive` | `boolean` | Specify what happens if the archive does not exist. If true, a build error will happen; if false, the fileset will be ignored/empty. Since Ant 1.8.0 | No; defaults to true |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:filemode` | `String` | A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files. Since Ant 1.5.2 | No; default is 644 |
| `:followsymlinks` | `boolean` |  |  |
| `:fullpath` | `String` | the file described by the fileset is placed at that exact location in the archive. | No |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:prefix` | `String` | all files in the fileset are prefixed with that path in the archive. | No |
| `:refid` | `Reference` |  |  |
| `:src` | `File` | may be used in place of the dir attribute to specify a zip file whose contents will be extracted and included in the archive. | No |
| `:srcresource` | `Resource` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

https://ant.apache.org/manual/Types/zipfileset.html

**Defined by**

`org.apache.tools.ant.types.ZipFileSet`
sourceraw docstring

zipgroupfilesetclj

(zipgroupfileset & args)

Ant nested zipgroupfileset. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:casesensitiveboolean
:defaultexcludesboolean
:dirFile
:erroronmissingdirboolean
:excludesString
:excludesfileFile
:fileFile
:followsymlinksboolean
:includesString
:includesfileFile
:maxlevelsofsymlinksint
:refidReference

Nested elements

  • :and (AndSelector)
  • :contains (ContainsSelector)
  • :containsregexp (ContainsRegexpSelector)
  • :custom (ExtendSelector)
  • :date (DateSelector)
  • :depend (DependSelector)
  • :depth (DepthSelector)
  • :different (DifferentSelector)
  • :exclude (NameEntry)
  • :excludesfile (NameEntry)
  • :executable (ExecutableSelector)
  • :filename (FilenameSelector)
  • :include (NameEntry)
  • :includesfile (NameEntry)
  • :majority (MajoritySelector)
  • :modified (ModifiedSelector)
  • :none (NoneSelector)
  • :not (NotSelector)
  • :or (OrSelector)
  • :ownedby (OwnedBySelector)
  • :patternset (PatternSet)
  • :posixgroup (PosixGroupSelector)
  • :posixpermissions (PosixPermissionsSelector)
  • :present (PresentSelector)
  • :readable (ReadableSelector)
  • :selector (SelectSelector)
  • :size (SizeSelector)
  • :symlink (SymlinkSelector)
  • :type (TypeSelector)
  • :windowsjunction (WindowsJunctionSelector)
  • :writable (WritableSelector)

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.FileSet

Ant nested zipgroupfileset. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:casesensitive` | `boolean` |  |  |
| `:defaultexcludes` | `boolean` |  |  |
| `:dir` | `File` |  |  |
| `:erroronmissingdir` | `boolean` |  |  |
| `:excludes` | `String` |  |  |
| `:excludesfile` | `File` |  |  |
| `:file` | `File` |  |  |
| `:followsymlinks` | `boolean` |  |  |
| `:includes` | `String` |  |  |
| `:includesfile` | `File` |  |  |
| `:maxlevelsofsymlinks` | `int` |  |  |
| `:refid` | `Reference` |  |  |

**Nested elements**

- `:and` (`AndSelector`)
- `:contains` (`ContainsSelector`)
- `:containsregexp` (`ContainsRegexpSelector`)
- `:custom` (`ExtendSelector`)
- `:date` (`DateSelector`)
- `:depend` (`DependSelector`)
- `:depth` (`DepthSelector`)
- `:different` (`DifferentSelector`)
- `:exclude` (`NameEntry`)
- `:excludesfile` (`NameEntry`)
- `:executable` (`ExecutableSelector`)
- `:filename` (`FilenameSelector`)
- `:include` (`NameEntry`)
- `:includesfile` (`NameEntry`)
- `:majority` (`MajoritySelector`)
- `:modified` (`ModifiedSelector`)
- `:none` (`NoneSelector`)
- `:not` (`NotSelector`)
- `:or` (`OrSelector`)
- `:ownedby` (`OwnedBySelector`)
- `:patternset` (`PatternSet`)
- `:posixgroup` (`PosixGroupSelector`)
- `:posixpermissions` (`PosixPermissionsSelector`)
- `:present` (`PresentSelector`)
- `:readable` (`ReadableSelector`)
- `:selector` (`SelectSelector`)
- `:size` (`SizeSelector`)
- `:symlink` (`SymlinkSelector`)
- `:type` (`TypeSelector`)
- `:windowsjunction` (`WindowsJunctionSelector`)
- `:writable` (`WritableSelector`)

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.FileSet`
sourceraw docstring

zipsclj

(zips & args)

Ant nested zips. (No description bundled.)

Attributes

AttributeTypeDescriptionRequired
:cacheboolean
:refidReference

Reference

Nested-only element discovered via introspection.

Defined by

org.apache.tools.ant.types.resources.Union

Ant nested zips. (No description bundled.)

**Attributes**

| Attribute | Type | Description | Required |
| --- | --- | --- | --- |
| `:cache` | `boolean` |  |  |
| `:refid` | `Reference` |  |  |

**Reference**

Nested-only element discovered via introspection.

**Defined by**

`org.apache.tools.ant.types.resources.Union`
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close