Conditions

Conditions are nested elements of the <condition> and <waitfor> tasks. There are core conditions and custom conditions. Custom conditions are described in Custom Conditions. Core Conditions are described below.

Core Conditions

These are the nested elements that can be used as conditions in the <condition> and <waitfor> tasks.

not

The <not> element expects exactly one other condition to be nested into this element, negating the result of the condition. It doesn't have any attributes and accepts all nested elements of the condition task as nested elements as well.

and

The <and> element doesn't have any attributes and accepts an arbitrary number of conditions as nested elements - all nested elements of the condition task are supported. This condition is true if all of its contained conditions are, conditions will be evaluated in the order they have been specified in the build file.

The <and> condition has the same shortcut semantics as the Java && operator, as soon as one of the nested conditions is false, no other condition will be evaluated.

or

The <or> element doesn't have any attributes and accepts an arbitrary number of conditions as nested elements - all nested elements of the condition task are supported. This condition is true if at least one of its contained conditions is, conditions will be evaluated in the order they have been specified in the build file.

The <or> condition has the same shortcut semantics as the Java || operator, as soon as one of the nested conditions is true, no other condition will be evaluated.

xor

The <xor> element performs an exclusive or on all nested elements, similar to the ^ operator in Java. It only evaluates to true if an odd number of nested conditions are true. There is no shortcutting of evaluation, unlike the <and> and <or> tests. It doesn't have any attributes and accepts all nested elements of the condition task as nested elements as well.

available

This condition is identical to the Available task, all attributes and nested elements of that task are supported, the property and value attributes are redundant and will be ignored.

uptodate

This condition is identical to the Uptodate task, all attributes and nested elements of that task are supported, the property and value attributes are redundant and will be ignored.

os

Test whether the current operating system is of a given type. Each defined attribute is tested and the result is true only if all the tests succeed.

Supported values for the family attribute are:

• windows (for all versions of Microsoft Windows)
• dos (for all Microsoft DOS based operating systems including Microsoft Windows and OS/2)
• mac (for all Apple Macintosh systems)
• unix (for all Unix and Unix-like operating systems)
• netware (for Novell NetWare)
• os/2 (for OS/2)
• tandem (for HP's NonStop Kernel - formerly Tandem)
• win9x for Microsoft Windows 95 and 98, ME and CE
• winnt for Microsoft Windows NT-based systems, including Windows 2000, XP and successors
• z/os for z/OS and OS/390
• os/400 for OS/400
• openvms for OpenVMS

equals

Tests whether the two given Strings are identical

isset

Test whether a given property has been set in this project.

checksum

This condition is identical to the Checksum task, all attributes and nested elements of that task are supported, the property and overwrite attributes are redundant and will be ignored.

http

The http condition checks for a valid response from a web server of the specified url. By default, HTTP responses errors of 400 or greater are viewed as invalid.

socket

The socket condition checks for the existence of a TCP/IP listener at the specified host and port.

filesmatch

Test two files for matching. Nonexistence of one file results in "false", although if neither exists they are considered equal in terms of content. This test does a byte for byte comparision, so test time scales with byte size. NB: if the files are different sizes, one of them is missing or the filenames match the answer is so obvious the detailed test is omitted.

contains

Tests whether a string contains another one.

istrue

Tests whether a string equals any of the ant definitions of true, that is "true","yes", or "on"

<istrue value="${someproperty}"/>
<istrue value="false"/>

isfalse

Tests whether a string is not true, the negation of <istrue>

<isfalse value="${someproperty}"/>
<isfalse value="false"/>

isreference

Test whether a given reference has been defined in this project and - optionally - is of an expected type.

This condition has been added in Apache Ant 1.6.

issigned

Test whether a jarfile is signed. If the name of the signature is passed, the file is checked for presence of that particular signature; otherwise the file is checked for the existence of any signature. It does not perform rigorous signature validation; it only looks for the presence of a signature.

This condition was added in Apache Ant 1.7.

isfileselected

Test whether a file passes an embedded selector.

This condition was added in Apache Ant 1.6.3.

Example usage:

<isfileselected file="a.xml">
  <date datetime="06/28/2000 2:02 pm" when="equal"/>
</isfileselected>

typefound

Test whether a given type is defined, and that its implementation class can be loaded. Types include tasks, datatypes, scriptdefs, macrodefs and presetdefs.

This condition was added in Apache Ant 1.7.

Example usages:

<typefound name="junit"/>
<typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/>

scriptcondition

Evaluate a condition based on a script in any Apache BSF or JSR 223 supported language.

See the Script task for an explanation of scripts and dependencies.

This condition was added in Apache Ant 1.7.

Parameters specified as nested elements

classpath

See the script task for using this nested element.

Description

The script supports script language inline, this script has access to the same beans as the <script> task, and to the self bean, which refers back to the condition itself. The value property of this bean sets the return value:

Example:

<scriptcondition language="javascript"
        value="true">
    self.setValue(false);
</scriptcondition>

parsersupports

Tests whether Ant's XML parser supports a given feature or property, as per the SAX/JAXP specifications, by attempting to set the appropriate property/feature/

This condition was added in Apache Ant 1.7.

<parsersupports feature="http://xml.org/sax/features/namespaces"/>

<or>
  <parsersupports
    feature="http://apache.org/xml/features/validation/schema"/>
  <parsersupports
    feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/>
</or>

<parsersupports
  property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
  value="document.xsd"/>

isreachable

Uses Java1.5+ networking APIs to probe for a (remote) system being reachable. Exactly what probe mechanisms are used is an implementation feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections to port 7 "echo service" or other means. On Java1.4 and earlier, being able to resolve the hostname is considered success. This means that if DNS is not working or a URL/hostname is bad, the test will fail, but otherwise succeed even if the remote host is actually absent.

This condition turns unknown host exceptions into false conditions. This is because on a laptop, DNS is one of the first services when the network goes; you are implicitly offline.

If a URL is supplied instead of a host, the hostname is extracted and used in the test - all other parts of the URL are discarded.

The test may not work through firewalls, that is, something may be reachable using a protocol such as HTTP, while the lower level ICMP packets get dropped on the floor. Similarly, a host may detected as reachable with ICMP, but not reachable on other ports (i.e. port 80), because of firewalls.

This condition was added in Apache Ant 1.7.

<condition property="offline">
  <isreachable url="http://ibiblio.org/maven/" />
</condition>

Probe for the maven repository being reachable.

<condition property="offline">
  <isreachable host="ibiblio.org" timeout="10" />
</condition>

Probe for the maven repository being reachable using the hostname, ten second timeout..

length

This condition is a facet of the Length task. It is used to test the length of a string or one or more files. Since Ant 1.6.3

<length string=" foo " trim="true" length="3" />

Verify a string is of a certain length.

<length file="foo" when="greater" length="0" />

Verify that file foo is not empty.

isfailure

Test the return code of an executable (see the Exec task) for failure. Since Ant 1.7

resourcecount

This condition is a facet of the ResourceCount task. It is used to test the size of a resource collection. Since Ant 1.7

<resourcecount refid="myresourcecollection" when="greater" length="0" />

Verify that a resource collection is not empty.

resourcesmatch

Test resources for matching. Nonexistence of one or more resources results in "false", although if none exists they are considered equal in terms of content. By default this test does a byte for byte comparision, so test time scales with byte size. NB: if the files are different sizes, one of them is missing or the filenames match the answer is so obvious the detailed test is omitted. The resources to check are specified as nested resource collections, meaning that more than two resources can be checked; in this case all resources must match. Since Ant 1.7

hasmethod

Tests for a class having a method or field. If the class is not found or fails to load, the build fails. Since Ant 1.7

There is also a nested <classpath> element, which can be used to specify a classpath.

<hasmethod classname="java.util.ArrayList" method="trimToSize"  />

Looks for the method trimToSize in the ArrayList class.

matches

Test if the specified string matches the specified regular expression pattern. Since Ant 1.7

There is also an optional <regexp> element, which can be used to specify a regular expression instead of the "pattern" attribute. See Regexp Type for the description of the nested element regexp and of the choice of regular expression implementation.

An example:

<condition property="legal-password">
  <matches pattern="[1-9]" string="${user-input}"/>
</condition>
<fail message="Your password should at least contain one number"
      unless="legal-password"/>

The following example sets the property "ok" if the property "input" is three characters long, starting with 'a' and ending with 'b'.

<condition property="ok">
  <matches string="${input}" pattern="^a.b$"/>
</condition>

The following defines a reference regular expression for matching dates and then uses antunit to check if the property "today" is in the correct format:

<regexp id="date.pattern" pattern="^[0123]\d-[01]\d-[12]\d\d\d$"/>

<au:assertTrue xmlns:au="antlib:org.apache.ant.antunit">
  <matches string="${today}">
    <regexp refid="date.pattern"/>
  </matches>
</au:assertTrue>

The following example shows the use of the singleline and the casesensitive flags.

<au:assertTrue>
  <matches string="AB
C" pattern="^ab.*C$"
           casesensitive="false"
           singleline="true"/>
</au:assertTrue>
<au:assertFalse>
  <matches string="AB
C" pattern="^ab.*C$"
           casesensitive="false"
           singleline="false"/>
</au:assertFalse>

antversion

Test the ant version. Since Ant 1.7.0

An example:

<condition property="ant-is-exact-7">
  <antversion exactly="1.7.0"/>
</condition>