KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > condition > solo > CompoundRuleTask


1 /**
2  * $Id: CompoundRuleTask.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2002-2004 iDare Media, Inc. All rights reserved.
4  *
5  * Originally written by iDare Media, Inc. for release into the public domain. This
6  * library, source form and binary form, is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License as published by the
8  * Free Software Foundation; either version 2.1 of the License, or (at your option) any
9  * later version.<p>
10  *
11  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  * See the GNU LGPL (GNU Lesser General Public License) for more details.<p>
14  *
15  * You should have received a copy of the GNU Lesser General Public License along with this
16  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17  * 330, Boston, MA 02111-1307 USA. The LGPL can be found online at
18  * http://www.fsf.org/copyleft/lesser.html<p>
19  *
20  * This product has been influenced by several projects within the open-source community.
21  * The JWare developers wish to acknowledge the open-source community's support. For more
22  * information regarding the open-source products used within JWare, please visit the
23  * JWare website.
24  *----------------------------------------------------------------------------------------*
25  * WEBSITE- http://www.jware.info EMAIL- inquiries@jware.info
26  *----------------------------------------------------------------------------------------*
27  **/
28
29 package com.idaremedia.antx.condition.solo;
30
31 import org.apache.tools.ant.taskdefs.Available;
32 import org.apache.tools.ant.taskdefs.Checksum;
33 import org.apache.tools.ant.taskdefs.UpToDate;
34 import org.apache.tools.ant.taskdefs.condition.*;
35
36 import com.idaremedia.antx.condition.AllSet;
37 import com.idaremedia.antx.condition.AllSetTrue;
38 import com.idaremedia.antx.condition.AnySet;
39 import com.idaremedia.antx.condition.AnySetTrue;
40 import com.idaremedia.antx.condition.FileNotEmpty;
41 import com.idaremedia.antx.condition.IsAntVersion;
42 import com.idaremedia.antx.condition.IsBoolean;
43 import com.idaremedia.antx.condition.IsClass;
44 import com.idaremedia.antx.condition.IsDirectory;
45 import com.idaremedia.antx.condition.IsNotSet;
46 import com.idaremedia.antx.condition.IsNotWhitespace;
47 import com.idaremedia.antx.condition.IsNumeric;
48 import com.idaremedia.antx.condition.IsReference;
49 import com.idaremedia.antx.condition.IsResource;
50 import com.idaremedia.antx.condition.IsSetTrue;
51 import com.idaremedia.antx.condition.Matches;
52 import com.idaremedia.antx.condition.NoneSet;
53 import com.idaremedia.antx.condition.StringEquals;
54 import com.idaremedia.antx.print.EchoItemsTask;
55
56 /**
57  * Adds several Condition compatible nested elements to a generic RuleTask. Basically
58  * a big ol' cut-n-paste from ConditionBase's source ;-) with the additional
59  * AntX conditions thrown in. Although, as of Ant 1.6 with its introduction of
60  * {@linkplain FreeformRule}, it is no longer necessary to update this task with all
61  * nestable conditions, it's still a good idea to do. By explicitly including a nested
62  * element handler we allow script writers to use our conditions without having to
63  * declare them manually.
64  *
65  * @since JWare/AntX 0.1
66  * @author ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
67  * @version 0.5
68  * @.safety single
69  * @.group impl,helper
70  **/
71
72 public abstract class CompoundRuleTask extends RuleTask
73 {
74     /**
75      * Initializes a new CompoundRuleTask instance.
76      **/
77     protected CompoundRuleTask()
78     {
79         super();
80     }
81
82
83     /**
84      * Initializes a new CV-labeled CompoundRuleTask instance.
85      * @param iam CV-label (non-null)
86      **/
87     protected CompoundRuleTask(String JavaDoc iam)
88     {
89         super(iam);
90     }
91
92
93     /**
94      * Initializes a new CompoundRuleTask subclass with custom
95      * embedded setting.
96      * @param iam CV-label
97      * @param embed <i>true</i> if embedded
98      **/
99     protected CompoundRuleTask(String JavaDoc iam, boolean embed)
100     {
101         super(iam,embed);
102     }
103
104
105 // ---------------------------------------------------------------------------------------
106 // Conditions that match standard Ant 'condition':
107 // ---------------------------------------------------------------------------------------
108
109     /**
110      * Adds a &lt;not&gt; condition container to this rule.
111      **/
112     public void addNot(Not n)
113     {
114         xaddCondition(n);
115     }
116
117
118     /**
119      * Adds an &lt;and&gt; condition container to this rule.
120      **/
121     public void addAnd(And a)
122     {
123         xaddCondition(a);
124     }
125
126
127     /**
128      * Adds an &lt;or&gt; condition container to this rule.
129      **/
130     public void addOr(Or o)
131     {
132         xaddCondition(o);
133     }
134
135
136     /**
137      * Adds an &lt;available&gt; condition to this rule.
138      **/
139     public void addAvailable(Available a)
140     {
141         xaddCondition(a);
142     }
143
144
145     /**
146      * Adds an &lt;uptodate&gt; condition to this rule.
147      **/
148     public void addUpToDate(UpToDate u)
149     {
150         xaddCondition(u);
151     }
152
153
154     /**
155      * Adds a &lt;contains&gt; condition to this rule.
156      **/
157     public void addContains(Contains match)
158     {
159         xaddCondition(match);
160     }
161
162
163     /**
164      * Adds an &lt;istrue&gt; condition to this rule.
165      **/
166     public void addIsTrue(IsTrue isT)
167     {
168         xaddCondition(isT);
169     }
170
171
172     /**
173      * Adds an &lt;isfalse&gt; condition to this rule.
174      **/
175     public void addIsFalse(IsFalse isF)
176     {
177         xaddCondition(isF);
178     }
179
180
181     /**
182      * Adds an &lt;os&gt; condition to this rule.
183      **/
184     public void addOS(Os os)
185     {
186         xaddCondition(os);
187     }
188
189
190     /**
191      * Adds an &lt;http&gt; condition to this rule.
192      **/
193     public void addHTTP(Http h)
194     {
195         xaddCondition(h);
196     }
197
198
199     /**
200      * Synonym for {@linkplain #addHTTP addHTTP} that better
201      * reflects its purpose.
202      **/
203     public final void addHTTPAlive(Http h)
204     {
205         addHTTP(h);
206     }
207
208
209     /**
210      * Adds a &lt;socket&gt; condition to this rule.
211      **/
212     public void addSocket(Socket soc)
213     {
214         xaddCondition(soc);
215     }
216
217
218     /**
219      * Adds an &lt;checksum&gt; condition to this rule.
220      **/
221     public void addChecksum(Checksum a)
222     {
223         xaddCondition(a);
224     }
225
226
227     /**
228      * Adds an &lt;filesmatch&gt; condition to this rule.
229      **/
230     public void addFilesmatch(FilesMatch fm)
231     {
232         xaddCondition(fm);
233     }
234
235
236 // ---------------------------------------------------------------------------------------
237 // AntX extended conditons:
238 // ---------------------------------------------------------------------------------------
239
240     /**
241      * Adds a dummy &lt;print&gt; condition; diagnostic aid.
242      * @since JWare/AntX 0.2
243      **/
244     public final void addPrint(EchoItemsTask debugprint)
245     {
246         xaddCondition(debugprint);
247     }
248
249
250     /**
251      * Adds an &lt;isnotwhitespace&gt; condition to this rule.
252      **/
253     public void addIsNotWhitespace(IsNotWhitespace ws)
254     {
255         xaddCondition(ws);
256     }
257
258
259     /**
260      * Adds an &lt;isboolean&gt; condition to this rule.
261      * @since JWare/AntX 0.2
262      **/
263     public void addIsBoolean(IsBoolean isb)
264     {
265         xaddCondition(isb);
266     }
267
268
269     /**
270      * Adds an &lt;isnumeric&gt; condition to this rule.
271      **/
272     public void addIsNumeric(IsNumeric isN)
273     {
274         xaddCondition(isN);
275     }
276
277
278     /**
279      * Adds an &lt;isclass&gt; condition to this rule.
280      **/
281     public void addIsClass(IsClass isClz)
282     {
283         xaddCondition(isClz);
284     }
285
286
287     /**
288      * Adds an &lt;isresource&gt; condition to this rule.
289      **/
290     public void addIsResource(IsResource isR)
291     {
292         xaddCondition(isR);
293     }
294
295
296     /**
297      * Adds an &lt;isdirectory&gt; condition to this rule.
298      * @since JWare/AntX 0.5
299      **/
300     public void addIsDirectory(IsDirectory isD)
301     {
302         xaddCondition(isD);
303     }
304
305
306     /**
307      * Adds an &lt;isreference&gt; condition to this rule.
308      **/
309     public void addIsReference(IsReference isR)
310     {
311         xaddCondition(isR);
312     }
313
314
315     /**
316      * Adds a &lt;isset&gt; condition to this rule.
317      **/
318     public void addIsSet(com.idaremedia.antx.condition.IsSet iss)
319     {
320         xaddCondition(iss);
321     }
322
323
324     /**
325      * Adds a &lt;issettrue&gt; condition to this rule.
326      * @since JWare/AntX 0.2
327      **/
328     public void addIsSetTrue(IsSetTrue ist)
329     {
330         xaddCondition(ist);
331     }
332
333
334     /**
335      * Adds a &lt;isnotset&gt; condition to this rule.
336      **/
337     public void addIsNotSet(IsNotSet ins)
338     {
339         xaddCondition(ins);
340     }
341
342
343     /**
344      * Adds an &lt;allset&gt; condition to this rule.
345      * @since JWare/AntX 0.2
346      **/
347     public void addIsAllSet(AllSet allset)
348     {
349         xaddCondition(allset);
350     }
351
352
353     /**
354      * Synonym for {@linkplain #addIsAllSet addIsAllSet}.
355      * @since JWare/AntX 0.2
356      **/
357     public final void addAllSet(AllSet allset)
358     {
359         addIsAllSet(allset);
360     }
361
362
363     /**
364      * Adds an &lt;allsettrue&gt; condition to this rule.
365      * @since JWare/AntX 0.5
366      **/
367     public void addIsAllSetTrue(AllSetTrue allset)
368     {
369         xaddCondition(allset);
370     }
371
372
373     /**
374      * Synonym for {@linkplain #addIsAllSetTrue addIsAllSetTrue}.
375      * @since JWare/AntX 0.5
376      **/
377     public final void addAllSetTrue(AllSetTrue allset)
378     {
379         addIsAllSetTrue(allset);
380     }
381
382
383     /**
384      * Adds a &lt;noneset&gt; condition to this rule.
385      * @since JWare/AntX 0.2
386      **/
387     public void addIsNoneSet(NoneSet noneset)
388     {
389         xaddCondition(noneset);
390     }
391
392
393     /**
394      * Synonym for {@linkplain #addIsNoneSet addIsNoneSet}.
395      * @since JWare/AntX 0.2
396      **/
397     public final void addNoneSet(NoneSet noneset)
398     {
399         addIsNoneSet(noneset);
400     }
401
402
403     /**
404      * Adds an &lt;anyset&gt; condition to this rule.
405      * @since JWare/AntX 0.2
406      **/
407     public void addIsAnySet(AnySet anyset)
408     {
409         xaddCondition(anyset);
410     }
411
412
413     /**
414      * Synonym for {@linkplain #addIsAnySet addIsAnySet}.
415      * @since JWare/AntX 0.2
416      **/
417     public final void addAnySet(AnySet anyset)
418     {
419         addIsAnySet(anyset);
420     }
421
422
423     /**
424      * Adds an &lt;anysettrue&gt; condition to this rule.
425      * @since JWare/AntX 0.5
426      **/
427     public void addIsAnySetTrue(AnySetTrue anyset)
428     {
429         xaddCondition(anyset);
430     }
431
432
433     /**
434      * Synonym for {@linkplain #addIsAnySetTrue addIsAnySetTrue}.
435      * @since JWare/AntX 0.5
436      **/
437     public final void addAnySetTrue(AnySetTrue anyset)
438     {
439         addIsAnySetTrue(anyset);
440     }
441
442
443     /**
444      * Adds an &lt;filenotempty&gt; condition to this rule.
445      * @since JWare/AntX 0.2
446      **/
447     public void addFileNotEmpty(FileNotEmpty fne)
448     {
449         xaddCondition(fne);
450     }
451
452
453     /**
454      * Adds an &lt;equals&gt; condition to this rule.
455      * @since JWare/AntX 0.3 (converted to AntX StringEquals)
456      **/
457     public void addEquals(StringEquals e)
458     {
459         xaddCondition(e);
460     }
461
462
463     /**
464      * Adds an &lt;ismatch&gt; condition to this rule.
465      * @since JWare/AntX 0.3
466      **/
467     public void addIsMatch(Matches mc)
468     {
469         xaddCondition(mc);
470     }
471
472
473
474     /**
475      * Synonym for {@linkplain #addIsMatch addIsMatch}.
476      * @since JWare/AntX 0.2
477      **/
478     public final void addMatches(Matches mc)
479     {
480         addIsMatch(mc);
481     }
482
483
484
485     /**
486      * Adds an &lt;antversion&gt; condition to this rule.
487      * @since JWare/AntX 0.4
488      **/
489     public void addAntVersion(IsAntVersion vc)
490     {
491         xaddCondition(vc);
492     }
493 }
494
495 /* end-of-CompoundRuleTask.java */
496
Popular Tags