source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 24.2 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:34 NZST 2007 -->
6<TITLE>
7PresentSelector (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.selectors.PresentSelector 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="PresentSelector (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/types/selectors/OrSelector.html" title="class in org.apache.tools.ant.types.selectors"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors"><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="PresentSelector.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.types.DataType">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.types.selectors</FONT>
85<BR>
86Class PresentSelector</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/types/DataType.html" title="class in org.apache.tools.ant.types">org.apache.tools.ant.types.DataType</A>
91 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">org.apache.tools.ant.types.selectors.BaseSelector</A>
92 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.selectors.PresentSelector</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html" title="interface in org.apache.tools.ant.types.selectors">FileSelector</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>PresentSelector</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></DL>
100
101<P>
102Selector that filters files based on whether they appear in another
103 directory tree. It can contain a mapper element, so isn't available
104 as an ExtendSelector (since those parameters can't hold other
105 elements).
106<P>
107
108<P>
109<DL>
110<DT><B>Since:</B></DT>
111 <DD>1.5</DD>
112</DL>
113<HR>
114
115<P>
116<!-- ======== NESTED CLASS SUMMARY ======== -->
117
118<A NAME="nested_class_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Nested Class Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>static&nbsp;class</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors">PresentSelector.FilePresence</A></B></CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enumerated attribute with the values for indicating where a file's
131 presence is allowed and required.</TD>
132</TR>
133</TABLE>
134&nbsp;
135<!-- =========== FIELD SUMMARY =========== -->
136
137<A NAME="field_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TD COLSPAN=2><FONT SIZE="+2">
141<B>Field Summary</B></FONT></TD>
142</TR>
143</TABLE>
144&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
147<TD><B>Fields inherited from class org.apache.tools.ant.types.<A HREF="../../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#description">description</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></CODE></TD>
151</TR>
152</TABLE>
153&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
156<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>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
160</TR>
161</TABLE>
162&nbsp;
163<!-- ======== CONSTRUCTOR SUMMARY ======== -->
164
165<A NAME="constructor_summary"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
168<TD COLSPAN=2><FONT SIZE="+2">
169<B>Constructor Summary</B></FONT></TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#PresentSelector()">PresentSelector</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>PresentSelector</code> instance.</TD>
176</TR>
177</TABLE>
178&nbsp;
179<!-- ========== METHOD SUMMARY =========== -->
180
181<A NAME="method_summary"><!-- --></A>
182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184<TD COLSPAN=2><FONT SIZE="+2">
185<B>Method Summary</B></FONT></TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#createMapper()">createMapper</A></B>()</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines the FileNameMapper to use (nested mapper element).</TD>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197<CODE>&nbsp;boolean</CODE></FONT></TD>
198<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></B>(java.io.File&nbsp;basedir,
199 java.lang.String&nbsp;filename,
200 java.io.File&nbsp;file)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The heart of the matter.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#setPresent(org.apache.tools.ant.types.selectors.PresentSelector.FilePresence)">setPresent</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors">PresentSelector.FilePresence</A>&nbsp;fp)</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This sets whether to select a file if its dest file is present.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>&nbsp;void</CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#setTargetdir(java.io.File)">setTargetdir</A></B>(java.io.File&nbsp;targetdir)</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the file or directory which is checked for matching
220 files.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#toString()">toString</A></B>()</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.html#verifySettings()">verifySettings</A></B>()</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to make sure all settings are kosher.</TD>
237</TR>
238</TABLE>
239&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.selectors.BaseSelector"><!-- --></A>
240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
241<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
242<TD><B>Methods inherited from class org.apache.tools.ant.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></B></TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#getError()">getError</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#setError(java.lang.String)">setError</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#validate()">validate</A></CODE></TD>
246</TR>
247</TABLE>
248&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
251<TD><B>Methods inherited from class org.apache.tools.ant.types.<A HREF="../../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></CODE></TD>
255</TR>
256</TABLE>
257&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
258<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
259<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
260<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>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
264</TR>
265</TABLE>
266&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
269<TD><B>Methods inherited from class java.lang.Object</B></TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
273</TR>
274</TABLE>
275&nbsp;
276<P>
277
278<!-- ============ FIELD DETAIL =========== -->
279
280
281<!-- ========= CONSTRUCTOR DETAIL ======== -->
282
283<A NAME="constructor_detail"><!-- --></A>
284<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
285<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
286<TD COLSPAN=1><FONT SIZE="+2">
287<B>Constructor Detail</B></FONT></TD>
288</TR>
289</TABLE>
290
291<A NAME="PresentSelector()"><!-- --></A><H3>
292PresentSelector</H3>
293<PRE>
294public <B>PresentSelector</B>()</PRE>
295<DL>
296<DD>Creates a new <code>PresentSelector</code> instance.
297<P>
298</DL>
299
300<!-- ============ METHOD DETAIL ========== -->
301
302<A NAME="method_detail"><!-- --></A>
303<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
304<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
305<TD COLSPAN=1><FONT SIZE="+2">
306<B>Method Detail</B></FONT></TD>
307</TR>
308</TABLE>
309
310<A NAME="toString()"><!-- --></A><H3>
311toString</H3>
312<PRE>
313public java.lang.String <B>toString</B>()</PRE>
314<DL>
315<DD><DL>
316
317<DT><B>Returns:</B><DD>a string describing this object</DL>
318</DD>
319</DL>
320<HR>
321
322<A NAME="setTargetdir(java.io.File)"><!-- --></A><H3>
323setTargetdir</H3>
324<PRE>
325public void <B>setTargetdir</B>(java.io.File&nbsp;targetdir)</PRE>
326<DL>
327<DD>The name of the file or directory which is checked for matching
328 files.
329<P>
330<DD><DL>
331<DT><B>Parameters:</B><DD><CODE>targetdir</CODE> - the directory to scan looking for matching files.</DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="createMapper()"><!-- --></A><H3>
337createMapper</H3>
338<PRE>
339public <A HREF="../../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>createMapper</B>()
340 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
341<DL>
342<DD>Defines the FileNameMapper to use (nested mapper element).
343<P>
344<DD><DL>
345
346<DT><B>Returns:</B><DD>a mapper to be configured
347<DT><B>Throws:</B>
348<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if more that one mapper defined</DL>
349</DD>
350</DL>
351<HR>
352
353<A NAME="setPresent(org.apache.tools.ant.types.selectors.PresentSelector.FilePresence)"><!-- --></A><H3>
354setPresent</H3>
355<PRE>
356public void <B>setPresent</B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors">PresentSelector.FilePresence</A>&nbsp;fp)</PRE>
357<DL>
358<DD>This sets whether to select a file if its dest file is present.
359 It could be a <code>negate</code> boolean, but by doing things
360 this way, we get some documentation on how the system works.
361 A user looking at the documentation should clearly understand
362 that the ONLY files whose presence is being tested are those
363 that already exist in the source directory, hence the lack of
364 a <code>destonly</code> option.
365<P>
366<DD><DL>
367<DT><B>Parameters:</B><DD><CODE>fp</CODE> - An attribute set to either <code>srconly</code or
368 <code>both</code>.</DL>
369</DD>
370</DL>
371<HR>
372
373<A NAME="verifySettings()"><!-- --></A><H3>
374verifySettings</H3>
375<PRE>
376public void <B>verifySettings</B>()</PRE>
377<DL>
378<DD>Checks to make sure all settings are kosher. In this case, it
379 means that the targetdir attribute has been set and we have a mapper.
380<P>
381<DD><DL>
382<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#verifySettings()">verifySettings</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></CODE></DL>
383</DD>
384<DD><DL>
385</DL>
386</DD>
387</DL>
388<HR>
389
390<A NAME="isSelected(java.io.File, java.lang.String, java.io.File)"><!-- --></A><H3>
391isSelected</H3>
392<PRE>
393public boolean <B>isSelected</B>(java.io.File&nbsp;basedir,
394 java.lang.String&nbsp;filename,
395 java.io.File&nbsp;file)</PRE>
396<DL>
397<DD>The heart of the matter. This is where the selector gets to decide
398 on the inclusion of a file in a particular fileset.
399<P>
400<DD><DL>
401<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html" title="interface in org.apache.tools.ant.types.selectors">FileSelector</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></CODE></DL>
402</DD>
403<DD><DL>
404<DT><B>Parameters:</B><DD><CODE>basedir</CODE> - the base directory the scan is being done from<DD><CODE>filename</CODE> - is the name of the file to check<DD><CODE>file</CODE> - is a java.io.File object the selector can use
405<DT><B>Returns:</B><DD>whether the file should be selected or not</DL>
406</DD>
407</DL>
408<!-- ========= END OF CLASS DATA ========= -->
409<HR>
410
411
412<!-- ======= START OF BOTTOM NAVBAR ====== -->
413<A NAME="navbar_bottom"><!-- --></A>
414<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
415<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
416<TR>
417<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
418<A NAME="navbar_bottom_firstrow"><!-- --></A>
419<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
420 <TR ALIGN="center" VALIGN="top">
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
423 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
424 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
425 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
426 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
427 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
428 </TR>
429</TABLE>
430</TD>
431<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
432</EM>
433</TD>
434</TR>
435
436<TR>
437<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
438&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/OrSelector.html" title="class in org.apache.tools.ant.types.selectors"><B>PREV CLASS</B></A>&nbsp;
439&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors"><B>NEXT CLASS</B></A></FONT></TD>
440<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
441 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
442&nbsp;<A HREF="PresentSelector.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
443&nbsp;<SCRIPT type="text/javascript">
444 <!--
445 if(window==top) {
446 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
447 }
448 //-->
449</SCRIPT>
450<NOSCRIPT>
451 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
452</NOSCRIPT>
453
454</FONT></TD>
455</TR>
456<TR>
457<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
458 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.types.DataType">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
459<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
460DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
461</TR>
462</TABLE>
463<A NAME="skip-navbar_bottom"></A>
464<!-- ======== END OF BOTTOM NAVBAR ======= -->
465
466<HR>
467Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
468</BODY>
469</HTML>
Note: See TracBrowser for help on using the repository browser.