1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
|
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Conditions Task</title>
</head>
<body>
<h2 id="conditions">Conditions</h2>
<p>Conditions are nested elements of the <a href="condition.html"><code><condition></code></a>
and <a href="waitfor.html"><code><waitfor></code></a> tasks. There are core conditions and
custom conditions. Custom conditions are described
in <a href="../Types/custom-programming.html#customconditions">Custom Conditions</a>. Core
Conditions are described below.</p>
<h3 id="coreconditions">Core Conditions</h3>
<p>These are the nested elements that can be used as conditions in
the <a href="condition.html"><code><condition></code></a>
and <a href="waitfor.html"><code><waitfor></code></a> tasks.</p>
<h4 id="not">not</h4>
<p>The <code><not></code> 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.</p>
<h4 id="and">and</h4>
<p>The <code><and></code> 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.</p>
<p>The <code><and></code> condition has the same shortcut semantics as the
Java <code>&&</code> operator, as soon as one of the nested conditions is false, no other
condition will be evaluated.</p>
<h4 id="or">or</h4>
<p>The <code><or></code> 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.</p>
<p>The <code><or></code> condition has the same shortcut semantics as the Java <code>||</code>
operator, as soon as one of the nested conditions is true, no other condition will be evaluated.</p>
<h4 id="xor">xor</h4>
<p>The <code><xor></code> element performs an exclusive or on all nested elements, similar to
the <code>^</code> 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 <code><and></code>
and <code><or></code> tests. It doesn't have any attributes and accepts all nested elements
of the condition task as nested elements as well.</p>
<h4 id="available">available</h4>
<p>This condition is identical to the <a href="available.html">Available</a> task, all attributes
and nested elements of that task are supported, the property and value attributes are redundant and
will be ignored.</p>
<h4 id="uptodate">uptodate</h4>
<p>This condition is identical to the <a href="uptodate.html">Uptodate</a> task, all attributes and
nested elements of that task are supported, the property and value attributes are redundant and will
be ignored.</p>
<h4 id="os">os</h4>
<p>Test whether the current operating system is of a given type. Each defined attribute is tested
and the result is true only if <em>all</em> the tests succeed.
</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>family</td>
<td>The name of the operating system family to expect.</td>
<td>No</td>
</tr>
<tr>
<td>name</td>
<td>The name of the operating system to expect.</td>
<td>No</td>
</tr>
<tr>
<td>arch</td>
<td>The architecture of the operating system to expect.</td>
<td>No</td>
</tr>
<tr>
<td>version</td>
<td>The version of the operating system to expect.</td>
<td>No</td>
</tr>
</table>
<p>Supported values for the family attribute are:
<ul>
<li><q>windows</q>—for all versions of Microsoft Windows</li>
<li><q>dos</q>—for all Microsoft DOS based operating systems including Microsoft Windows and
OS/2</li>
<li><q>mac</q>—for all Apple Macintosh systems prior to Mac OS X</li>
<li><q>unix</q>—for all Unix(-like) operating systems, including Linux and Mac OS
X/macOS</li>
<li><q>netware</q>—for Novell NetWare</li>
<li><q>os/2</q>—for OS/2</li>
<li><q>tandem</q>—for HP's NonStop Kernel, formerly Tandem</li>
<li><q>win9x</q>—for Microsoft Windows 95 and 98, ME and CE</li>
<li><q>winnt</q>—for Microsoft Windows NT-based systems, including Windows 2000, XP and
successors</li>
<li><q>z/os</q>—for z/OS and OS/390</li>
<li><q>os/400</q>—for OS/400</li>
<li><q>openvms</q>—for OpenVMS</li>
</ul>
<h4 id="equals">equals</h4>
<p>Tests whether the two given values are equal.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>arg1</td>
<td>First value to test.</td>
<td>Yes</td>
</tr>
<tr>
<td>arg2</td>
<td>Second value to test.</td>
<td>Yes</td>
</tr>
<tr>
<td>casesensitive</td>
<td>Perform a case sensitive comparison.</td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>trim</td>
<td>Trim whitespace from arguments before comparing them.</td>
<td>No; default is <q>false</q></td>
</tr>
<tr>
<td>forcestring</td>
<td>Force string comparison of <var>arg1</var>/<var>arg2</var>. <em>Since Apache Ant 1.8.1</em>
</td>
<td>No; default is <q>false</q></td>
</tr>
</table>
<h4 id="isset">isset</h4>
<p>Test whether a given property has been set in this project.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>property</td>
<td>The name of the property to test.</td>
<td>Yes</td>
</tr>
</table>
<h4 id="checksum">checksum</h4>
<p>This condition is identical to the <a href="checksum.html">Checksum</a> task, all attributes and
nested elements of that task are supported, the property and overwrite attributes are redundant and
will be ignored.</p>
<h4 id="http">http</h4>
<p>The <code>http</code> 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.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>url</td>
<td>The full URL of the page to request. The web server must return a status code below the
value of <var>errorsBeginAt</var></td>
<td>Yes</td>
</tr>
<tr>
<td>errorsBeginAt</td>
<td>The lowest HTTP response code that signals an error; server errors, not-authorized,
not-found and the like are detected</td>
<td>No; default is <q>400</q></td>
</tr>
<tr>
<td>requestMethod</td>
<td>The HTTP method to be used when issuing the request. Any
of <q>GET</q>, <q>POST</q>, <q>HEAD</q>, <q>OPTIONS</q>, <q>PUT</q>, <q>DELETE</q>
and <q>TRACE</q> are valid, subject to protocol restrictions.<br/><em>since Ant
1.8.0</em></td>
<td>No; default is <q>GET</q></td>
</tr>
<tr>
<td>followRedirects</td>
<td>Whether redirects should be followed.<br/><em>since Ant 1.9.7</em></td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>readTimeout</td>
<td>Read timeout, in milliseconds, that will be used while reading from the target URL.
Accepts any value ≥ 0. Value of 0 implies wait indefinitely. Value < 0 will be silently
ignored.<br/>
<em>since Ant 1.10.6</em></td>
<td>No; defaults to <q>0</q></td>
</tr>
</table>
<h4 id="socket">socket</h4>
<p>The <code>socket</code> condition checks for the existence of a TCP/IP listener at the specified
host and port.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>server</td>
<td>The DNS name or IP address of the server.</td>
<td>Yes</td>
</tr>
<tr>
<td>port</td>
<td>The port number to connect to.</td>
<td>Yes</td>
</tr>
</table>
<h4 id="filesmatch">filesmatch</h4>
<p>Test two files for matching. Nonexistence of one file results in <q>false</q>, although if
neither exists they are considered equal in terms of content. This test does a byte for byte
comparison, so test time scales with byte size. <strong>Note</strong>: 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.
</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>file1</td>
<td>First file to test</td>
<td>Yes</td>
</tr>
<tr>
<td>file2</td>
<td>Second file to test</td>
<td>Yes</td>
</tr>
<tr>
<td>textfile</td>
<td>Whether to ignore line endings when comparing files. <em>Since Ant 1.7</em>
</td>
<td>No; defaults to <q>false</q> which triggers a binary comparison</td>
</tr>
</table>
<h4 id="contains">contains</h4>
<p>Tests whether a string contains another one.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>string</td>
<td>The string to search in.</td>
<td>Yes</td>
</tr>
<tr>
<td>substring</td>
<td>The string to search for.</td>
<td>Yes</td>
</tr>
<tr>
<td>casesensitive</td>
<td>Perform a case sensitive comparison.</td>
<td>No; default is <q>true</q></td>
</tr>
</table>
<h4 id="istrue">istrue</h4>
<p>Tests whether a string equals any of the Ant definitions of true, that
is <q>true</q>, <q>yes</q>, or <q>on</q></p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>value</td>
<td>value to test</td>
<td>Yes</td>
</tr>
</table>
<pre>
<istrue value="${someproperty}"/>
<istrue value="false"/></pre>
<h4 id="isfalse">isfalse</h4>
<p>Tests whether a string is not true, the negation of <code><istrue></code></p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>value</td>
<td>value to test</td>
<td>Yes</td>
</tr>
</table>
<pre>
<isfalse value="${someproperty}"/>
<isfalse value="false"/></pre>
<h4 id="isreference">isreference</h4>
<p>Test whether a given reference has been defined in this project and—optionally—is of
an expected type.</p>
<p><em>Since Apache Ant 1.6</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>refid</td>
<td>The <var>id</var> of the reference to test.</td>
<td>Yes</td>
</tr>
<tr>
<td>type</td>
<td>Name of the data type or task this reference is expected to be.</td>
<td>No</td>
</tr>
</table>
<h4 id="issigned">issigned</h4>
<p>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.</p>
<p><em>Since Apache Ant 1.7</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>file</td>
<td>The jarfile that is to be tested for the presence of a signature.</td>
<td>Yes</td>
</tr>
<tr>
<td>name</td>
<td>The signature name to check for.</td>
<td>No</td>
</tr>
</table>
<h4 id="isfileselected">isfileselected</h4>
<p>Test whether a file passes an embedded <a href="../Types/selectors.html">selector</a>.</p>
<p><em>Since Apache Ant 1.6.3</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>file</td>
<td>The file to check if is passes the embedded selector.</td>
<td>Yes</td>
</tr>
<tr>
<td>basedir</td>
<td>The base directory to use for name based selectors. It this is not set, the
project's <var>basedir</var> will be used.</td>
<td>No</td>
</tr>
</table>
<p>Example usage:</p>
<pre>
<isfileselected file="a.xml">
<date datetime="06/28/2000 2:02 pm" when="equal"/>
</isfileselected></pre>
<h4 id="typefound">typefound</h4>
<p>Test whether a given type is defined, and that its implementation class can be loaded. Types
include tasks, datatypes, scriptdefs, macrodefs and presetdefs.</p>
<p><em>Since Apache Ant 1.7</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>name</td>
<td>Name of the type</td>
<td>Yes</td>
</tr>
<tr>
<td>uri</td>
<td>The URI that this type lives in.</td>
<td>No</td>
</tr>
</table>
<p>Example usages:</p>
<pre>
<typefound name="junit"/>
<typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/></pre>
<h4 id="scriptcondition">scriptcondition</h4>
<p>Evaluate a condition based on a script in any <a href="https://jakarta.apache.org/bsf"
target="_top">Apache BSF</a>
or <a href="https://jcp.org/aboutJava/communityprocess/maintenance/jsr223/223ChangeLog.html"
target="_top">JSR 223</a> supported language.</p>
<p>See the <a href="../Tasks/script.html">Script</a> task for an explanation of scripts and
dependencies.</p>
<p><em>Since Apache Ant 1.7</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>language</td>
<td>script language</td>
<td>Yes</td>
</tr>
<tr>
<td>manager</td>
<td>The script engine manager to use. See the <a href="../Tasks/script.html">script</a> task
for using this attribute.</td>
<td>No; default is <q>auto</q></td>
</tr>
<tr>
<td>value</td>
<td>default boolean value</td>
<td>No; default is <q>false</q></td>
</tr>
<tr>
<td>src</td>
<td>filename of script source</td>
<td>No</td>
</tr>
<tr>
<td>encoding</td>
<td>The encoding of the script source. <em>Since Ant 1.10.2</em>.</td>
<td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
<td>setbeans</td>
<td>whether to have all properties, references and targets as global variables in the
script. <em>since Ant 1.8.0</em></td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>classpath</td>
<td>The classpath to pass into the script.</td>
<td>No</td>
</tr>
<tr>
<td>classpathref</td>
<td>The classpath to use, given as a <a href="../using.html#references">reference</a> to a path
defined elsewhere.</td>
<td>No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<h6>classpath</h6>
<p>See the <a href="../Tasks/script.html">script</a> task for using this nested element.</p>
<h5>Description</h5>
<p>The script supports script language inline, this script has access to the same beans as
the <code><script></code> task, and to the <code>self</code> bean, which refers back to the
condition itself. If the script evaluates to a boolean result, this is the result of the condition's
evaluation (<em>since Ant 1.7.1</em>). Alternatively, <code>self.value</code> can be used to set
the evaluation result.</p>
<p>Example:</p>
<pre>
<scriptcondition language="javascript"
value="true">
self.setValue(false);
</scriptcondition></pre>
<p>Sets the default value of the condition to <q>true</q>, then in the script, sets the value
to <q>false</q>. This condition always evaluates to <q>false</q>.</p>
<h4 id="parsersupports">parsersupports</h4>
<p>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</p>
<p><em>Since Apache Ant 1.7</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>property</td>
<td>property to set</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>feature</td>
<td class="left">feature to set</td>
</tr>
<tr>
<td>value</td>
<td>string (property) or boolean (feature)</td>
<td>For property tests, but not for feature tests</td>
</tr>
</table>
<pre><parsersupports feature="http://xml.org/sax/features/namespaces"/></pre>
<p>Check for namespace support. All SAX2 parsers should have this.</p>
<pre>
<or>
<parsersupports
feature="http://apache.org/xml/features/validation/schema"/>
<parsersupports
feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/>
</or></pre>
<p>Check for XML Schema support.</p>
<pre>
<parsersupports
property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
value="document.xsd"/></pre>
<p>Check for Xerces-specific definition of the location of the no namespace schema.</p>
<h4 id="isreachable">isreachable</h4>
<p>Uses Java 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.</p>
<p>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.</p>
<p>If a URL is supplied instead of a <var>host</var>, the hostname is extracted and used in the
test—all other parts of the URL are discarded.</p>
<p>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.</p>
<p><em>Since Apache Ant 1.7</em>.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>host</td>
<td>host to check for</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>url</td>
<td class="left">URL containing hostname</td>
</tr>
<tr>
<td>timeout</td>
<td>timeout in seconds</td>
<td>No; default is <q>30</q></td>
</tr>
</table>
<pre>
<condition property="offline">
<isreachable url="http://ibiblio.org/maven/"/>
</condition></pre>
<p>Probe for the Maven repository being reachable.</p>
<pre>
<condition property="offline">
<isreachable host="ibiblio.org" timeout="10"/>
</condition></pre>
<p>Probe for the Maven repository being reachable using the hostname, ten second timeout.</p>
<h4 id="length">length</h4>
<p><em>Since Ant 1.6.3</em></p>
<p>This condition is a facet of the <a href="length.html">Length</a> task. It is used to test the
length of a string or one or more files.</p>
<pre><length string=" foo " trim="true" length="3"/></pre>
<p>Verify a string is of a certain length.</p>
<pre><length file="foo" when="greater" length="0"/></pre>
<p>Verify that file <samp>foo</samp> is not empty.</p>
<h4 id="isfailure">isfailure</h4>
<p><em>Since Ant 1.7</em></p>
<p>Test the return code of an executable (see the <a href="exec.html">Exec</a> task) for
failure.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>code</td>
<td>The return code to test.</td>
<td>Yes</td>
</tr>
</table>
<h4 id="resourcecount">resourcecount</h4>
<p><em>Since Ant 1.7</em></p>
<p>This condition is a facet of the <a href="resourcecount.html">ResourceCount</a> task. It is used
to test the size of a <a href="../Types/resources.html#collection">resource
collection</a>.</p>
<pre><resourcecount refid="myresourcecollection" when="greater" count="0"/></pre>
<p>Verify that a resource collection is not empty.</p>
<h4 id="resourcesmatch">resourcesmatch</h4>
<p><em>Since Ant 1.7</em></p>
<p>Test resources for matching. Nonexistence of one or more resources results in <q>false</q>,
although if none exists they are considered equal in terms of content. By default, this test does a
byte for byte comparison, so test time scales with byte size. <strong>Note</strong>: 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 <a href="../Types/resources.html#collection">resource collections</a>, meaning that more than
two resources can be checked; in this case all resources must match.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>astext</td>
<td>Whether to ignore line endings when comparing resource content; <q>true</q> triggers a
binary comparison.</td>
<td>No; defaults to <q>false</q></td>
</tr>
</table>
<h4 id="resourcecontains">resourcecontains</h4>
<p><em>Since Ant 1.7.1</em></p>
<p>Tests whether a resource contains a given (sub)string.</p>
<p>The resources to check are specified via references or—in the case of file
resources—via the <var>resource</var> attribute.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>resource</td>
<td>Name of a file that is the resource to test.</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>refid</td>
<td class="left">Reference to a resource defined inside the project.</td>
</tr>
<tr>
<td>substring</td>
<td>The string to search for.</td>
<td>Yes</td>
</tr>
<tr>
<td>casesensitive</td>
<td>Perform a case sensitive comparison.</td>
<td>No; default is <q>true</q></td>
</tr>
</table>
<h4 id="hasmethod">hasmethod</h4>
<p><em>Since Ant 1.7</em></p>
<p>Tests for a class having a method or field. If the class is not found or fails to load, the build
fails.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>classname</td>
<td>name of the class to load</td>
<td>yes</td>
</tr>
<tr>
<td>field</td>
<td>name of a field to look for</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>method</td>
<td class="left">name of a method to look for</td>
</tr>
<tr>
<td>ignoreSystemClasses</td>
<td>should system classes be ignored?</td>
<td>No; default is <q>false</q></td>
</tr>
<tr>
<td>classpath</td>
<td>a class path</td>
<td>No</td>
</tr>
<tr>
<td>classpathref</td>
<td>reference to a class path</td>
<td>No</td>
</tr>
</table>
<p>There is also a nested <code><classpath></code> element, which can be used to specify a
classpath.</p>
<pre><hasmethod classname="java.util.ArrayList" method="trimToSize"/></pre>
<p>Looks for the method <code class="code">trimToSize()</code> in
the <code class="code">java.util.ArrayList</code> class.</p>
<h4 id="matches">matches</h4>
<p><em>Since Ant 1.7</em></p>
<p>Test if the specified string matches the specified regular expression pattern</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>string</td>
<td>The string to test.</td>
<td>Yes</td>
</tr>
<tr>
<td>pattern</td>
<td>The regular expression pattern used to test.</td>
<td>Yes, unless there is a nested <code><regexp></code> element</td>
</tr>
<tr>
<td>casesensitive</td>
<td>Perform a case sensitive match.</td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>multiline</td>
<td>Perform a multi line match.</td>
<td>No; default is <q>false</q></td>
</tr>
<tr>
<td>singleline</td>
<td>This allows <q>.</q> to match new lines. <var>SingleLine</var> is not to be confused with
multiline, <var>SingleLine</var> is a perl regex term, it corresponds to <var>dotall</var> in
Java regex.</td>
<td>No; default is <q>false</q></td>
</tr>
</table>
<p>There is also an optional <code><regexp></code> element, which can be used to specify a
regular expression instead of the <var>pattern</var> attribute.
See <a href="../Types/regexp.html">Regexp Type</a> for the description of the nested element regexp
and of the choice of regular expression implementation.</p>
<p>An example:</p>
<pre>
<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"/></pre>
<p>The following example sets the property <code>ok</code> if the property <code>input</code> is
three characters long, starting with <q>a</q> and ending with <q>b</q>.</p>
<pre>
<condition property="ok">
<matches string="${input}" pattern="^a.b$"/>
</condition></pre>
<p>The following defines a reference regular expression for matching dates and then uses antunit to
check if the property <code>today</code> is in the correct format:</p>
<pre>
<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></pre>
<p>The following example shows the use of the <var>singleline</var> and the <var>casesensitive</var>
flags.</p>
<pre>
<au:assertTrue>
<matches string="AB${line.separator}C" pattern="^ab.*C$"
casesensitive="false"
singleline="true"/>
</au:assertTrue>
<au:assertFalse>
<matches string="AB${line.separator}C" pattern="^ab.*C$"
casesensitive="false"
singleline="false"/>
</au:assertFalse></pre>
<h4 id="antversion">antversion</h4>
<p>This condition is identical to the <a href="antversion.html">Antversion</a> task, all attributes
are supported, the <var>property</var> attribute is redundant and will be ignored.</p>
<h4 id="hasfreespace">hasfreespace</h4>
<p><em>Since Ant 1.7.0</em></p>
<p>Tests a partition to see if there is enough space.</p>
<p>Needed attribute can be specified using standard computing terms:</p>
<ul>
<li>K : Kilobytes (1024 bytes)</li>
<li>M : Megabytes (1024 K)</li>
<li>G : Gigabytes (1024 M)</li>
<li>T : Terabytes (1024 G)</li>
<li>P : Petabytes (1024 T)</li>
</ul>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>partition</td>
<td>The partition or filesystem to check for free space</td>
<td>Yes</td>
</tr>
<tr>
<td>needed</td>
<td>The amount of free space needed.</td>
<td>Yes</td>
</tr>
</table>
<p>An example:</p>
<pre><hasfreespace partition="c:" needed="100M"/></pre>
<h4 id="islastmodified">islastmodified</h4>
<p><em>Since Ant 1.8.0</em></p>
<p>Tests the last modified date of a resource.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>millis</td>
<td>Specifies the expected modification time of the resource in milliseconds since midnight Jan
1 1970.</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>datetime</td>
<td class="left">Specifies the expected modification time of the resource. The special
value <q>now</q> indicates the current time.</td>
</tr>
<tr>
<td>pattern</td>
<td>SimpleDateFormat-compatible pattern string.</td>
<td>No; defaults to <q>MM/dd/YYYY hh:mm a</q> or <q>MM/dd/YYYY hh:mm:ss a</q></td>
</tr>
<tr>
<td>mode</td>
<td>How to compare the timestamp. Accepted values
are <q>equals</q>, <q>before</q>, <q>not-before</q>, <q>after</q> and <q>not-after</q>.
<td>No; defaults to <q>equals</q></td>
</tr>
</table>
<p>The actual resource to test is specified as a nested element.</p>
<p>An example:</p>
<pre>
<islastmodified dateTime="08/18/2009 04:41:19 AM" mode="not-before">
<file file="${file}"/>
</islastmodified></pre>
<h4 id="resourceexists">resourceexists</h4>
<p><em>Since Ant 1.8.0</em></p>
<p>Tests a resource for existence.</p>
<p>The actual resource to test is specified as a nested element.</p>
<p>An example:</p>
<pre>
<resourceexists>
<file file="${file}"/>
</resourceexists></pre>
<h4 id="javaversion">javaversion</h4>
<p><em>Since Ant 1.10.2</em></p>
<p>Tests the version of the JVM executing Ant.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>atleast</td>
<td>The version that this JVM is of at least. The format
is <code>major.minor.point</code>. Starting with Java 9 really only the major number is
determined.</td>
<td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
<td>exactly</td>
<td class="left">The version that this JVM is of exactly. The format
is <code>major.minor.point</code>. Starting with Java 9 really only the major number is
determined.</td>
</tr>
</table>
<p>An example:</p>
<pre><javaversion atleast="9"/></pre>
<p>will evaluate to true if the current JVM is Java 9 or above.</p>
</body>
</html>
|
