source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Available.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 30.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:17 NZST 2007 -->
6<TITLE>
7Available (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Available class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Available (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/AntStructure.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Available.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs</FONT>
85<BR>
86Class Available</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Available</B>
92</PRE>
93<DL>
94<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></DD>
95</DL>
96<HR>
97<DL>
98<DT>public class <B>Available</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A><DT>implements <A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></DL>
99
100<P>
101Will set the given property if the requested resource is available at
102 runtime. This task may also be used as a condition by the condition task.
103<P>
104
105<P>
106<DL>
107<DT><B>Since:</B></DT>
108 <DD>Ant 1.1</DD>
109</DL>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115<A NAME="nested_class_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Nested Class Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>static&nbsp;class</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs">Available.FileDir</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;EnumeratedAttribute covering the file types to be checked for, either
128 file or dir.</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- =========== FIELD SUMMARY =========== -->
133
134<A NAME="field_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Field Summary</B></FONT></TD>
139</TR>
140</TABLE>
141&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
144<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
148</TR>
149</TABLE>
150&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
153<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
157</TR>
158</TABLE>
159&nbsp;
160<!-- ======== CONSTRUCTOR SUMMARY ======== -->
161
162<A NAME="constructor_summary"><!-- --></A>
163<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
164<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
165<TD COLSPAN=2><FONT SIZE="+2">
166<B>Constructor Summary</B></FONT></TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#Available()">Available</A></B>()</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173</TR>
174</TABLE>
175&nbsp;
176<!-- ========== METHOD SUMMARY =========== -->
177
178<A NAME="method_summary"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181<TD COLSPAN=2><FONT SIZE="+2">
182<B>Method Summary</B></FONT></TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#createClasspath()">createClasspath</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Classpath to be used when searching for classes and resources.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#createFilepath()">createFilepath</A></B>()</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Path to search for file resources.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;boolean</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#eval()">eval</A></B>()</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Evaluate the availability of a resource.</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;void</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#execute()">execute</A></B>()</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Entry point when operating as a task.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;void</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setClassname(java.lang.String)">setClassname</A></B>(java.lang.String&nbsp;classname)</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a classname of a class which must be available to set the given
223 property.</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;void</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the classpath to be used when searching for classes and resources.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;void</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the classpath by reference.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setFile(java.io.File)">setFile</A></B>(java.io.File&nbsp;file)</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the file which must be present in the file system to set the given
248 property.</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>&nbsp;void</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setFilepath(org.apache.tools.ant.types.Path)">setFilepath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;filepath)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the path to use when looking for a file.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;void</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setIgnoresystemclasses(boolean)">setIgnoresystemclasses</A></B>(boolean&nbsp;ignore)</CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether the search for classes should ignore the runtime classes and
265 just use the given classpath.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String&nbsp;property)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the property which will be set if the particular resource
274 is available.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setResource(java.lang.String)">setResource</A></B>(java.lang.String&nbsp;resource)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of a Java resource which is required to set the property.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;void</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setType(org.apache.tools.ant.taskdefs.Available.FileDir)">setType</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs">Available.FileDir</A>&nbsp;type)</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set what type of file is required - either directory or file.</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;void</CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setType(java.lang.String)">setType</A></B>(java.lang.String&nbsp;type)</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>setType(String) is deprecated and is replaced with
299 setType(Available.FileDir) to make Ant's Introspection
300 mechanism do the work and also to encapsulate operations on
301 the type in its own class.</I></TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>&nbsp;void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String&nbsp;value)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value to be given to the property if the desired resource is
310 available.</TD>
311</TR>
312</TABLE>
313&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
314<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
315<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
316<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
320</TR>
321</TABLE>
322&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
323<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
324<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
325<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
329</TR>
330</TABLE>
331&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
332<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
333<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
334<TD><B>Methods inherited from class java.lang.Object</B></TD>
335</TR>
336<TR BGCOLOR="white" CLASS="TableRowColor">
337<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
338</TR>
339</TABLE>
340&nbsp;
341<P>
342
343<!-- ============ FIELD DETAIL =========== -->
344
345
346<!-- ========= CONSTRUCTOR DETAIL ======== -->
347
348<A NAME="constructor_detail"><!-- --></A>
349<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
350<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
351<TD COLSPAN=1><FONT SIZE="+2">
352<B>Constructor Detail</B></FONT></TD>
353</TR>
354</TABLE>
355
356<A NAME="Available()"><!-- --></A><H3>
357Available</H3>
358<PRE>
359public <B>Available</B>()</PRE>
360<DL>
361</DL>
362
363<!-- ============ METHOD DETAIL ========== -->
364
365<A NAME="method_detail"><!-- --></A>
366<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
367<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
368<TD COLSPAN=1><FONT SIZE="+2">
369<B>Method Detail</B></FONT></TD>
370</TR>
371</TABLE>
372
373<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
374setClasspath</H3>
375<PRE>
376public void <B>setClasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</PRE>
377<DL>
378<DD>Set the classpath to be used when searching for classes and resources.
379<P>
380<DD><DL>
381</DL>
382</DD>
383<DD><DL>
384<DT><B>Parameters:</B><DD><CODE>classpath</CODE> - an Ant Path object containing the search path.</DL>
385</DD>
386</DL>
387<HR>
388
389<A NAME="createClasspath()"><!-- --></A><H3>
390createClasspath</H3>
391<PRE>
392public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
393<DL>
394<DD>Classpath to be used when searching for classes and resources.
395<P>
396<DD><DL>
397</DL>
398</DD>
399<DD><DL>
400
401<DT><B>Returns:</B><DD>an empty Path instance to be configured by Ant.</DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="setClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
407setClasspathRef</H3>
408<PRE>
409public void <B>setClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
410<DL>
411<DD>Set the classpath by reference.
412<P>
413<DD><DL>
414</DL>
415</DD>
416<DD><DL>
417<DT><B>Parameters:</B><DD><CODE>r</CODE> - a Reference to a Path instance to be used as the classpath
418 value.</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="setFilepath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
424setFilepath</H3>
425<PRE>
426public void <B>setFilepath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;filepath)</PRE>
427<DL>
428<DD>Set the path to use when looking for a file.
429<P>
430<DD><DL>
431</DL>
432</DD>
433<DD><DL>
434<DT><B>Parameters:</B><DD><CODE>filepath</CODE> - a Path instance containing the search path for files.</DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="createFilepath()"><!-- --></A><H3>
440createFilepath</H3>
441<PRE>
442public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createFilepath</B>()</PRE>
443<DL>
444<DD>Path to search for file resources.
445<P>
446<DD><DL>
447</DL>
448</DD>
449<DD><DL>
450
451<DT><B>Returns:</B><DD>a new Path instance which Ant will configure with a file search
452 path.</DL>
453</DD>
454</DL>
455<HR>
456
457<A NAME="setProperty(java.lang.String)"><!-- --></A><H3>
458setProperty</H3>
459<PRE>
460public void <B>setProperty</B>(java.lang.String&nbsp;property)</PRE>
461<DL>
462<DD>Set the name of the property which will be set if the particular resource
463 is available.
464<P>
465<DD><DL>
466</DL>
467</DD>
468<DD><DL>
469<DT><B>Parameters:</B><DD><CODE>property</CODE> - the name of the property to set.</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
475setValue</H3>
476<PRE>
477public void <B>setValue</B>(java.lang.String&nbsp;value)</PRE>
478<DL>
479<DD>Set the value to be given to the property if the desired resource is
480 available.
481<P>
482<DD><DL>
483</DL>
484</DD>
485<DD><DL>
486<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be given.</DL>
487</DD>
488</DL>
489<HR>
490
491<A NAME="setClassname(java.lang.String)"><!-- --></A><H3>
492setClassname</H3>
493<PRE>
494public void <B>setClassname</B>(java.lang.String&nbsp;classname)</PRE>
495<DL>
496<DD>Set a classname of a class which must be available to set the given
497 property.
498<P>
499<DD><DL>
500</DL>
501</DD>
502<DD><DL>
503<DT><B>Parameters:</B><DD><CODE>classname</CODE> - the name of the class required.</DL>
504</DD>
505</DL>
506<HR>
507
508<A NAME="setFile(java.io.File)"><!-- --></A><H3>
509setFile</H3>
510<PRE>
511public void <B>setFile</B>(java.io.File&nbsp;file)</PRE>
512<DL>
513<DD>Set the file which must be present in the file system to set the given
514 property.
515<P>
516<DD><DL>
517</DL>
518</DD>
519<DD><DL>
520<DT><B>Parameters:</B><DD><CODE>file</CODE> - the name of the file which is required.</DL>
521</DD>
522</DL>
523<HR>
524
525<A NAME="setResource(java.lang.String)"><!-- --></A><H3>
526setResource</H3>
527<PRE>
528public void <B>setResource</B>(java.lang.String&nbsp;resource)</PRE>
529<DL>
530<DD>Set the name of a Java resource which is required to set the property.
531<P>
532<DD><DL>
533</DL>
534</DD>
535<DD><DL>
536<DT><B>Parameters:</B><DD><CODE>resource</CODE> - the name of a resource which is required to be available.</DL>
537</DD>
538</DL>
539<HR>
540
541<A NAME="setType(java.lang.String)"><!-- --></A><H3>
542setType</H3>
543<PRE>
544public void <B>setType</B>(java.lang.String&nbsp;type)</PRE>
545<DL>
546<DD><B>Deprecated.</B>&nbsp;<I>setType(String) is deprecated and is replaced with
547 setType(Available.FileDir) to make Ant's Introspection
548 mechanism do the work and also to encapsulate operations on
549 the type in its own class.</I>
550<P>
551<DD><DL>
552</DL>
553</DD>
554<DD><DL>
555<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type of resource</DL>
556</DD>
557</DL>
558<HR>
559
560<A NAME="setType(org.apache.tools.ant.taskdefs.Available.FileDir)"><!-- --></A><H3>
561setType</H3>
562<PRE>
563public void <B>setType</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs">Available.FileDir</A>&nbsp;type)</PRE>
564<DL>
565<DD>Set what type of file is required - either directory or file.
566<P>
567<DD><DL>
568</DL>
569</DD>
570<DD><DL>
571<DT><B>Parameters:</B><DD><CODE>type</CODE> - an instance of the FileDir enumeratedAttribute indicating
572 whether the file required is to be a directory or a plain
573 file.</DL>
574</DD>
575</DL>
576<HR>
577
578<A NAME="setIgnoresystemclasses(boolean)"><!-- --></A><H3>
579setIgnoresystemclasses</H3>
580<PRE>
581public void <B>setIgnoresystemclasses</B>(boolean&nbsp;ignore)</PRE>
582<DL>
583<DD>Set whether the search for classes should ignore the runtime classes and
584 just use the given classpath.
585<P>
586<DD><DL>
587</DL>
588</DD>
589<DD><DL>
590<DT><B>Parameters:</B><DD><CODE>ignore</CODE> - true if system classes are to be ignored.</DL>
591</DD>
592</DL>
593<HR>
594
595<A NAME="execute()"><!-- --></A><H3>
596execute</H3>
597<PRE>
598public void <B>execute</B>()
599 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
600<DL>
601<DD>Entry point when operating as a task.
602<P>
603<DD><DL>
604<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
605</DD>
606<DD><DL>
607
608<DT><B>Throws:</B>
609<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the task is not configured correctly.</DL>
610</DD>
611</DL>
612<HR>
613
614<A NAME="eval()"><!-- --></A><H3>
615eval</H3>
616<PRE>
617public boolean <B>eval</B>()
618 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
619<DL>
620<DD>Evaluate the availability of a resource.
621<P>
622<DD><DL>
623<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html#eval()">eval</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></CODE></DL>
624</DD>
625<DD><DL>
626
627<DT><B>Returns:</B><DD>boolean is the resource is available.
628<DT><B>Throws:</B>
629<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the condition is not configured correctly</DL>
630</DD>
631</DL>
632<!-- ========= END OF CLASS DATA ========= -->
633<HR>
634
635
636<!-- ======= START OF BOTTOM NAVBAR ====== -->
637<A NAME="navbar_bottom"><!-- --></A>
638<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
639<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
640<TR>
641<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
642<A NAME="navbar_bottom_firstrow"><!-- --></A>
643<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
644 <TR ALIGN="center" VALIGN="top">
645 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
646 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
647 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
648 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
649 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
650 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
651 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
652 </TR>
653</TABLE>
654</TD>
655<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
656</EM>
657</TD>
658</TR>
659
660<TR>
661<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
662&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/AntStructure.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
663&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
664<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
665 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
666&nbsp;<A HREF="Available.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
667&nbsp;<SCRIPT type="text/javascript">
668 <!--
669 if(window==top) {
670 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
671 }
672 //-->
673</SCRIPT>
674<NOSCRIPT>
675 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
676</NOSCRIPT>
677
678</FONT></TD>
679</TR>
680<TR>
681<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
682 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
683<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
684DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
685</TR>
686</TABLE>
687<A NAME="skip-navbar_bottom"></A>
688<!-- ======== END OF BOTTOM NAVBAR ======= -->
689
690<HR>
691Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
692</BODY>
693</HTML>
Note: See TracBrowser for help on using the repository browser.