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

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

initial import of LiRK3
File size: 28.6 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:33 NZST 2007 -->
6<TITLE>
7FilenameSelector (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.selectors.FilenameSelector 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="FilenameSelector (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/ExtendSelector.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/MajoritySelector.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="FilenameSelector.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;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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 FilenameSelector</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"><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">org.apache.tools.ant.types.selectors.BaseExtendSelector</A>
93 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.selectors.FilenameSelector</B>
94</PRE>
95<DL>
96<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/types/selectors/ExtendFileSelector.html" title="interface in org.apache.tools.ant.types.selectors">ExtendFileSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html" title="interface in org.apache.tools.ant.types.selectors">FileSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html" title="interface in org.apache.tools.ant.types">Parameterizable</A></DD>
97</DL>
98<HR>
99<DL>
100<DT>public class <B>FilenameSelector</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></DL>
101
102<P>
103Selector that filters files based on the filename.
104<P>
105
106<P>
107<DL>
108<DT><B>Since:</B></DT>
109 <DD>1.5</DD>
110</DL>
111<HR>
112
113<P>
114<!-- ======== NESTED CLASS SUMMARY ======== -->
115
116
117<!-- =========== FIELD SUMMARY =========== -->
118
119<A NAME="field_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TD COLSPAN=2><FONT SIZE="+2">
123<B>Field Summary</B></FONT></TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#CASE_KEY">CASE_KEY</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#NAME_KEY">NAME_KEY</A></B></CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
144<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#NEGATE_KEY">NEGATE_KEY</A></B></CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
148</TR>
149</TABLE>
150&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.selectors.BaseExtendSelector"><!-- --></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.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></B></TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#parameters">parameters</A></CODE></TD>
157</TR>
158</TABLE>
159&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
162<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>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<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>
166</TR>
167</TABLE>
168&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<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>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
175</TR>
176</TABLE>
177&nbsp;
178<!-- ======== CONSTRUCTOR SUMMARY ======== -->
179
180<A NAME="constructor_summary"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183<TD COLSPAN=2><FONT SIZE="+2">
184<B>Constructor Summary</B></FONT></TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#FilenameSelector()">FilenameSelector</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>FilenameSelector</code> instance.</TD>
191</TR>
192</TABLE>
193&nbsp;
194<!-- ========== METHOD SUMMARY =========== -->
195
196<A NAME="method_summary"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TD COLSPAN=2><FONT SIZE="+2">
200<B>Method Summary</B></FONT></TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;boolean</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></B>(java.io.File&nbsp;basedir,
206 java.lang.String&nbsp;filename,
207 java.io.File&nbsp;file)</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The heart of the matter.</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;void</CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#setCasesensitive(boolean)">setCasesensitive</A></B>(boolean&nbsp;casesensitive)</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether to ignore case when checking filenames.</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;pattern)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the file, or the pattern for the name, that
227 should be used for selection.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#setNegate(boolean)">setNegate</A></B>(boolean&nbsp;negated)</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;You can optionally reverse the selection of this selector,
236 thereby emulating an &lt;exclude&gt; tag, by setting the attribute
237 negate to true.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>&nbsp;void</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/Parameter.html" title="class in org.apache.tools.ant.types">Parameter</A>[]&nbsp;parameters)</CODE>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When using this as a custom selector, this method will be called.</TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#toString()">toString</A></B>()</CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;void</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FilenameSelector.html#verifySettings()">verifySettings</A></B>()</CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to make sure all settings are kosher.</TD>
262</TR>
263</TABLE>
264&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.selectors.BaseExtendSelector"><!-- --></A>
265<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
266<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
267<TD><B>Methods inherited from class org.apache.tools.ant.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></B></TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#getParameters()">getParameters</A></CODE></TD>
271</TR>
272</TABLE>
273&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.selectors.BaseSelector"><!-- --></A>
274<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
275<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
276<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>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<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>
280</TR>
281</TABLE>
282&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
283<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
284<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
285<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>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<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>
289</TR>
290</TABLE>
291&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
292<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
293<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
294<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>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<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>
298</TR>
299</TABLE>
300&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
301<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
302<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
303<TD><B>Methods inherited from class java.lang.Object</B></TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
307</TR>
308</TABLE>
309&nbsp;
310<P>
311
312<!-- ============ FIELD DETAIL =========== -->
313
314<A NAME="field_detail"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
317<TD COLSPAN=1><FONT SIZE="+2">
318<B>Field Detail</B></FONT></TD>
319</TR>
320</TABLE>
321
322<A NAME="NAME_KEY"><!-- --></A><H3>
323NAME_KEY</H3>
324<PRE>
325public static final java.lang.String <B>NAME_KEY</B></PRE>
326<DL>
327<DD>Used for parameterized custom selector
328<P>
329<DL>
330<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.FilenameSelector.NAME_KEY">Constant Field Values</A></DL>
331</DL>
332<HR>
333
334<A NAME="CASE_KEY"><!-- --></A><H3>
335CASE_KEY</H3>
336<PRE>
337public static final java.lang.String <B>CASE_KEY</B></PRE>
338<DL>
339<DD>Used for parameterized custom selector
340<P>
341<DL>
342<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.FilenameSelector.CASE_KEY">Constant Field Values</A></DL>
343</DL>
344<HR>
345
346<A NAME="NEGATE_KEY"><!-- --></A><H3>
347NEGATE_KEY</H3>
348<PRE>
349public static final java.lang.String <B>NEGATE_KEY</B></PRE>
350<DL>
351<DD>Used for parameterized custom selector
352<P>
353<DL>
354<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.FilenameSelector.NEGATE_KEY">Constant Field Values</A></DL>
355</DL>
356
357<!-- ========= CONSTRUCTOR DETAIL ======== -->
358
359<A NAME="constructor_detail"><!-- --></A>
360<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
361<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
362<TD COLSPAN=1><FONT SIZE="+2">
363<B>Constructor Detail</B></FONT></TD>
364</TR>
365</TABLE>
366
367<A NAME="FilenameSelector()"><!-- --></A><H3>
368FilenameSelector</H3>
369<PRE>
370public <B>FilenameSelector</B>()</PRE>
371<DL>
372<DD>Creates a new <code>FilenameSelector</code> instance.
373<P>
374</DL>
375
376<!-- ============ METHOD DETAIL ========== -->
377
378<A NAME="method_detail"><!-- --></A>
379<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
380<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
381<TD COLSPAN=1><FONT SIZE="+2">
382<B>Method Detail</B></FONT></TD>
383</TR>
384</TABLE>
385
386<A NAME="toString()"><!-- --></A><H3>
387toString</H3>
388<PRE>
389public java.lang.String <B>toString</B>()</PRE>
390<DL>
391<DD><DL>
392
393<DT><B>Returns:</B><DD>a string describing this object</DL>
394</DD>
395</DL>
396<HR>
397
398<A NAME="setName(java.lang.String)"><!-- --></A><H3>
399setName</H3>
400<PRE>
401public void <B>setName</B>(java.lang.String&nbsp;pattern)</PRE>
402<DL>
403<DD>The name of the file, or the pattern for the name, that
404 should be used for selection.
405<P>
406<DD><DL>
407<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the file pattern that any filename must match
408 against in order to be selected.</DL>
409</DD>
410</DL>
411<HR>
412
413<A NAME="setCasesensitive(boolean)"><!-- --></A><H3>
414setCasesensitive</H3>
415<PRE>
416public void <B>setCasesensitive</B>(boolean&nbsp;casesensitive)</PRE>
417<DL>
418<DD>Whether to ignore case when checking filenames.
419<P>
420<DD><DL>
421<DT><B>Parameters:</B><DD><CODE>casesensitive</CODE> - whether to pay attention to case sensitivity</DL>
422</DD>
423</DL>
424<HR>
425
426<A NAME="setNegate(boolean)"><!-- --></A><H3>
427setNegate</H3>
428<PRE>
429public void <B>setNegate</B>(boolean&nbsp;negated)</PRE>
430<DL>
431<DD>You can optionally reverse the selection of this selector,
432 thereby emulating an &lt;exclude&gt; tag, by setting the attribute
433 negate to true. This is identical to surrounding the selector
434 with &lt;not&gt;&lt;/not&gt;.
435<P>
436<DD><DL>
437<DT><B>Parameters:</B><DD><CODE>negated</CODE> - whether to negate this selection</DL>
438</DD>
439</DL>
440<HR>
441
442<A NAME="setParameters(org.apache.tools.ant.types.Parameter[])"><!-- --></A><H3>
443setParameters</H3>
444<PRE>
445public void <B>setParameters</B>(<A HREF="../../../../../../org/apache/tools/ant/types/Parameter.html" title="class in org.apache.tools.ant.types">Parameter</A>[]&nbsp;parameters)</PRE>
446<DL>
447<DD>When using this as a custom selector, this method will be called.
448 It translates each parameter into the appropriate setXXX() call.
449<P>
450<DD><DL>
451<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html" title="interface in org.apache.tools.ant.types">Parameterizable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></CODE></DL>
452</DD>
453<DD><DL>
454<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - the complete set of parameters for this selector</DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="verifySettings()"><!-- --></A><H3>
460verifySettings</H3>
461<PRE>
462public void <B>verifySettings</B>()</PRE>
463<DL>
464<DD>Checks to make sure all settings are kosher. In this case, it
465 means that the name attribute has been set.
466<P>
467<DD><DL>
468<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>
469</DD>
470<DD><DL>
471</DL>
472</DD>
473</DL>
474<HR>
475
476<A NAME="isSelected(java.io.File, java.lang.String, java.io.File)"><!-- --></A><H3>
477isSelected</H3>
478<PRE>
479public boolean <B>isSelected</B>(java.io.File&nbsp;basedir,
480 java.lang.String&nbsp;filename,
481 java.io.File&nbsp;file)</PRE>
482<DL>
483<DD>The heart of the matter. This is where the selector gets to decide
484 on the inclusion of a file in a particular fileset. Most of the work
485 for this selector is offloaded into SelectorUtils, a static class
486 that provides the same services for both FilenameSelector and
487 DirectoryScanner.
488<P>
489<DD><DL>
490<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/BaseExtendSelector.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/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></CODE></DL>
491</DD>
492<DD><DL>
493<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
494<DT><B>Returns:</B><DD>whether the file should be selected or not</DL>
495</DD>
496</DL>
497<!-- ========= END OF CLASS DATA ========= -->
498<HR>
499
500
501<!-- ======= START OF BOTTOM NAVBAR ====== -->
502<A NAME="navbar_bottom"><!-- --></A>
503<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
504<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
505<TR>
506<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
507<A NAME="navbar_bottom_firstrow"><!-- --></A>
508<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
509 <TR ALIGN="center" VALIGN="top">
510 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
511 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
512 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
513 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
514 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
515 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
516 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
517 </TR>
518</TABLE>
519</TD>
520<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
521</EM>
522</TD>
523</TR>
524
525<TR>
526<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
527&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/ExtendSelector.html" title="class in org.apache.tools.ant.types.selectors"><B>PREV CLASS</B></A>&nbsp;
528&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/MajoritySelector.html" title="class in org.apache.tools.ant.types.selectors"><B>NEXT CLASS</B></A></FONT></TD>
529<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
530 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
531&nbsp;<A HREF="FilenameSelector.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
532&nbsp;<SCRIPT type="text/javascript">
533 <!--
534 if(window==top) {
535 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
536 }
537 //-->
538</SCRIPT>
539<NOSCRIPT>
540 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
541</NOSCRIPT>
542
543</FONT></TD>
544</TR>
545<TR>
546<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
547 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
548<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
549DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
550</TR>
551</TABLE>
552<A NAME="skip-navbar_bottom"></A>
553<!-- ======== END OF BOTTOM NAVBAR ======= -->
554
555<HR>
556Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
557</BODY>
558</HTML>
Note: See TracBrowser for help on using the repository browser.