Ant-contrib.unkrig.de: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Abstract ==
<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 project was renamed to "[[Antology]]" to get rid of the constant confusion with the (related, but otherwise independent) "[http://ant-contrib.sourceforge.net/ ant-contrib]" project on SOURCEFORGE.


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] (which is not to be confused with this one).
As a consequence, in all your ANT build scripts, you have to change


== Tasks ==
  <taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" />


;[[Ant-contrib.unkrig.de / Tasks / break|<code><break></code>]]
to
:Terminates the execution of the enclosing [[Ant-contrib.unkrig.de / Tasks / forEach2|<code><forEach2></code>]].


;[[Ant-contrib.unkrig.de / Tasks / continue|<code><continue></code>]]
  <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-x.y.z-jar-with-dependencies.jar" />
:Causes the enclosing [[Ant-contrib.unkrig.de / Tasks / forEach2|<code><forEach2></code>]] task to continue with the next iteration element.


;[[Ant-contrib.unkrig.de / Tasks / follow|<code><follow></code>]]
. That's all, folks!
:Waits until a file grows.
 
;[[Ant-contrib.unkrig.de / Tasks / forEach2|<code><forEach2></code>]]
:An enhanced version of [http://ant-contrib.sourceforge.net/tasks/tasks/for.html the FOR task of ant-contrib].
 
;[[Ant-contrib.unkrig.de / Tasks / jsonProperty|<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].
 
;[[Ant-contrib.unkrig.de / Tasks / nslookup|<code><nslookup></code>]]
:Resolves a host name or IP address.
 
;[[Ant-contrib.unkrig.de / Tasks / retry2|<code><retry2></code>]]
:An enhanced version of the [http://ant.apache.org/manual/Tasks/retry.html RETRY task].
 
;[[Ant-contrib.unkrig.de / Tasks / setAuthenticator|<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 [[Ant-contrib.unkrig.de / Tasks / urlConnection|<code><urlConnection></code>]] task.
 
;[[Ant-contrib.unkrig.de / Tasks / setCookieHandler|<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 [[Ant-contrib.unkrig.de / Tasks / urlConnection|<code><urlConnection></code>]] task.
 
;[[Ant-contrib.unkrig.de / Tasks / swingDialog|<code><swingDialog></code>]]
:Pops up a highly configurable dialog and invites the user to fill in form fields.
 
;[[Ant-contrib.unkrig.de / Tasks / throughput|<code><throughput></code>]]
:Measures expired time and calculates and displays throughput rates and estimated remaining times.
 
;[[Ant-contrib.unkrig.de / Tasks / urlConnection|<code><urlConnection></code>]]
:Connects to a resource and writes data to it and/or reads data from it.
 
== Resource Collections ==
 
A [http://ant.apache.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.
 
;[[Ant-contrib.unkrig.de / Resource Collections / resourceCollectionDelta|<code><resourceCollectionDelta></code>]]
:Selects the subset of resources that was added, deleted or modified since the last check.
 
;[[Ant-contrib.unkrig.de / Resource Collections / resourceNames|<code><resourceNames></code>]]
:Replaces the resources' values with their names.
 
== Filter 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.
 
;[[Ant-contrib.unkrig.de / Filter Readers / progress|<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.
 
== 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.
 
;<code><true></code>, <code><false></code>
:Always evaluate to <code>true</code> resp. <code>false</code>.
 
;<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.
 
;<code><successful></code>
:Executes the tasks configured as subelements sequentially and evaluates to whether all subtasks have completed successfully.
 
== Download and installation ==
 
The JAR file can be downloaded from http://ant-contrib.unkrig.de/download/.
 
To make the contributions available in your ANT scripts, write
 
<taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" />
 
, or, if you put the JAR file on ANT's default classpath, just
 
<taskdef resource="de/unkrig/antcontrib/ant.xml" />
 
== Source code ==
 
The source code is available in the SUBVERSION repository. The repository URL is
 
https://svn.code.sf.net/p/loggifier/code
 
== License ==
 
ANT-CONTRIB is published under the "[[New BSD License]]".

Latest revision as of 09:58, 17 November 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 project was renamed to "Antology" to get rid of the constant confusion with the (related, but otherwise independent) "ant-contrib" project on SOURCEFORGE.

As a consequence, in all your ANT build scripts, you have to change

 <taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" />

to

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

. That's all, folks!