Editing Antology

<meta name="keywords" content="apache, ant, antlib, library, extension, tasks, types, filters"></meta>
<meta name="description" content="A library for APACHE ANT that contributes many useful, resource collections, and other types"></meta>
This library contributes useful tasks and types to [http://ant.apache.org APACHE ANT]. It integrates seamlessly with other libraries like [http://ant-contrib.sourceforge.net/ ant-contrib].

ANTOLOGY was formerly known as "[[Ant-contrib.unkrig.de]]".

== Tasks ==

=== In Alphabetical Order ===

: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/break.html            <code><break></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/continue.html         <code><continue></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/follow.html           <code><follow></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/forEach2.html         <code><forEach2></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/ftp2.html             <code><ftp2></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/jsonProperty.html     <code><jsonProperty></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/log.html              <code><log></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/logging.html          <code><logging></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/nslookup.html         <code><nslookup></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/propertyXml2.html     <code><propertyXml2></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/retry.html            <code><retry2></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/setAuthenticator.html <code><setAuthenticator></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/setCookieHandler.html <code><setCookieHandler></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/simpleLogging.html    <code><simpleLogging></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/swingDialog.html      <code><swingDialog></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/swingLookAndFeel.html <code><swingLookAndFeel></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/throughput.html       <code><throughput></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/urlConnection.html    <code><urlConnection></code>]
: [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/xmlProperty2.html     <code><xmlProperty2></code>]

=== By Function Group ===

==== Control Flow Tasks ====

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/break.html <code><break></code>]
:Terminates the execution of the enclosing <code><forEach2></code> task.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/continue.html <code><continue></code>]
:Causes the enclosing <code><forEach2></code> task to continue with the next iteration element.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/follow.html <code><follow></code>]
:Waits until a file grows.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/forEach2.html <code><forEach2></code>]
:An enhanced version of [http://ant-contrib.sourceforge.net/tasks/tasks/for.html the <code><for></code> task of ant-contrib.sourceforge.net].

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/retry.html <code><retry2></code>]
:An enhanced version of the standard [http://ant.apache.org/manual/Tasks/retry.html <code><retry></code>] task.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/throughput.html <code><throughput></code>]
:Measures expired time and calculates and displays throughput rates and estimated remaining times.

==== Text Processing Tasks ====

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/jsonProperty.html <code><jsonProperty></code>]
:Parses a JSON document into a set of properties, in analogy with [http://ant.apache.org/manual/Tasks/xmlproperty.html the standard ANT <code><xmlproperty></code> task].

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/propertyXml2.html <code><propertyXml2></code>]
:Creates an XML document from ANT properties; the counterpart of the [jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/xmlProperty2.html <code><xmlProperty2> task</code>].

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/xmlProperty2.html <code><xmlProperty2></code>]
:Parses an XML document into ANT properties. Resembles [http://ant.apache.org/manual/Tasks/xmlproperty.html ANT's standard <xmlproperty> task], but maps the XML DOM in a different, more detailed way.

==== Logging Tasks ====

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/log.html <code><log></code>]
:Logs one message through <code>java.util.logging</code>.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/logging.html <code><logging></code>]
:Configures one or more loggers of the <code>java.util.logging</code> logging component.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/simpleLogging.html <code><simpleLogging></code>]
:Configures the [http://commons.unkrig.de/javadoc/de/unkrig/commons/util/logging/SimpleLogging.html <code>de.unkrig.commons.util.logging.SimpleLogging</code>] facility.

==== Networking Tasks ====

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/ftp2.html <code><ftp2></code>]
:Extends ANT's standard <code><ftp></code> with support for proxies.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/nslookup.html <code><nslookup></code>]
:Resolves a host name or IP address.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/setAuthenticator.html <code><setAuthenticator></code>]
:Configures the authentication for all following [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.URLConnection</code>]s, including the <code><urlConnection></code> task.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/setCookieHandler.html <code><setCookieHandler></code>]
:Enables or disables cookie handling for Java's [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.HttpURLConnection</code>], including the <code><urlConnection></code> task.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/urlConnection.html <code><urlConnection></code>]
:Connects to a resource and writes data to it and/or reads data from it.

==== UI Tasks ====

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/swingDialog.html <code><swingDialog></code>]
:Pops up a highly configurable dialog and invites the user to fill in form fields.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?tasks/swingLookAndFeel.html <code><swingLookAndFeel></code>]
:Sets the SWING look-and-feel for this JVM, or retrieves look-and-feel-related information from the JVM.

== Resource Collections ==

A [http://antology.org/manual/Types/resources.html#collection resource collection] represents a group of resources. A resource is an entity that has a name and a value. An often-used example of a resource collection is the <code><fileSet></code> type, where each resource is a file with its name and its contents.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?resourceCollections/literalResource.html <code><literalResource></code>]
:A read-only resource with a name and a literal value - configurable either through <code>value="..."</code> or nested text.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?resourceCollections/resourceCollectionDelta.html <code><resourceCollectionDelta></code>]
:Selects the subset of resources that was added, deleted or modified since the last check.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?resourceCollections/resourceNames.html <code><resourceNames></code>]
:Replaces the resources' values with their names.

== Chainable Readers ==

[http://ant.apache.org/manual/Types/filterchain.html Filter readers] are an ANT concept that mimics the functionality of UNIX' pipes: A stream of bytes is read through a chain of filter readers, where each filter reader modifies the byte stream and/or performs some additional actions.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?chainableReaders/progress.html <code><progress></code>]
:Prints dots (".") to STDERR as data is read through it. This implements a kind of 'progress monitoring' for slow tasks that read some data.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?chainableReaders/tee.html <code><tee></code>]
:Passes data through unmodified, and copies it to a second filter chain.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?chainableReaders/patch.html <code><patch></code>]
:Modifies the data by applying a patch file.

== Conditions ==

[http://ant.apache.org/manual/Tasks/conditions.html Conditions] are nested elements of the <code><condition></code>, <code><waitfor></code> and several other tasks.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?conditions/every.html <code><every></code>]
:Evaluates to <code>true</code> when it is evaluated for the <b>first time</b>, and when the last evaluation to <code>true</code> has been more than a configured interval ago.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?conditions/false.html <code><false></code>]
:Always evaluates to <code>false</code>.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?conditions/successful.html <code><successful></code>]
:Executes the tasks configured as subelements sequentially and evaluates to whether all subtasks have completed successfully.

;[jar:https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc!/index.html?conditions/true.html <code><true></code>]
:Always evaluates to <code>true</code>.

== Download and installation ==

Download the "jar-with-dependencies.jar" file from
[https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=jar-with-dependencies MAVENCENTRAL].

To make the contributions available in your ANT scripts, write

 <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-jar-with-dependencies-x.y.z.jar" />

, or, if you put the JAR file on ANT's default classpath, just

 <taskdef resource="de/unkrig/antology/ant.xml" />

ANTDOC documentation can be found [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=antology&v=LATEST&c=javadoc here].

A [[Antology Change Log|Change Log]] is also available.

== Source code ==

The source code is available on GITHUB: https://github.com/aunkrig/antology

== License ==

ANTOLOGY is published under the "[[New BSD License]]".