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

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

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