Antology

From unkrig.de
(Difference between revisions)
Jump to: navigation, search
(Created page with "<meta name="keywords" content="apache, ant, antlib, library, extension, tasks, types, filters"></meta> <meta name="description" content="A library for APACHE ANT that contribu...")
 
m (Download and installation)
Line 142: Line 142:
 
== Download and installation ==
 
== Download and installation ==
  
The JAR file can be downloaded from
+
Download the "jar-with-dependencies.jar" file from
 
[http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22de.unkrig%22%20AND%20a%3A%22antology%22 MAVENCENTRAL].
 
[http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22de.unkrig%22%20AND%20a%3A%22antology%22 MAVENCENTRAL].
A [[Antology Change Log|Change Log]] is also available.
 
  
 
To make the contributions available in your ANT scripts, write
 
To make the contributions available in your ANT scripts, write
  
  <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-jar-with-dependencies-*.jar" />
+
  <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
 
, or, if you put the JAR file on ANT's default classpath, just
  
 
  <taskdef resource="de/unkrig/antology/ant.xml" />
 
  <taskdef resource="de/unkrig/antology/ant.xml" />
 +
 +
A [[Antology Change Log|Change Log]] is also available.
  
 
== Source code ==
 
== Source code ==

Revision as of 08:22, 15 October 2016

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".

Contents

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.
<retry2>
An enhanced version of the standard <retry> task.
<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.URLConnections, 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 to true 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" />

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".

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox