youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: f04cc8bb19
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f04cc8bb19'
${ noResults }
ant/manual/Tasks/conditions.html

1131 lines
36 KiB
Raw Blame History 

  1. <!--

  2.    Licensed to the Apache Software Foundation (ASF) under one or more

  3.    contributor license agreements.  See the NOTICE file distributed with

  4.    this work for additional information regarding copyright ownership.

  5.    The ASF licenses this file to You under the Apache License, Version 2.0

  6.    (the "License"); you may not use this file except in compliance with

  7.    the License.  You may obtain a copy of the License at

  8. 

  9.        http://www.apache.org/licenses/LICENSE-2.0

  10. 

  11.    Unless required by applicable law or agreed to in writing, software

  12.    distributed under the License is distributed on an "AS IS" BASIS,

  13.    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  14.    See the License for the specific language governing permissions and

  15.    limitations under the License.

  16. -->

  17. <html>

  18. 

  19. <head>

  20. <meta http-equiv="Content-Language" content="en-us">

  21. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">

  22. <title>Conditions Task</title>

  23. </head>

  24. 

  25. <body>

  26. 

  27. <h2><a name="Conditions">Conditions</a></h2>

  28.   <p>Conditions are nested elements of the 

  29. <a href="condition.html"><code>&lt;condition&gt;</code></a> and

  30. <a href="waitfor.html"><code>&lt;waitfor&gt;</code></a> tasks.

  31.     There are core conditions and custom conditions. Custom

  32.     conditions are described in

  33.     <a href="../Types/custom-programming.html#customconditions">

  34.       Custom Conditions</a>.

  35.     Core Conditions are described below.

  36.   </p>

  37.   <h3><a name="coreconditions">Core Conditions</a></h3>

  38. 

  39. <p>These are the nested elements that can be used as conditions in the

  40. <a href="condition.html"><code>&lt;condition&gt;</code></a> and

  41. <a href="waitfor.html"><code>&lt;waitfor&gt;</code></a> tasks.</p>

  42. 

  43. <h4><a name="not">not</a></h4>

  44. <p>The <code>&lt;not&gt;</code> element expects exactly one other

  45. condition to be nested into this element, negating the result of the

  46. condition.  It doesn't have any attributes and accepts all nested

  47. elements of the condition task as nested elements as well.</p>

  48. 

  49. <h4><a name="and">and</a></h4> <p>

  50. The <code>&lt;and&gt;</code> element doesn't have any attributes and

  51. accepts an arbitrary number of conditions as nested elements - all

  52. nested elements of the condition task are supported.  This condition

  53. is true if all of its contained conditions are, conditions will be

  54. evaluated in the order they have been specified in the build file.</p>

  55. <p>The <code>&lt;and&gt;</code> condition has the same shortcut

  56. semantics as the Java &amp;&amp; operator, as soon as one of the

  57. nested conditions is false, no other condition will be evaluated.</p>

  58. 

  59. <h4><a name="or">or</a></h4> <p>

  60. The <code>&lt;or&gt;</code> element doesn't have any attributes and

  61. accepts an arbitrary number of conditions as nested elements - all

  62. nested elements of the condition task are supported.  This condition

  63. is true if at least one of its contained conditions is, conditions

  64. will be evaluated in the order they have been specified in the build

  65. file.</p> <p>The <code>&lt;or&gt;</code> condition has the same

  66. shortcut semantics as the Java || operator, as soon as one of the

  67. nested conditions is true, no other condition will be evaluated.</p>

  68. 

  69. <h4><a name="xor">xor</a></h4>

  70. <p>The <code>&lt;xor&gt;</code> element performs an exclusive

  71. or on all nested elements, similar to the <code>^</code> operator

  72. in Java. It only evaluates to true if an odd number of nested conditions

  73. are true. There is no shortcutting of evaluation, unlike the <code>&lt;and&gt;</code>

  74. and <code>&lt;or&gt;</code> tests.

  75. It doesn't have any attributes and accepts all nested

  76. elements of the condition task as nested elements as well.</p>

  77. 

  78. <h4><a name="available">available</a></h4>

  79. <p>This condition is identical to the <a

  80. href="available.html">Available</a> task, all attributes and nested

  81. elements of that task are supported, the property and value attributes

  82. are redundant and will be ignored.</p>

  83. 

  84. <h4><a name="uptodate">uptodate</a></h4>

  85. <p>This condition is identical to the <a

  86. href="uptodate.html">Uptodate</a> task, all attributes and nested

  87. elements of that task are supported, the property and value attributes

  88. are redundant and will be ignored.</p>

  89. 

  90. <h4><a name="os">os</a></h4>

  91. <p>Test whether the current operating system is of a given type.  Each

  92. defined attribute is tested and the result is true only if <i>all</i>

  93. the tests succeed.

  94. </p>

  95. <table border="1" cellpadding="2" cellspacing="0">

  96.   <tr>

  97.     <td valign="top"><b>Attribute</b></td>

  98.     <td valign="top"><b>Description</b></td>

  99.     <td align="center" valign="top"><b>Required</b></td>

  100.   </tr>

  101.   <tr>

  102.     <td valign="top">family</td>

  103.     <td valign="top">The name of the operating system family to expect.</td>

  104.     <td valign="top" align="center">No</td>

  105.   </tr>

  106.   <tr>

  107.     <td valign="top">name</td>

  108.     <td valign="top">The name of the operating system to expect.</td>

  109.     <td valign="top" align="center">No</td>

  110.   </tr>

  111.   <tr>

  112.     <td valign="top">arch</td>

  113.     <td valign="top">The architecture of the operating system to expect.</td>

  114.     <td valign="top" align="center">No</td>

  115.   </tr>

  116.   <tr>

  117.     <td valign="top">version</td>

  118.     <td valign="top">The version of the operating system to expect.</td>

  119.     <td valign="top" align="center">No</td>

  120.   </tr>

  121. </table>

  122. <p>Supported values for the family attribute are:

  123. <ul>

  124.   <li>windows (for all versions of Microsoft Windows)</li>

  125.   <li>dos (for all Microsoft DOS based operating systems including

  126.     Microsoft Windows and OS/2)</li>

  127.   <li>mac (for all Apple Macintosh systems)</li>

  128.   <li>unix (for all Unix and Unix-like operating systems)</li>

  129.   <li>netware (for Novell NetWare)</li>

  130.   <li>os/2 (for OS/2)</li>

  131.   <li>tandem (for HP's NonStop Kernel - formerly Tandem)</li>

  132.   <li>win9x for Microsoft Windows 95 and 98, ME and CE</li>

  133.   <li>winnt for Microsoft Windows NT-based systems, including Windows 2000, XP and

  134.       successors</li>

  135.   <li>z/os for z/OS and OS/390</li>

  136.   <li>os/400 for OS/400</li>

  137.   <li>openvms for OpenVMS</li>

  138. </ul>

  139. 

  140. <h4><a name="equals">equals</a></h4>

  141. <p>Tests whether the two given values are equal.</p>

  142. <table border="1" cellpadding="2" cellspacing="0">

  143.   <tr>

  144.     <td valign="top"><b>Attribute</b></td>

  145.     <td valign="top"><b>Description</b></td>

  146.     <td align="center" valign="top"><b>Required</b></td>

  147.   </tr>

  148.   <tr>

  149.     <td valign="top">arg1</td>

  150.     <td valign="top">First value to test.</td>

  151.     <td valign="top" align="center">Yes</td>

  152.   </tr>

  153.   <tr>

  154.     <td valign="top">arg2</td>

  155.     <td valign="top">Second value to test.</td>

  156.     <td valign="top" align="center">Yes</td>

  157.   </tr>

  158.   <tr>

  159.     <td valign="top">casesensitive</td>

  160.     <td valign="top">Perform a case sensitive comparison.  Default is

  161.         true.</td>

  162.     <td valign="top" align="center">No</td>

  163.   </tr>

  164.   <tr>

  165.     <td valign="top">trim</td>

  166.     <td valign="top">Trim whitespace from arguments before comparing

  167.         them.  Default is false.</td>

  168.     <td valign="top" align="center">No</td>

  169.   </tr>

  170.   <tr>

  171.     <td valign="top">forcestring</td>

  172.     <td valign="top">Force string comparison of <code>arg1/arg2</code>.

  173.         Default is false.  <em>Since Apache Ant 1.8.1</em>

  174.     </td>

  175.     <td valign="top" align="center">No</td>

  176.   </tr>

  177. </table>

  178. 

  179. <h4><a name="isset">isset</a></h4>

  180. <p>Test whether a given property has been set in this project.</p>

  181. <table border="1" cellpadding="2" cellspacing="0">

  182.   <tr>

  183.     <td valign="top"><b>Attribute</b></td>

  184.     <td valign="top"><b>Description</b></td>

  185.     <td align="center" valign="top"><b>Required</b></td>

  186.   </tr>

  187.   <tr>

  188.     <td valign="top">property</td>

  189.     <td valign="top">The name of the property to test.</td>

  190.     <td valign="top" align="center">Yes</td>

  191.   </tr>

  192. </table>

  193. 

  194. <h4><a name="checksum">checksum</a></h4>

  195. <p>This condition is identical to the <a href="checksum.html">Checksum</a>

  196. task, all attributes and nested elements of that task are supported,

  197. the property and overwrite attributes are redundant and will be

  198. ignored.</p>

  199. 

  200. <h4><a name="http">http</a></h4>

  201. <p>The <code>http</code> condition checks for a valid response from a

  202. web server of the specified url. By default, HTTP responses errors

  203. of 400 or greater are viewed as invalid.</p>

  204. <table border="1" cellpadding="2" cellspacing="0">

  205.   <tr>

  206.     <td width="12%" valign="top"><b>Attribute</b></td>

  207.     <td width="78%" valign="top"><b>Description</b></td>

  208.     <td width="10%" valign="top"><b>Required</b></td>

  209.   </tr>

  210.   <tr>

  211.     <td valign="top">url</td>

  212.     <td valign="top">The full URL of the page to request. The web server must

  213.       return a status code below the value of <tt>errorsBeginAt</tt></td>

  214.     <td align="center">Yes.</td>

  215.   </tr>

  216.   <tr>

  217.     <td valign="top">errorsBeginAt</td>

  218.     <td valign="top">The lowest HTTP response code that signals an error;

  219.     by default '400'; server errors, not-authorized, not-found and the like

  220.     are detected</td>

  221.     <td align="center">No</td>

  222.   </tr>

  223.   <tr>

  224.     <td valign="top">requestMethod</td>

  225.     <td valign="top">The HTTP method to be used when issuing the request.

  226.     Any of GET, POST, HEAD, OPTIONS, PUT, DELETEm and TRACE

  227.     are valid, subject to protocol restrictions. The default if not

  228.     specified is &quot;GET&quot;.<br/>

  229.       <em>since Ant 1.8.0</em></td>

  230.     <td align="center">No</td>

  231.   </tr>

  232.   <tr>

  233.     <td valign="top">followRedirects</td>

  234.     <td valign="top">Whether redirects should be followed. The default

  235.       is <code>true</code><br/>

  236.       <em>since Ant 1.9.7</em></td>

  237.     <td align="center">No</td>

  238.   </tr>

  239. </table>

  240. 

  241. <h4><a name="socket">socket</a></h4>

  242. <p>The <code>socket</code> condition checks for the existence of a

  243. TCP/IP listener at the specified host and port.</p>

  244. <table border="1" cellpadding="2" cellspacing="0">

  245.   <tr>

  246.     <td width="12%" valign="top"><b>Attribute</b></td>

  247.     <td width="78%" valign="top"><b>Description</b></td>

  248.     <td width="10%" valign="top"><b>Required</b></td>

  249.   </tr>

  250.   <tr>

  251.     <td valign="top">server</td>

  252.     <td valign="top">The DNS name or IP address of the server.</td>

  253.     <td align="center">Yes.</td>

  254.   </tr>

  255.   <tr>

  256.     <td valign="top">port</td>

  257.     <td valign="top">The port number to connect to.</td>

  258.     <td align="center">Yes.</td>

  259.   </tr>

  260. </table>

  261. 

  262. <h4><a name="filesmatch">filesmatch</a></h4>

  263. <p>Test two files for matching. Nonexistence of one file results in "false",

  264. although if neither exists they are considered equal in terms of content.

  265. This test does a byte for byte comparison, so test time scales with

  266. byte size. NB: if the files are different sizes, one of them is missing

  267. or the filenames match the answer is so obvious the detailed test is omitted.

  268. 

  269. </p>

  270. <table border="1" cellpadding="2" cellspacing="0">

  271.   <tr>

  272.     <td width="12%" valign="top"><b>Attribute</b></td>

  273.     <td width="78%" valign="top"><b>Description</b></td>

  274.     <td width="10%" valign="top"><b>Required</b></td>

  275.   </tr>

  276.   <tr>

  277.     <td valign="top">file1</td>

  278.     <td valign="top">First file to test</td>

  279.     <td align="center">Yes</td>

  280.   </tr>

  281.   <tr>

  282.     <td valign="top">file2</td>

  283.     <td valign="top">Second file to test</td>

  284.     <td align="center">Yes</td>

  285.   </tr>

  286.   <tr>

  287.     <td valign="top">textfile</td>

  288.     <td valign="top">Whether to ignore line endings when comparing

  289.         files; defaults to <i>false</i> which triggers a binary

  290.         comparison. <b>Since Ant 1.7</b>

  291.     </td>

  292.     <td align="center">No</td>

  293.   </tr>

  294. </table>

  295. 

  296. <h4><a name="contains">contains</a></h4>

  297. <p>Tests whether a string contains another one.</p>

  298. <table border="1" cellpadding="2" cellspacing="0">

  299.   <tr>

  300.     <td valign="top"><b>Attribute</b></td>

  301.     <td valign="top"><b>Description</b></td>

  302.     <td align="center" valign="top"><b>Required</b></td>

  303.   </tr>

  304.   <tr>

  305.     <td valign="top">string</td>

  306.     <td valign="top">The string to search in.</td>

  307.     <td valign="top" align="center">Yes</td>

  308.   </tr>

  309.   <tr>

  310.     <td valign="top">substring</td>

  311.     <td valign="top">The string to search for.</td>

  312.     <td valign="top" align="center">Yes</td>

  313.   </tr>

  314.   <tr>

  315.     <td valign="top">casesensitive</td>

  316.     <td valign="top">Perform a case sensitive comparison.  Default is

  317.         true.</td>

  318.     <td valign="top" align="center">No</td>

  319.   </tr>

  320. </table>

  321. 

  322. <h4><a name="istrue">istrue</a></h4>

  323. <p>Tests whether a string equals any of the ant definitions of true,

  324. that is "true","yes", or "on"</p>

  325. <table border="1" cellpadding="2" cellspacing="0">

  326.   <tr>

  327.     <td valign="top"><b>Attribute</b></td>

  328.     <td valign="top"><b>Description</b></td>

  329.     <td align="center" valign="top"><b>Required</b></td>

  330.   </tr>

  331.   <tr>

  332.     <td valign="top">value</td>

  333.     <td valign="top">value to test</td>

  334.     <td valign="top" align="center">Yes</td>

  335.   </tr>

  336. </table>

  337. <blockquote><pre>

  338. &lt;istrue value=&quot;${someproperty}&quot;/&gt;

  339. &lt;istrue value=&quot;false&quot;/&gt;

  340. </pre></blockquote>

  341. 

  342. <h4><a name="isfalse">isfalse</a></h4>

  343. <p>Tests whether a string is not true, the negation of &lt;istrue&gt;

  344. </p>

  345. <table border="1" cellpadding="2" cellspacing="0">

  346.   <tr>

  347.     <td valign="top"><b>Attribute</b></td>

  348.     <td valign="top"><b>Description</b></td>

  349.     <td align="center" valign="top"><b>Required</b></td>

  350.   </tr>

  351.   <tr>

  352.     <td valign="top">value</td>

  353.     <td valign="top">value to test</td>

  354.     <td valign="top" align="center">Yes</td>

  355.   </tr>

  356. </table>

  357. <blockquote><pre>

  358. &lt;isfalse value=&quot;${someproperty}&quot;/&gt;

  359. &lt;isfalse value=&quot;false&quot;/&gt;

  360. </pre></blockquote>

  361. 

  362. <h4><a name="isreference">isreference</a></h4>

  363. 

  364. <p>Test whether a given reference has been defined in this project and

  365. - optionally - is of an expected type.</p>

  366. 

  367. <p>This condition has been added in Apache Ant 1.6.</p>

  368. 

  369. <table border="1" cellpadding="2" cellspacing="0">

  370.   <tr>

  371.     <td valign="top"><b>Attribute</b></td>

  372.     <td valign="top"><b>Description</b></td>

  373.     <td align="center" valign="top"><b>Required</b></td>

  374.   </tr>

  375.   <tr>

  376.     <td valign="top">refid</td>

  377.     <td valign="top">The id of the reference to test.</td>

  378.     <td valign="top" align="center">Yes</td>

  379.   </tr>

  380.   <tr>

  381.     <td valign="top">type</td>

  382.     <td valign="top">Name of the data type or task this reference is

  383.        expected to be.</td>

  384.     <td valign="top" align="center">No</td>

  385.   </tr>

  386. </table>

  387. 

  388. <h4><a name="issigned">issigned</a></h4>

  389.   <p>

  390.     Test whether a jarfile is signed.

  391.     If the name of the

  392.     signature is passed, the file is checked for presence of that

  393.     particular signature; otherwise the file is checked for the

  394.     existence of any signature. It does not perform rigorous

  395.     signature validation; it only looks for the presence of a signature.

  396.   </p>

  397.   <p>

  398.     This condition was added in Apache Ant 1.7.

  399.   </p>

  400.   <table border="1" cellpadding="2" cellspacing="0">

  401.   <tr>

  402.     <td valign="top"><b>Attribute</b></td>

  403.     <td valign="top"><b>Description</b></td>

  404.     <td align="center" valign="top"><b>Required</b></td>

  405.   </tr>

  406.   <tr>

  407.     <td valign="top">file</td>

  408.     <td valign="top">

  409.       The jarfile that is to be tested for the presence

  410.       of a signature.

  411.     </td>

  412.     <td valign="top" align="center">Yes</td>

  413.   </tr>

  414.   <tr>

  415.     <td valign="top">name</td>

  416.     <td valign="top"> The signature name to check for.</td>

  417.     <td valign="top" align="center">No</td>

  418.   </tr>

  419.   </table>

  420. 

  421. <h4><a name="isfileselected">isfileselected</a></h4>

  422.   <p>

  423.     Test whether a file passes an embedded

  424.     <a href="../Types/selectors.html">selector</a>.

  425.   </p>

  426.   <p>

  427.     This condition was added in Apache Ant 1.6.3.

  428.   </p>

  429.   <table border="1" cellpadding="2" cellspacing="0">

  430.   <tr>

  431.     <td valign="top"><b>Attribute</b></td>

  432.     <td valign="top"><b>Description</b></td>

  433.     <td align="center" valign="top"><b>Required</b></td>

  434.   </tr>

  435.   <tr>

  436.     <td valign="top">file</td>

  437.     <td valign="top">

  438.       The file to check if is passes the embedded selector.

  439.     </td>

  440.     <td valign="top" align="center">Yes</td>

  441.   </tr>

  442.   <tr>

  443.     <td valign="top">basedir</td>

  444.     <td valign="top">The base directory to use for name based selectors. It this is not set,

  445.       the project's basedirectory will be used.</td>

  446.     <td valign="top" align="center">No</td>

  447.   </tr>

  448.   </table>

  449.   <p>

  450.     Example usage:

  451.   </p>

  452. <blockquote><pre>

  453. &lt;isfileselected file="a.xml"&gt;

  454.   &lt;date datetime="06/28/2000 2:02 pm" when="equal"/&gt;

  455. &lt;/isfileselected&gt;

  456. </pre></blockquote>

  457. 

  458. <h4><a name="typefound">typefound</a></h4>

  459. 

  460. <p>Test whether a given type is defined, and that

  461. its implementation class can be loaded. Types include

  462. tasks, datatypes, scriptdefs, macrodefs and presetdefs.</p>

  463. 

  464. <p>This condition was added in Apache Ant 1.7.</p>

  465. 

  466. <table border="1" cellpadding="2" cellspacing="0">

  467.   <tr>

  468.     <td valign="top"><b>Attribute</b></td>

  469.     <td valign="top"><b>Description</b></td>

  470.     <td align="center" valign="top"><b>Required</b></td>

  471.   </tr>

  472.   <tr>

  473.     <td valign="top">name</td>

  474.     <td valign="top">name of the type</td>

  475.     <td valign="top" align="center">Yes</td>

  476.   </tr>

  477.   <tr>

  478.     <td valign="top">uri</td>

  479.     <td valign="top">

  480.       The uri that this type lives in.

  481.     </td>

  482.     <td valign="top" align="center">No</td>

  483.   </tr>

  484. </table>

  485. 

  486.   <p>

  487.     Example usages:

  488.   </p>

  489. <blockquote><pre>

  490. &lt;typefound name="junit"/&gt;

  491. &lt;typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/&gt;

  492. </pre></blockquote>

  493. 

  494. <h4><a name="scriptcondition">scriptcondition</a></h4>

  495. 

  496. <p>Evaluate a condition based on a script in any

  497. <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a>

  498.   or

  499.   <a href="https://scripting.dev.java.net">JSR 223</a>

  500. supported language.

  501. </p>

  502. <p>

  503. See the <a href="../Tasks/script.html">Script</a> task for

  504. an explanation of scripts and dependencies.

  505. </p>

  506. 

  507. <p>This condition was added in Apache Ant 1.7.</p>

  508. 

  509. <table border="1" cellpadding="2" cellspacing="0">

  510.   <tr>

  511.     <td valign="top"><b>Attribute</b></td>

  512.     <td valign="top"><b>Description</b></td>

  513.     <td align="center" valign="top"><b>Required</b></td>

  514.   </tr>

  515.   <tr>

  516.     <td valign="top">language</td>

  517.     <td valign="top">script language</td>

  518.     <td valign="top" align="center">Yes</td>

  519.   </tr>

  520.   <tr>

  521.     <td valign="top">manager</td>

  522.     <td valign="top">

  523.       The script engine manager to use.

  524.       See the <a href="../Tasks/script.html">script</a> task

  525.       for using this attribute.

  526.     </td>

  527.     <td valign="top" align="center">No - default is "auto"</td>

  528.   </tr>

  529.   <tr>

  530.     <td valign="top">value</td>

  531.     <td valign="top">default boolean value</td>

  532.     <td valign="top" align="center">No -default is "false"</td>

  533.   </tr>  

  534.   <tr>

  535.     <td valign="top">src</td>

  536.     <td valign="top">filename of script source</td>

  537.     <td valign="top" align="center">No</td>

  538.   </tr>

  539.   <tr>

  540.     <td valign="top">setbeans</td>

  541.     <td valign="top">whether to have all properties, references and targets as

  542.       global variables in the script.  <em>since Ant 1.8.0</em></td>

  543.     <td valign="top" align="center">No, default is "true".</td>

  544.   </tr>

  545.   <tr>

  546.     <td valign="top">classpath</td>

  547.     <td valign="top">

  548.       The classpath to pass into the script.

  549.     </td>

  550.     <td align="center" valign="top">No</td>

  551.   </tr>

  552.   <tr>

  553.     <td valign="top">classpathref</td>

  554.     <td valign="top">The classpath to use, given as a

  555.        <a href="../using.html#references">reference</a> to a path defined elsewhere.

  556.     <td align="center" valign="top">No</td>

  557.   </tr>

  558. </table>

  559. <h5>Parameters specified as nested elements</h5>

  560. <h6>classpath</h6>

  561.   <p>

  562.     See the <a href="../Tasks/script.html">script</a> task

  563.     for using this nested element.

  564.   </p>

  565. <h5>Description</h5>

  566. <p>

  567. The script supports script language inline, this script has access to the

  568. same beans as the <code>&lt;script&gt;</code> task, and to the <code>self</code> bean,

  569. which refers back to the condition itself. If the script evaluates to a boolean result,

  570. this is the result of the condition's evaluation (<em>since Ant 1.7.1</em>).

  571. Alternatively, <code>self.value</code> can be used to set the evaluation result.

  572. </p>

  573. <p>

  574. Example:

  575. </p>

  576. <blockquote><pre>

  577. &lt;scriptcondition language=&quot;javascript&quot;

  578.         value=&quot;true&quot;&gt;

  579.     self.setValue(false);

  580. &lt;/scriptcondition&gt;

  581. </pre></blockquote>

  582. 

  583. Sets the default value of the condition to true, then in the script, 

  584. sets the value to false. This condition always evaluates to "false"

  585. 

  586. <h4><a name="parsersupports">parsersupports</a></h4>

  587. 

  588. <p>Tests whether Ant's XML parser supports a given

  589. feature or property, as per the SAX/JAXP specifications, by

  590. attempting to set the appropriate property/feature/</p>

  591. 

  592. <p>This condition was added in Apache Ant 1.7.</p>

  593. 

  594. <table border="1" cellpadding="2" cellspacing="0">

  595.   <tr>

  596.     <td valign="top"><b>Attribute</b></td>

  597.     <td valign="top"><b>Description</b></td>

  598.     <td align="center" valign="top"><b>Required</b></td>

  599.   </tr>

  600.   <tr>

  601.     <td valign="top">property</td>

  602.     <td valign="top">property to set</td>

  603.     <td valign="top" align="center">one of property or feature</td>

  604.   </tr>

  605.   <tr>

  606.     <td valign="top">feature</td>

  607.     <td valign="top">feature to set</td>

  608.     <td valign="top" align="center">one of property or feature</td>

  609.   </tr>

  610.   <tr>

  611.     <td valign="top">value</td>

  612.     <td valign="top">string (property) or boolean (feature)</td>

  613.     <td valign="top" align="center">For property tests, but not for feature tests</td>

  614.   </tr>

  615. </table>

  616. 

  617. <blockquote><pre>

  618. &lt;parsersupports feature="http://xml.org/sax/features/namespaces"/&gt;

  619. </pre></blockquote>

  620. Check for namespace support. All SAX2 parsers should have this.

  621. <blockquote><pre>

  622. &lt;or&gt;

  623.   &lt;parsersupports

  624.     feature="http://apache.org/xml/features/validation/schema"/&gt;

  625.   &lt;parsersupports

  626.     feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/&gt;

  627. &lt;/or&gt;

  628. </pre></blockquote>

  629. 

  630. Check for XML Schema support.

  631. 

  632. <pre>

  633. &lt;parsersupports

  634.   property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"

  635.   value="document.xsd"/&gt;

  636. </pre>

  637. 

  638. Check for Xerces-specific definition of the location of the no namespace schema.

  639. 

  640. <h4><a name="isreachable">isreachable</a></h4>

  641. 

  642. <p>Uses Java1.5+ networking APIs to probe for a (remote) system being

  643. reachable. Exactly what probe mechanisms are used is an implementation

  644. feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections

  645. to port 7 "echo service" or other means.

  646. 

  647. </p>

  648. <p>

  649. This condition turns unknown host exceptions into false conditions. This is

  650. because on a laptop, DNS is one of the first services when the network goes; you

  651. are implicitly offline.

  652. </p>

  653. <p>

  654.  If a URL is supplied instead of a host, the hostname is extracted

  655.  and used in the test - all other parts of the URL are discarded.

  656. </p>

  657. <p>

  658. The test may not work through firewalls, that is, something may be reachable

  659. using a protocol such as HTTP, while the lower level ICMP packets get dropped

  660. on the floor. Similarly, a host may detected as reachable with ICMP, but

  661. not reachable on other ports (i.e. port 80), because of firewalls.

  662. </p>

  663. <p>

  664. 

  665. This condition was added in Apache Ant 1.7.</p>

  666. 

  667. <table border="1" cellpadding="2" cellspacing="0">

  668.   <tr>

  669.     <td valign="top"><b>Attribute</b></td>

  670.     <td valign="top"><b>Description</b></td>

  671.     <td align="center" valign="top"><b>Required</b></td>

  672.   </tr>

  673.   <tr>

  674.     <td valign="top">host</td>

  675.     <td valign="top">host to check for</td>

  676.     <td valign="top" align="center">one of url or host</td>

  677.   </tr>

  678.   <tr>

  679.     <td valign="top">url</td>

  680.     <td valign="top">URL containing hostname</td>

  681.     <td valign="top" align="center">one of url or host</td>

  682.   </tr>

  683.   <tr>

  684.     <td valign="top">timeout</td>

  685.     <td valign="top">timeout in seconds</td>

  686.     <td valign="top" align="center">no, default is 30s</td>

  687.   </tr>

  688. </table>

  689. 

  690. <blockquote><pre>

  691. &lt;condition property="offline"&gt;

  692.   &lt;isreachable url="http://ibiblio.org/maven/" /&gt;

  693. &lt;/condition&gt;

  694. </pre></blockquote>

  695. 

  696. <p>

  697. Probe for the maven repository being reachable.

  698. </p>

  699. 

  700. <blockquote><pre>

  701. &lt;condition property="offline"&gt;

  702.   &lt;isreachable host="ibiblio.org" timeout="10" /&gt;

  703. &lt;/condition&gt;

  704. </pre></blockquote>

  705. 

  706. <p>

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

  708. </p>

  709. 

  710. <h4><a name="length">length</a></h4>

  711. <p>This condition is a facet of the <a href="length.html">Length</a> task.

  712.   It is used to test the length of a string or one or more files.

  713.   <b>Since Ant 1.6.3</b>

  714. </p>

  715. 

  716. <blockquote><pre>

  717. &lt;length string=" foo " trim="true" length="3" /&gt;

  718. </pre></blockquote>

  719. <p>Verify a string is of a certain length.</p>

  720. 

  721. <blockquote><pre>

  722. &lt;length file=&quot;foo&quot; when=&quot;greater&quot; length=&quot;0&quot; /&gt;

  723. </pre></blockquote>

  724. <p>Verify that file <i>foo</i> is not empty.</p>

  725. 

  726. <h4><a name="isfailure">isfailure</a></h4>

  727. 

  728. <p>Test the return code of an executable (see the

  729. <a href="exec.html">Exec</a> task) for failure. <b>Since Ant 1.7</b></p>

  730. 

  731. <table border="1" cellpadding="2" cellspacing="0">

  732.   <tr>

  733.     <td valign="top"><b>Attribute</b></td>

  734.     <td valign="top"><b>Description</b></td>

  735.     <td align="center" valign="top"><b>Required</b></td>

  736.   </tr>

  737.   <tr>

  738.     <td valign="top">code</td>

  739.     <td valign="top">The return code to test.</td>

  740.     <td valign="top" align="center">Yes</td>

  741.   </tr>

  742. </table>

  743. 

  744. <h4><a name="resourcecount">resourcecount</a></h4>

  745. <p>This condition is a facet of the

  746.   <a href="resourcecount.html">ResourceCount</a> task.

  747.   It is used to test the size of a 

  748.   <a href="../Types/resources.html#collection">resource collection</a>.

  749.   <b>Since Ant 1.7</b>

  750. </p>

  751. 

  752. <blockquote><pre>

  753. &lt;resourcecount refid=&quot;myresourcecollection&quot; when=&quot;greater&quot; count=&quot;0&quot; /&gt;

  754. </pre></blockquote>

  755. <p>Verify that a resource collection is not empty.</p>

  756. 

  757. <h4><a name="resourcesmatch">resourcesmatch</a></h4>

  758. <p>Test resources for matching. Nonexistence of one or more resources results in

  759. "false", although if none exists they are considered equal in terms of content.

  760. By default this test does a byte for byte comparison, so test time scales with

  761. byte size. NB: if the files are different sizes, one of them is missing

  762. or the filenames match the answer is so obvious the detailed test is omitted.

  763. The resources to check are specified as nested

  764. <a href="../Types/resources.html#collection">resource collections</a>,

  765. meaning that more than two resources can be checked; in this case all resources

  766. must match. <b>Since Ant 1.7</b>

  767. </p>

  768. <table border="1" cellpadding="2" cellspacing="0">

  769.   <tr>

  770.     <td width="12%" valign="top"><b>Attribute</b></td>

  771.     <td width="78%" valign="top"><b>Description</b></td>

  772.     <td width="10%" valign="top"><b>Required</b></td>

  773.   </tr>

  774.   <tr>

  775.     <td valign="top">astext</td>

  776.     <td valign="top">Whether to ignore line endings

  777.         when comparing resource content; defaults to <i>false</i>,

  778.         while <i>true</i> triggers a binary comparison.

  779.     </td>

  780.     <td align="center">No</td>

  781.   </tr>

  782. </table>

  783. 

  784. <h4><a name="resourcecontains">resourcecontains</a></h4>

  785. <p>Tests whether a resource contains a given (sub)string.</p>

  786. <p>The resources to check are specified via references or - in the

  787.   case of file resources via the resource attribute.  <b>Since Ant 1.7.1</b>

  788. </p>

  789. <table border="1" cellpadding="2" cellspacing="0">

  790.   <tr>

  791.     <td width="12%" valign="top"><b>Attribute</b></td>

  792.     <td width="78%" valign="top"><b>Description</b></td>

  793.     <td width="10%" valign="top"><b>Required</b></td>

  794.   </tr>

  795.   <tr>

  796.     <td valign="top">resource</td>

  797.     <td valign="top">Name of a file that is the resource to test.

  798.     </td>

  799.     <td align="center" rowspan="2">One of the two</td>

  800.   </tr>

  801.   <tr>

  802.     <td valign="top">refid</td>

  803.     <td valign="top">Reference to a resource defined inside the project.</td>

  804.   </tr>

  805.   <tr>

  806.     <td valign="top">substring</td>

  807.     <td valign="top">The string to search for.</td>

  808.     <td valign="top" align="center">Yes</td>

  809.   </tr>

  810.   <tr>

  811.     <td valign="top">casesensitive</td>

  812.     <td valign="top">Perform a case sensitive comparison.  Default is

  813.         true.</td>

  814.     <td valign="top" align="center">No</td>

  815.   </tr>

  816. </table>

  817. 

  818. <h4><a name="hasmethod">hasmethod</a></h4>

  819. 

  820. <p> Tests for a class having a method or field. If the class is not found 

  821.     or fails to load, the build fails. 

  822.     

  823.     <b>Since Ant 1.7</b>

  824. </p>

  825. 

  826. <table border="1" cellpadding="2" cellspacing="0">

  827.     <tr>

  828.         <td width="12%" valign="top"><b>Attribute</b></td>

  829.         <td width="78%" valign="top"><b>Description</b></td>

  830.         <td width="10%" valign="top"><b>Required</b></td>

  831.     </tr>

  832.     <tr>

  833.         <td valign="top">classname</td>

  834.         <td valign="top">name of the class to load</td>

  835.         <td align="center">yes</td>

  836.     </tr>

  837.     <tr>

  838.         <td valign="top">field</td>

  839.         <td valign="top">name of a field to look for</td>

  840.         <td align="center">one of field or method</td>

  841.     </tr>

  842.     <tr>

  843.         <td valign="top">method</td>

  844.         <td valign="top">name of a method to look for</td>

  845.         <td align="center">one of field or method</td>

  846.     </tr>

  847.     

  848.     <tr>

  849.         <td valign="top">ignoreSystemClasses</td>

  850.         <td valign="top">should system classes be ignored?</td>

  851.         <td align="center">No -default is false</td>

  852.     </tr>

  853.     <tr>

  854.         <td valign="top">classpath</td>

  855.         <td valign="top">a class path</td>

  856.         <td align="center">No</td>

  857.     </tr>

  858.     <tr>

  859.         <td valign="top">classpathref</td>

  860.         <td valign="top">reference to a class path</td>

  861.         <td align="center">No</td>

  862.     </tr>

  863. </table>

  864. 

  865. <p>

  866.     There is also a nested &lt;classpath&gt; element, which can be used to specify 

  867.     a classpath.

  868. </p>

  869. <blockquote><pre>

  870. &lt;hasmethod classname="java.util.ArrayList" method="trimToSize"  /&gt;

  871. </pre></blockquote>

  872. 

  873. <p>Looks for the method trimToSize in the ArrayList class.</p>

  874. 

  875. <h4><a name="matches">matches</a></h4>

  876. 

  877. <p>

  878.   Test if the specified string matches the specified regular

  879.   expression pattern.

  880.   <b>Since Ant 1.7</b></p>

  881. 

  882. <table border="1" cellpadding="2" cellspacing="0">

  883.   <tr>

  884.     <td valign="top"><b>Attribute</b></td>

  885.     <td valign="top"><b>Description</b></td>

  886.     <td align="center" valign="top"><b>Required</b></td>

  887.   </tr>

  888.   <tr>

  889.     <td valign="top">string</td>

  890.     <td valign="top">The string to test.</td>

  891.     <td valign="top" align="center">Yes</td>

  892.   </tr>

  893.   <tr>

  894.     <td valign="top">pattern</td>

  895.     <td valign="top">The regular expression pattern used to test.</td>

  896.     <td valign="top" align="center">Yes, unless there is a nested

  897.       <code>&lt;regexp&gt;</code> element.</td>

  898.   </tr>

  899.   <tr>

  900.     <td valign="top">casesensitive</td>

  901.     <td valign="top">Perform a case sensitive match.  Default is

  902.         true.</td>

  903.     <td valign="top" align="center">No</td>

  904.   </tr>

  905.   <tr>

  906.     <td valign="top">multiline</td>

  907.     <td valign="top">

  908.       Perform a multi line match.

  909.       Default is false.</td>

  910.     <td valign="top" align="center">No</td>

  911.   </tr>

  912.   <tr>

  913.     <td valign="top">singleline</td>

  914.     <td valign="top">

  915.       This allows '.' to match new lines.

  916.       SingleLine is not to be confused with multiline, SingleLine is a perl

  917.       regex term, it corresponds to dotall in java regex.

  918.       Default is false.</td>

  919.     <td valign="top" align="center">No</td>

  920.   </tr>

  921. </table>

  922. 

  923.   <p>

  924.     There is also an optional &lt;regexp&gt; element, which can be used to specify

  925.     a regular expression instead of the "pattern" attribute.

  926.     See <a href="../Types/regexp.html">Regexp Type</a> for the description

  927.     of the nested element regexp and of

  928.     the choice of regular expression implementation.

  929.   </p>

  930.   <p>

  931.     An example:

  932.   </p>

  933. <blockquote><pre>

  934. &lt;condition property="legal-password"&gt;

  935.   &lt;matches pattern="[1-9]" string="${user-input}"/&gt;

  936. &lt;/condition&gt;

  937. &lt;fail message="Your password should at least contain one number"

  938.       unless="legal-password"/&gt;

  939. </pre></blockquote>

  940.   <p>

  941.     The following example sets the property "ok" if

  942.     the property "input" is three characters long, starting

  943.     with 'a' and ending with 'b'.

  944.   </p>

  945. <blockquote><pre>

  946. &lt;condition property="ok"&gt;

  947.   &lt;matches string="${input}" pattern="^a.b$"/&gt;

  948. &lt;/condition&gt;

  949. </pre></blockquote>

  950.   <p>

  951.     The following defines a reference regular expression for

  952.     matching dates and then uses antunit to check if the

  953.     property "today" is in the correct format:

  954.   </p>

  955. <blockquote><pre>

  956. &lt;regexp id="date.pattern" pattern="^[0123]\d-[01]\d-[12]\d\d\d$"/&gt;

  957. 

  958. &lt;au:assertTrue xmlns:au="antlib:org.apache.ant.antunit"&gt;

  959.   &lt;matches string="${today}"&gt;

  960.     &lt;regexp refid="date.pattern"/&gt;

  961.   &lt;/matches&gt;

  962. &lt;/au:assertTrue&gt;

  963. </pre></blockquote>

  964.   <p>

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

  966.     flags.

  967.   </p>

  968. <blockquote><pre>

  969. &lt;au:assertTrue&gt;

  970.   &lt;matches string="AB${line.separator}C" pattern="^ab.*C$"

  971.            casesensitive="false"

  972.            singleline="true"/&gt;

  973. &lt;/au:assertTrue&gt;

  974. &lt;au:assertFalse&gt;

  975.   &lt;matches string="AB${line.separator}C" pattern="^ab.*C$"

  976.            casesensitive="false"

  977.            singleline="false"/&gt;

  978. &lt;/au:assertFalse&gt;

  979. </pre></blockquote>

  980. 

  981. <h4><a name="antversion">antversion</a></h4>

  982. <p>This condition is identical to the <a

  983. href="antversion.html">Antversion</a> task, all attributes are supported, the property attribute

  984. is redundant and will be ignored.</p>

  985. 

  986. 

  987. <h4><a name="hasfreespace">hasfreespace</a></h4>

  988. 

  989. <p>

  990.   Tests a partition to see if there is enough space.

  991.   <b>Since Ant 1.7.0</b></p>

  992.   <p>Needed attribute can be specified using standard computing terms:<br/>

  993.     <ul>

  994.       <li>K : Kilobytes (1024 bytes)</li>

  995.       <li>M : Megabytes (1024 K)</li>

  996.       <li>G : Gigabytes (1024 M)</li>

  997.       <li>T : Terabytes (1024 G)</li>

  998.       <li>P : Petabytes (1024 T)</li>

  999.     </ul>

  1000.   </p>

  1001. 

  1002. <table border="1" cellpadding="2" cellspacing="0">

  1003.   <tr>

  1004.     <td valign="top"><b>Attribute</b></td>

  1005.     <td valign="top"><b>Description</b></td>

  1006.     <td align="center" valign="top"><b>Required</b></td>

  1007.   </tr>

  1008.   <tr>

  1009.     <td valign="top">partition</td>

  1010.     <td valign="top">The partition or filesystem to check for freespace</td>

  1011.     <td valign="top" align="center">Yes</td>

  1012.   </tr>

  1013.   <tr>

  1014.     <td valign="top">needed</td>

  1015.     <td valign="top">The amount of freespace needed.</td>

  1016.     <td valign="top" align="center">Yes</td>

  1017.   </tr>

  1018. </table>

  1019.   <p>

  1020.     An example:

  1021.   </p>

  1022. <blockquote><pre>

  1023. &lt;hasfreespace partition="c:" needed="100M"/&gt;

  1024. </pre></blockquote>

  1025. 

  1026. <h4><a name="islastmodified">islastmodified</a></h4>

  1027. 

  1028. <p>Tests the last modified date of a resource.  <em>Since Ant

  1029. 1.8.0</em></p>

  1030. 

  1031. <table border="1" cellpadding="2" cellspacing="0">

  1032.   <tr>

  1033.     <td width="12%" valign="top"><b>Attribute</b></td>

  1034.     <td width="78%" valign="top"><b>Description</b></td>

  1035.     <td width="10%" valign="top"><b>Required</b></td>

  1036.   </tr>

  1037.   <tr>

  1038.     <td valign="top">millis</td>

  1039.     <td valign="top">Specifies the expected modification time of the resource

  1040.       in milliseconds since midnight Jan 1 1970.</td>

  1041.     <td valign="center" align="center" rowspan="2">Exactly one of the

  1042.       two.</td>

  1043.   </tr>

  1044.   <tr>

  1045.     <td valign="top">datetime</td>

  1046.     <td valign="top">Specifies the expected modification time of the

  1047.        resource. The special value &quot;now&quot; indicates the

  1048.        current time.</td>

  1049.   </tr>

  1050.   <tr>

  1051.     <td valign="top">pattern</td>

  1052.     <td valign="top">SimpleDateFormat-compatible pattern string.

  1053.        Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM.

  1054.     </td>

  1055.     <td valign="top" align="center">No</td>

  1056.   </tr>

  1057.   <tr>

  1058.     <td valign="top">mode</td>

  1059.     <td valign="top">How to compare the timestamp.  Accepted values

  1060.       are "equals", "before", "not-before", "after" and "not-after".

  1061.     <td valign="top">No, defaults to "equals".</td>

  1062.   </tr>

  1063. </table>

  1064. 

  1065. <p>The actual resource to test is specified as a nested element.</p>

  1066. 

  1067.   <p>

  1068.     An example:

  1069.   </p>

  1070. <blockquote><pre>

  1071. &lt;islastmodified dateTime="08/18/2009 04:41:19 AM" mode="not-before"&gt;

  1072.   &lt;file file="${file}"/&gt;

  1073. &lt;/islastmodified&gt;

  1074. </pre></blockquote>

  1075. 

  1076. <h4><a name="resourceexists">resourceexists</a></h4>

  1077. 

  1078. <p>Tests a resource for existence.  <em>since Ant 1.8.0</em></p>

  1079. 

  1080. <p>The actual resource to test is specified as a nested element.</p>

  1081. 

  1082.   <p>

  1083.     An example:

  1084.   </p>

  1085. <blockquote><pre>

  1086. &lt;resourceexists&gt;

  1087.   &lt;file file="${file}"/&gt;

  1088. &lt;/resourceexists&gt;

  1089. </pre></blockquote>

  1090. 

  1091. <h4><a name="javaversion">javaversion</a></h4>

  1092. 

  1093. <p>Tests the version of the JVM executing Ant.  <em>Since Ant

  1094. 1.9.10</em></p>

  1095. 

  1096. <table border="1" cellpadding="2" cellspacing="0">

  1097.   <tr>

  1098.     <td width="12%" valign="top"><b>Attribute</b></td>

  1099.     <td width="78%" valign="top"><b>Description</b></td>

  1100.     <td width="10%" valign="top"><b>Required</b></td>

  1101.   </tr>

  1102.   <tr>

  1103.     <td valign="top">atleast</td>

  1104.     <td valign="top">The version that this JVM is at least.

  1105.       The format is major.minor.point. Starting with Java9 really

  1106.       only the major number is determined.</td>

  1107.     <td valign="top" align="center">No</td>

  1108.     <td valign="top" rowspan="2" align="center">One of these.</td>

  1109.   </tr>

  1110.   <tr>

  1111.     <td valign="top">exactly</td>

  1112.     <td valign="top">The version that this JVM is exactly.

  1113.       The format is <tt>major.minor.point</tt>. Starting with Java9 really

  1114.       only the major number is determined.</td>

  1115.     <td valign="top" align="center">No</td>

  1116.   </tr>

  1117. </table>

  1118. 

  1119.   <p>

  1120.     An example:

  1121.   </p>

  1122. 

  1123. <blockquote><pre>

  1124. &lt;javaversion atleast=&quot;9&quot;/&gt;

  1125. </pre></blockquote>

  1126. 

  1127. <p>will evaluate to true if the current JVM is Java9 or above.</p>

  1128. 

  1129. </body>

  1130. </html>
Please read the following content carefully:

Dear OpenI User

Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.

For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》

Agree and continue
Disagree, exit