Antology: Difference between revisions
Line 33: | Line 33: | ||
==== Control Flow Tasks ==== | ==== Control Flow Tasks ==== | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/break.html <code><break></code>] | ||
:Terminates the execution of the enclosing <code><forEach2></code> task. | :Terminates the execution of the enclosing <code><forEach2></code> task. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/continue.html <code><continue></code>] | ||
:Causes the enclosing <code><forEach2></code> task to continue with the next iteration element. | :Causes the enclosing <code><forEach2></code> task to continue with the next iteration element. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/follow.html <code><follow></code>] | ||
:Waits until a file grows. | :Waits until a file grows. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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]. | :An enhanced version of [http://ant-contrib.sourceforge.net/tasks/tasks/for.html the <code><for></code> task of ant-contrib.sourceforge.net]. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :An enhanced version of the standard [http://ant.apache.org/manual/Tasks/retry.html <code><retry></code>] task. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/throughput.html <code><throughput></code>] | ||
:Measures expired time and calculates and displays throughput rates and estimated remaining times. | :Measures expired time and calculates and displays throughput rates and estimated remaining times. | ||
==== Text Processing Tasks ==== | ==== Text Processing Tasks ==== | ||
;[ | ;[http://antology.unkrig.de/antdoc/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]. | :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]. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/propertyXml2.html <code><propertyXml2></code>] | ||
:Creates an XML document from ANT properties; the counterpart of the [ | :Creates an XML document from ANT properties; the counterpart of the [http://antology.unkrig.de/antdoc/index.html?tasks/xmlProperty2.html <code><xmlProperty2> task</code>]. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :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 ==== | ==== Logging Tasks ==== | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/log.html <code><log></code>] | ||
:Logs one message through <code>java.util.logging</code>. | :Logs one message through <code>java.util.logging</code>. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/logging.html <code><logging></code>] | ||
:Configures one or more loggers of the <code>java.util.logging</code> logging component. | :Configures one or more loggers of the <code>java.util.logging</code> logging component. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :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 ==== | ==== Networking Tasks ==== | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/ftp2.html <code><ftp2></code>] | ||
:Extends ANT's standard <code><ftp></code> with support for proxies. | :Extends ANT's standard <code><ftp></code> with support for proxies. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/nslookup.html <code><nslookup></code>] | ||
:Resolves a host name or IP address. | :Resolves a host name or IP address. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :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. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :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. | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/urlConnection.html <code><urlConnection></code>] | ||
:Connects to a resource and writes data to it and/or reads data from it. | :Connects to a resource and writes data to it and/or reads data from it. | ||
==== UI Tasks ==== | ==== UI Tasks ==== | ||
;[ | ;[http://antology.unkrig.de/antdoc/index.html?tasks/swingDialog.html <code><swingDialog></code>] | ||
:Pops up a highly configurable dialog and invites the user to fill in form fields. | :Pops up a highly configurable dialog and invites the user to fill in form fields. | ||
;[ | ;[http://antology.unkrig.de/antdoc/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. | :Sets the SWING look-and-feel for this JVM, or retrieves look-and-feel-related information from the JVM. | ||
Revision as of 14:15, 20 October 2016
<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 APACHE ANT. It integrates seamlessly with other libraries like ant-contrib.
ANTOLOGY was formerly known as "Ant-contrib.unkrig.de".
Tasks
In Alphabetical Order
<break>
<continue>
<follow>
<forEach2>
<ftp2>
<jsonProperty>
<log>
<logging>
<nslookup>
<propertyXml2>
<retry2>
<setAuthenticator>
<setCookieHandler>
<simpleLogging>
<swingDialog>
<swingLookAndFeel>
<throughput>
<urlConnection>
<xmlProperty2>
By Function Group
Control Flow Tasks
<break>
- Terminates the execution of the enclosing
<forEach2>
task.
<continue>
- Causes the enclosing
<forEach2>
task to continue with the next iteration element.
<follow>
- Waits until a file grows.
<forEach2>
- An enhanced version of the
<for>
task of ant-contrib.sourceforge.net.
<throughput>
- Measures expired time and calculates and displays throughput rates and estimated remaining times.
Text Processing Tasks
<jsonProperty>
- Parses a JSON document into a set of properties, in analogy with the standard ANT
<xmlproperty>
task.
<propertyXml2>
- Creates an XML document from ANT properties; the counterpart of the
<xmlProperty2> task
.
<xmlProperty2>
- Parses an XML document into ANT properties. Resembles ANT's standard <xmlproperty> task, but maps the XML DOM in a different, more detailed way.
Logging Tasks
<log>
- Logs one message through
java.util.logging
.
<logging>
- Configures one or more loggers of the
java.util.logging
logging component.
<simpleLogging>
- Configures the
de.unkrig.commons.util.logging.SimpleLogging
facility.
Networking Tasks
<ftp2>
- Extends ANT's standard
<ftp>
with support for proxies.
<nslookup>
- Resolves a host name or IP address.
<setAuthenticator>
- Configures the authentication for all following
java.net.URLConnection
s, including the<urlConnection>
task.
<setCookieHandler>
- Enables or disables cookie handling for Java's
java.net.HttpURLConnection
, including the<urlConnection>
task.
<urlConnection>
- Connects to a resource and writes data to it and/or reads data from it.
UI Tasks
<swingDialog>
- Pops up a highly configurable dialog and invites the user to fill in form fields.
<swingLookAndFeel>
- Sets the SWING look-and-feel for this JVM, or retrieves look-and-feel-related information from the JVM.
Resource Collections
A 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 <fileSet>
type, where each resource is a file with its name and its contents.
<literalResource>
- A read-only resource with a name and a literal value - configurable either through
value="..."
or nested text.
<resourceCollectionDelta>
- Selects the subset of resources that was added, deleted or modified since the last check.
<resourceNames>
- Replaces the resources' values with their names.
Chainable Readers
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.
<progress>
- Prints dots (".") to STDERR as data is read through it. This implements a kind of 'progress monitoring' for slow tasks that read some data.
<tee>
- Passes data through unmodified, and copies it to a second filter chain.
<patch>
- Modifies the data by applying a patch file.
Conditions
Conditions are nested elements of the <condition>
, <waitfor>
and several other tasks.
<every>
- Evaluates to
true
when it is evaluated for the first time, and when the last evaluation totrue
has been more than a configured interval ago.
<false>
- Always evaluates to
false
.
<successful>
- Executes the tasks configured as subelements sequentially and evaluates to whether all subtasks have completed successfully.
<true>
- Always evaluates to
true
.
Download and installation
Download the "jar-with-dependencies.jar" file from 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 here.
A 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".