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
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
|
<!--
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><a name="Conditions">Conditions</a></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><a name="coreconditions">Core Conditions</a></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><a name="not">not</a></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><a name="and">and</a></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 && operator, as soon as one of the
nested conditions is false, no other condition will be evaluated.</p>
<h4><a name="or">or</a></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 || operator, as soon as one of the
nested conditions is true, no other condition will be evaluated.</p>
<h4><a name="xor">xor</a></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><a name="available">available</a></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><a name="uptodate">uptodate</a></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><a name="os">os</a></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 <i>all</i>
the tests succeed.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">family</td>
<td valign="top">The name of the operating system family to expect.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">name</td>
<td valign="top">The name of the operating system to expect.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">arch</td>
<td valign="top">The architecture of the operating system to expect.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">version</td>
<td valign="top">The version of the operating system to expect.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<p>Supported values for the family attribute are:
<ul>
<li>windows (for all versions of Microsoft Windows)</li>
<li>dos (for all Microsoft DOS based operating systems including
Microsoft Windows and OS/2)</li>
<li>mac (for all Apple Macintosh systems)</li>
<li>unix (for all Unix and Unix-like operating systems)</li>
<li>netware (for Novell NetWare)</li>
<li>os/2 (for OS/2)</li>
<li>tandem (for HP's NonStop Kernel - formerly Tandem)</li>
<li>win9x for Microsoft Windows 95 and 98, ME and CE</li>
<li>winnt for Microsoft Windows NT-based systems, including Windows 2000, XP and
successors</li>
<li>z/os for z/OS and OS/390</li>
<li>os/400 for OS/400</li>
<li>openvms for OpenVMS</li>
</ul>
<h4><a name="equals">equals</a></h4>
<p>Tests whether the two given values are equal.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">arg1</td>
<td valign="top">First value to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">arg2</td>
<td valign="top">Second value to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">casesensitive</td>
<td valign="top">Perform a case sensitive comparison. Default is
true.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">trim</td>
<td valign="top">Trim whitespace from arguments before comparing
them. Default is false.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">forcestring</td>
<td valign="top">Force string comparison of <code>arg1/arg2</code>.
Default is false. <em>Since Apache Ant 1.8.1</em>
</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h4><a name="isset">isset</a></h4>
<p>Test whether a given property has been set in this project.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">The name of the property to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h4><a name="checksum">checksum</a></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><a name="http">http</a></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 border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">url</td>
<td valign="top">The full URL of the page to request. The web server must
return a status code below the value of <tt>errorsBeginAt</tt></td>
<td align="center">Yes.</td>
</tr>
<tr>
<td valign="top">errorsBeginAt</td>
<td valign="top">The lowest HTTP response code that signals an error;
by default '400'; server errors, not-authorized, not-found and the like
are detected</td>
<td align="center">No</td>
</tr>
<tr>
<td valign="top">requestMethod</td>
<td valign="top">The HTTP method to be used when issuing the request.
Any of GET, POST, HEAD, OPTIONS, PUT, DELETEm and TRACE
are valid, subject to protocol restrictions. The default if not
specified is "GET".<br/>
<em>since Ant 1.8.0</em></td>
<td align="center">No</td>
</tr>
</table>
<h4><a name="socket">socket</a></h4>
<p>The <code>socket</code> condition checks for the existence of a
TCP/IP listener at the specified host and port.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">server</td>
<td valign="top">The DNS name or IP address of the server.</td>
<td align="center">Yes.</td>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">The port number to connect to.</td>
<td align="center">Yes.</td>
</tr>
</table>
<h4><a name="filesmatch">filesmatch</a></h4>
<p>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 comparison, 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.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file1</td>
<td valign="top">First file to test</td>
<td align="center">Yes</td>
</tr>
<tr>
<td valign="top">file2</td>
<td valign="top">Second file to test</td>
<td align="center">Yes</td>
</tr>
<tr>
<td valign="top">textfile</td>
<td valign="top">Whether to ignore line endings when comparing
files; defaults to <i>false</i> which triggers a binary
comparison. <b>Since Ant 1.7</b>
</td>
<td align="center">No</td>
</tr>
</table>
<h4><a name="contains">contains</a></h4>
<p>Tests whether a string contains another one.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">string</td>
<td valign="top">The string to search in.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">substring</td>
<td valign="top">The string to search for.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">casesensitive</td>
<td valign="top">Perform a case sensitive comparison. Default is
true.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h4><a name="istrue">istrue</a></h4>
<p>Tests whether a string equals any of the ant definitions of true,
that is "true","yes", or "on"</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">value to test</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<blockquote><pre>
<istrue value="${someproperty}"/>
<istrue value="false"/>
</pre></blockquote>
<h4><a name="isfalse">isfalse</a></h4>
<p>Tests whether a string is not true, the negation of <istrue>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">value to test</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<blockquote><pre>
<isfalse value="${someproperty}"/>
<isfalse value="false"/>
</pre></blockquote>
<h4><a name="isreference">isreference</a></h4>
<p>Test whether a given reference has been defined in this project and
- optionally - is of an expected type.</p>
<p>This condition has been added in Apache Ant 1.6.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">refid</td>
<td valign="top">The id of the reference to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">type</td>
<td valign="top">Name of the data type or task this reference is
expected to be.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h4><a name="issigned">issigned</a></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>
This condition was added in Apache Ant 1.7.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">
The jarfile that is to be tested for the presence
of a signature.
</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">name</td>
<td valign="top"> The signature name to check for.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h4><a name="isfileselected">isfileselected</a></h4>
<p>
Test whether a file passes an embedded
<a href="../Types/selectors.html">selector</a>.
</p>
<p>
This condition was added in Apache Ant 1.6.3.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">
The file to check if is passes the embedded selector.
</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">The base directory to use for name based selectors. It this is not set,
the project's basedirectory will be used.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<p>
Example usage:
</p>
<blockquote><pre>
<isfileselected file="a.xml">
<date datetime="06/28/2000 2:02 pm" when="equal"/>
</isfileselected>
</pre></blockquote>
<h4><a name="typefound">typefound</a></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>This condition was added in Apache Ant 1.7.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">name</td>
<td valign="top">name of the type</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">uri</td>
<td valign="top">
The uri that this type lives in.
</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<p>
Example usages:
</p>
<blockquote><pre>
<typefound name="junit"/>
<typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/>
</pre></blockquote>
<h4><a name="scriptcondition">scriptcondition</a></h4>
<p>Evaluate a condition based on a script in any
<a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a>
or
<a href="https://scripting.dev.java.net">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>This condition was added in Apache Ant 1.7.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">language</td>
<td valign="top">script language</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">manager</td>
<td valign="top">
The script engine manager to use.
See the <a href="../Tasks/script.html">script</a> task
for using this attribute.
</td>
<td valign="top" align="center">No - default is "auto"</td>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">default boolean value</td>
<td valign="top" align="center">No -default is "false"</td>
</tr>
<tr>
<td valign="top">src</td>
<td valign="top">filename of script source</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">setbeans</td>
<td valign="top">whether to have all properties, references and targets as
global variables in the script. <em>since Ant 1.8.0</em></td>
<td valign="top" align="center">No, default is "true".</td>
</tr>
<tr>
<td valign="top">classpath</td>
<td valign="top">
The classpath to pass into the script.
</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">classpathref</td>
<td valign="top">The classpath to use, given as a
<a href="../using.html#references">reference</a> to a path defined elsewhere.
<td align="center" valign="top">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>
<blockquote><pre>
<scriptcondition language="javascript"
value="true">
self.setValue(false);
</scriptcondition>
</pre></blockquote>
Sets the default value of the condition to true, then in the script,
sets the value to false. This condition always evaluates to "false"
<h4><a name="parsersupports">parsersupports</a></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>This condition was added in Apache Ant 1.7.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">property to set</td>
<td valign="top" align="center">one of property or feature</td>
</tr>
<tr>
<td valign="top">feature</td>
<td valign="top">feature to set</td>
<td valign="top" align="center">one of property or feature</td>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">string (property) or boolean (feature)</td>
<td valign="top" align="center">For property tests, but not for feature tests</td>
</tr>
</table>
<blockquote><pre>
<parsersupports feature="http://xml.org/sax/features/namespaces"/>
</pre></blockquote>
Check for namespace support. All SAX2 parsers should have this.
<blockquote><pre>
<or>
<parsersupports
feature="http://apache.org/xml/features/validation/schema"/>
<parsersupports
feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/>
</or>
</pre></blockquote>
Check for XML Schema support.
<pre>
<parsersupports
property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
value="document.xsd"/>
</pre>
Check for Xerces-specific definition of the location of the no namespace schema.
<h4><a name="isreachable">isreachable</a></h4>
<p>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.
</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 host, 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>
This condition was added in Apache Ant 1.7.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">host</td>
<td valign="top">host to check for</td>
<td valign="top" align="center">one of url or host</td>
</tr>
<tr>
<td valign="top">url</td>
<td valign="top">URL containing hostname</td>
<td valign="top" align="center">one of url or host</td>
</tr>
<tr>
<td valign="top">timeout</td>
<td valign="top">timeout in seconds</td>
<td valign="top" align="center">no, default is 30s</td>
</tr>
</table>
<blockquote><pre>
<condition property="offline">
<isreachable url="http://ibiblio.org/maven/" />
</condition>
</pre></blockquote>
<p>
Probe for the maven repository being reachable.
</p>
<blockquote><pre>
<condition property="offline">
<isreachable host="ibiblio.org" timeout="10" />
</condition>
</pre></blockquote>
<p>
Probe for the maven repository being reachable using the hostname, ten second timeout..
</p>
<h4><a name="length">length</a></h4>
<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.
<b>Since Ant 1.6.3</b>
</p>
<blockquote><pre>
<length string=" foo " trim="true" length="3" />
</pre></blockquote>
<p>Verify a string is of a certain length.</p>
<blockquote><pre>
<length file="foo" when="greater" length="0" />
</pre></blockquote>
<p>Verify that file <i>foo</i> is not empty.</p>
<h4><a name="isfailure">isfailure</a></h4>
<p>Test the return code of an executable (see the
<a href="exec.html">Exec</a> task) for failure. <b>Since Ant 1.7</b></p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">code</td>
<td valign="top">The return code to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h4><a name="resourcecount">resourcecount</a></h4>
<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>.
<b>Since Ant 1.7</b>
</p>
<blockquote><pre>
<resourcecount refid="myresourcecollection" when="greater" count="0" />
</pre></blockquote>
<p>Verify that a resource collection is not empty.</p>
<h4><a name="resourcesmatch">resourcesmatch</a></h4>
<p>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 comparison, 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
<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. <b>Since Ant 1.7</b>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">astext</td>
<td valign="top">Whether to ignore line endings
when comparing resource content; defaults to <i>false</i>,
while <i>true</i> triggers a binary comparison.
</td>
<td align="center">No</td>
</tr>
</table>
<h4><a name="resourcecontains">resourcecontains</a></h4>
<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 resource attribute. <b>Since Ant 1.7.1</b>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">resource</td>
<td valign="top">Name of a file that is the resource to test.
</td>
<td align="center" rowspan="2">One of the two</td>
</tr>
<tr>
<td valign="top">refid</td>
<td valign="top">Reference to a resource defined inside the project.</td>
</tr>
<tr>
<td valign="top">substring</td>
<td valign="top">The string to search for.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">casesensitive</td>
<td valign="top">Perform a case sensitive comparison. Default is
true.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h4><a name="hasmethod">hasmethod</a></h4>
<p> Tests for a class having a method or field. If the class is not found
or fails to load, the build fails.
<b>Since Ant 1.7</b>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">classname</td>
<td valign="top">name of the class to load</td>
<td align="center">yes</td>
</tr>
<tr>
<td valign="top">field</td>
<td valign="top">name of a field to look for</td>
<td align="center">one of field or method</td>
</tr>
<tr>
<td valign="top">method</td>
<td valign="top">name of a method to look for</td>
<td align="center">one of field or method</td>
</tr>
<tr>
<td valign="top">ignoreSystemClasses</td>
<td valign="top">should system classes be ignored?</td>
<td align="center">No -default is false</td>
</tr>
<tr>
<td valign="top">classpath</td>
<td valign="top">a class path</td>
<td align="center">No</td>
</tr>
<tr>
<td valign="top">classpathref</td>
<td valign="top">reference to a class path</td>
<td align="center">No</td>
</tr>
</table>
<p>
There is also a nested <classpath> element, which can be used to specify
a classpath.
</p>
<blockquote><pre>
<hasmethod classname="java.util.ArrayList" method="trimToSize" />
</pre></blockquote>
<p>Looks for the method trimToSize in the ArrayList class.</p>
<h4><a name="matches">matches</a></h4>
<p>
Test if the specified string matches the specified regular
expression pattern.
<b>Since Ant 1.7</b></p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">string</td>
<td valign="top">The string to test.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">pattern</td>
<td valign="top">The regular expression pattern used to test.</td>
<td valign="top" align="center">Yes, unless there is a nested
<code><regexp></code> element.</td>
</tr>
<tr>
<td valign="top">casesensitive</td>
<td valign="top">Perform a case sensitive match. Default is
true.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">multiline</td>
<td valign="top">
Perform a multi line match.
Default is false.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">singleline</td>
<td valign="top">
This allows '.' to match new lines.
SingleLine is not to be confused with multiline, SingleLine is a perl
regex term, it corresponds to dotall in java regex.
Default is false.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<p>
There is also an optional <regexp> element, which can be used to specify
a regular expression instead of the "pattern" 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>
<blockquote><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></blockquote>
<p>
The following example sets the property "ok" if
the property "input" is three characters long, starting
with 'a' and ending with 'b'.
</p>
<blockquote><pre>
<condition property="ok">
<matches string="${input}" pattern="^a.b$"/>
</condition>
</pre></blockquote>
<p>
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:
</p>
<blockquote><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></blockquote>
<p>
The following example shows the use of the singleline and the casesensitive
flags.
</p>
<blockquote><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></blockquote>
<h4><a name="antversion">antversion</a></h4>
<p>This condition is identical to the <a
href="antversion.html">Antversion</a> task, all attributes are supported, the property attribute
is redundant and will be ignored.</p>
<h4><a name="hasfreespace">hasfreespace</a></h4>
<p>
Tests a partition to see if there is enough space.
<b>Since Ant 1.7.0</b></p>
<p>Needed attribute can be specified using standard computing terms:<br/>
<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>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">partition</td>
<td valign="top">The partition or filesystem to check for freespace</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">needed</td>
<td valign="top">The amount of freespace needed.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<p>
An example:
</p>
<blockquote><pre>
<hasfreespace partition="c:" needed="100M"/>
</pre></blockquote>
<h4><a name="islastmodified">islastmodified</a></h4>
<p>Tests the last modified date of a resource. <em>Since Ant
1.8.0</em></p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">millis</td>
<td valign="top">Specifies the expected modification time of the resource
in milliseconds since midnight Jan 1 1970.</td>
<td valign="center" align="center" rowspan="2">Exactly one of the
two.</td>
</tr>
<tr>
<td valign="top">datetime</td>
<td valign="top">Specifies the expected modification time of the
resource. The special value "now" indicates the
current time.</td>
</tr>
<tr>
<td valign="top">pattern</td>
<td valign="top">SimpleDateFormat-compatible pattern string.
Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM.
</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">mode</td>
<td valign="top">How to compare the timestamp. Accepted values
are "equals", "before", "not-before", "after" and "not-after".
<td valign="top">No, defaults to "equals".</td>
</tr>
</table>
<p>The actual resource to test is specified as a nested element.</p>
<p>
An example:
</p>
<blockquote><pre>
<islastmodified dateTime="08/18/2009 04:41:19 AM" mode="not-before">
<file file="${file}"/>
</islastmodified>
</pre></blockquote>
<h4><a name="resourceexists">resourceexists</a></h4>
<p>Tests a resource for existence. <em>since Ant 1.8.0</em></p>
<p>The actual resource to test is specified as a nested element.</p>
<p>
An example:
</p>
<blockquote><pre>
<resourceexists>
<file file="${file}"/>
</resourceexists>
</pre></blockquote>
</body>
</html>
|
