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:14 NZST 2007 -->
|
---|
6 | <TITLE>
|
---|
7 | FileScanner (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.FileScanner interface">
|
---|
11 |
|
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
---|
13 |
|
---|
14 | <SCRIPT type="text/javascript">
|
---|
15 | function windowTitle()
|
---|
16 | {
|
---|
17 | parent.document.title="FileScanner (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> </TD>
|
---|
36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../org/apache/tools/ant/Executor.html" title="interface in org.apache.tools.ant"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../org/apache/tools/ant/SubBuildListener.html" title="interface in org.apache.tools.ant"><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>
|
---|
56 | <A HREF="FileScanner.html" target="_top"><B>NO FRAMES</B></A>
|
---|
57 | <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
74 | DETAIL: FIELD | CONSTR | <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">
|
---|
84 | org.apache.tools.ant</FONT>
|
---|
85 | <BR>
|
---|
86 | Interface FileScanner</H2>
|
---|
87 | <DL>
|
---|
88 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/tools/ant/DirectoryScanner.html" title="class in org.apache.tools.ant">DirectoryScanner</A></DD>
|
---|
89 | </DL>
|
---|
90 | <HR>
|
---|
91 | <DL>
|
---|
92 | <DT>public interface <B>FileScanner</B></DL>
|
---|
93 |
|
---|
94 | <P>
|
---|
95 | An interface used to describe the actions required of any type of
|
---|
96 | directory scanner.
|
---|
97 | <P>
|
---|
98 |
|
---|
99 | <P>
|
---|
100 | <HR>
|
---|
101 |
|
---|
102 | <P>
|
---|
103 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
104 |
|
---|
105 |
|
---|
106 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
107 |
|
---|
108 |
|
---|
109 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
110 |
|
---|
111 |
|
---|
112 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
113 |
|
---|
114 | <A NAME="method_summary"><!-- --></A>
|
---|
115 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
116 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
117 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
118 | <B>Method Summary</B></FONT></TD>
|
---|
119 | </TR>
|
---|
120 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
121 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
122 | <CODE> void</CODE></FONT></TD>
|
---|
123 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#addDefaultExcludes()">addDefaultExcludes</A></B>()</CODE>
|
---|
124 |
|
---|
125 | <BR>
|
---|
126 | Adds default exclusions to the current exclusions set.</TD>
|
---|
127 | </TR>
|
---|
128 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
129 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
130 | <CODE> java.io.File</CODE></FONT></TD>
|
---|
131 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getBasedir()">getBasedir</A></B>()</CODE>
|
---|
132 |
|
---|
133 | <BR>
|
---|
134 | Returns the base directory to be scanned.</TD>
|
---|
135 | </TR>
|
---|
136 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
137 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
138 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
139 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getExcludedDirectories()">getExcludedDirectories</A></B>()</CODE>
|
---|
140 |
|
---|
141 | <BR>
|
---|
142 | Returns the names of the directories which matched at least one of the
|
---|
143 | include patterns and at least one of the exclude patterns.</TD>
|
---|
144 | </TR>
|
---|
145 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
146 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
147 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
148 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getExcludedFiles()">getExcludedFiles</A></B>()</CODE>
|
---|
149 |
|
---|
150 | <BR>
|
---|
151 | Returns the names of the files which matched at least one of the
|
---|
152 | include patterns and at least one of the exclude patterns.</TD>
|
---|
153 | </TR>
|
---|
154 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
155 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
156 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
157 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getIncludedDirectories()">getIncludedDirectories</A></B>()</CODE>
|
---|
158 |
|
---|
159 | <BR>
|
---|
160 | Returns the names of the directories which matched at least one of the
|
---|
161 | include patterns and none of the exclude patterns.</TD>
|
---|
162 | </TR>
|
---|
163 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
164 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
165 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
166 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getIncludedFiles()">getIncludedFiles</A></B>()</CODE>
|
---|
167 |
|
---|
168 | <BR>
|
---|
169 | Returns the names of the files which matched at least one of the
|
---|
170 | include patterns and none of the exclude patterns.</TD>
|
---|
171 | </TR>
|
---|
172 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
173 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
174 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
175 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getNotIncludedDirectories()">getNotIncludedDirectories</A></B>()</CODE>
|
---|
176 |
|
---|
177 | <BR>
|
---|
178 | Returns the names of the directories which matched none of the include
|
---|
179 | patterns.</TD>
|
---|
180 | </TR>
|
---|
181 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
182 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
183 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
184 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#getNotIncludedFiles()">getNotIncludedFiles</A></B>()</CODE>
|
---|
185 |
|
---|
186 | <BR>
|
---|
187 | Returns the names of the files which matched none of the include
|
---|
188 | patterns.</TD>
|
---|
189 | </TR>
|
---|
190 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
191 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
192 | <CODE> void</CODE></FONT></TD>
|
---|
193 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#scan()">scan</A></B>()</CODE>
|
---|
194 |
|
---|
195 | <BR>
|
---|
196 | Scans the base directory for files which match at least one include
|
---|
197 | pattern and don't match any exclude patterns.</TD>
|
---|
198 | </TR>
|
---|
199 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
200 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
201 | <CODE> void</CODE></FONT></TD>
|
---|
202 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#setBasedir(java.io.File)">setBasedir</A></B>(java.io.File basedir)</CODE>
|
---|
203 |
|
---|
204 | <BR>
|
---|
205 | Sets the base directory to be scanned.</TD>
|
---|
206 | </TR>
|
---|
207 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
208 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
209 | <CODE> void</CODE></FONT></TD>
|
---|
210 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#setBasedir(java.lang.String)">setBasedir</A></B>(java.lang.String basedir)</CODE>
|
---|
211 |
|
---|
212 | <BR>
|
---|
213 | Sets the base directory to be scanned.</TD>
|
---|
214 | </TR>
|
---|
215 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
216 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
217 | <CODE> void</CODE></FONT></TD>
|
---|
218 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#setCaseSensitive(boolean)">setCaseSensitive</A></B>(boolean isCaseSensitive)</CODE>
|
---|
219 |
|
---|
220 | <BR>
|
---|
221 | Sets whether or not the file system should be regarded as case sensitive.</TD>
|
---|
222 | </TR>
|
---|
223 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
225 | <CODE> void</CODE></FONT></TD>
|
---|
226 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#setExcludes(java.lang.String[])">setExcludes</A></B>(java.lang.String[] excludes)</CODE>
|
---|
227 |
|
---|
228 | <BR>
|
---|
229 | Sets the list of exclude patterns to use.</TD>
|
---|
230 | </TR>
|
---|
231 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
232 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
233 | <CODE> void</CODE></FONT></TD>
|
---|
234 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/FileScanner.html#setIncludes(java.lang.String[])">setIncludes</A></B>(java.lang.String[] includes)</CODE>
|
---|
235 |
|
---|
236 | <BR>
|
---|
237 | Sets the list of include patterns to use.</TD>
|
---|
238 | </TR>
|
---|
239 | </TABLE>
|
---|
240 |
|
---|
241 | <P>
|
---|
242 |
|
---|
243 | <!-- ============ FIELD DETAIL =========== -->
|
---|
244 |
|
---|
245 |
|
---|
246 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
247 |
|
---|
248 |
|
---|
249 | <!-- ============ METHOD DETAIL ========== -->
|
---|
250 |
|
---|
251 | <A NAME="method_detail"><!-- --></A>
|
---|
252 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
253 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
254 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
255 | <B>Method Detail</B></FONT></TD>
|
---|
256 | </TR>
|
---|
257 | </TABLE>
|
---|
258 |
|
---|
259 | <A NAME="addDefaultExcludes()"><!-- --></A><H3>
|
---|
260 | addDefaultExcludes</H3>
|
---|
261 | <PRE>
|
---|
262 | public void <B>addDefaultExcludes</B>()</PRE>
|
---|
263 | <DL>
|
---|
264 | <DD>Adds default exclusions to the current exclusions set.
|
---|
265 | <P>
|
---|
266 | <DD><DL>
|
---|
267 | </DL>
|
---|
268 | </DD>
|
---|
269 | </DL>
|
---|
270 | <HR>
|
---|
271 |
|
---|
272 | <A NAME="getBasedir()"><!-- --></A><H3>
|
---|
273 | getBasedir</H3>
|
---|
274 | <PRE>
|
---|
275 | public java.io.File <B>getBasedir</B>()</PRE>
|
---|
276 | <DL>
|
---|
277 | <DD>Returns the base directory to be scanned.
|
---|
278 | This is the directory which is scanned recursively.
|
---|
279 | <P>
|
---|
280 | <DD><DL>
|
---|
281 |
|
---|
282 | <DT><B>Returns:</B><DD>the base directory to be scanned</DL>
|
---|
283 | </DD>
|
---|
284 | </DL>
|
---|
285 | <HR>
|
---|
286 |
|
---|
287 | <A NAME="getExcludedDirectories()"><!-- --></A><H3>
|
---|
288 | getExcludedDirectories</H3>
|
---|
289 | <PRE>
|
---|
290 | public java.lang.String[] <B>getExcludedDirectories</B>()</PRE>
|
---|
291 | <DL>
|
---|
292 | <DD>Returns the names of the directories which matched at least one of the
|
---|
293 | include patterns and at least one of the exclude patterns.
|
---|
294 | The names are relative to the base directory.
|
---|
295 | <P>
|
---|
296 | <DD><DL>
|
---|
297 |
|
---|
298 | <DT><B>Returns:</B><DD>the names of the directories which matched at least one of the
|
---|
299 | include patterns and at least one of the exclude patterns.</DL>
|
---|
300 | </DD>
|
---|
301 | </DL>
|
---|
302 | <HR>
|
---|
303 |
|
---|
304 | <A NAME="getExcludedFiles()"><!-- --></A><H3>
|
---|
305 | getExcludedFiles</H3>
|
---|
306 | <PRE>
|
---|
307 | public java.lang.String[] <B>getExcludedFiles</B>()</PRE>
|
---|
308 | <DL>
|
---|
309 | <DD>Returns the names of the files which matched at least one of the
|
---|
310 | include patterns and at least one of the exclude patterns.
|
---|
311 | The names are relative to the base directory.
|
---|
312 | <P>
|
---|
313 | <DD><DL>
|
---|
314 |
|
---|
315 | <DT><B>Returns:</B><DD>the names of the files which matched at least one of the
|
---|
316 | include patterns and at least one of the exclude patterns.</DL>
|
---|
317 | </DD>
|
---|
318 | </DL>
|
---|
319 | <HR>
|
---|
320 |
|
---|
321 | <A NAME="getIncludedDirectories()"><!-- --></A><H3>
|
---|
322 | getIncludedDirectories</H3>
|
---|
323 | <PRE>
|
---|
324 | public java.lang.String[] <B>getIncludedDirectories</B>()</PRE>
|
---|
325 | <DL>
|
---|
326 | <DD>Returns the names of the directories which matched at least one of the
|
---|
327 | include patterns and none of the exclude patterns.
|
---|
328 | The names are relative to the base directory.
|
---|
329 | <P>
|
---|
330 | <DD><DL>
|
---|
331 |
|
---|
332 | <DT><B>Returns:</B><DD>the names of the directories which matched at least one of the
|
---|
333 | include patterns and none of the exclude patterns.</DL>
|
---|
334 | </DD>
|
---|
335 | </DL>
|
---|
336 | <HR>
|
---|
337 |
|
---|
338 | <A NAME="getIncludedFiles()"><!-- --></A><H3>
|
---|
339 | getIncludedFiles</H3>
|
---|
340 | <PRE>
|
---|
341 | public java.lang.String[] <B>getIncludedFiles</B>()</PRE>
|
---|
342 | <DL>
|
---|
343 | <DD>Returns the names of the files which matched at least one of the
|
---|
344 | include patterns and none of the exclude patterns.
|
---|
345 | The names are relative to the base directory.
|
---|
346 | <P>
|
---|
347 | <DD><DL>
|
---|
348 |
|
---|
349 | <DT><B>Returns:</B><DD>the names of the files which matched at least one of the
|
---|
350 | include patterns and none of the exclude patterns.</DL>
|
---|
351 | </DD>
|
---|
352 | </DL>
|
---|
353 | <HR>
|
---|
354 |
|
---|
355 | <A NAME="getNotIncludedDirectories()"><!-- --></A><H3>
|
---|
356 | getNotIncludedDirectories</H3>
|
---|
357 | <PRE>
|
---|
358 | public java.lang.String[] <B>getNotIncludedDirectories</B>()</PRE>
|
---|
359 | <DL>
|
---|
360 | <DD>Returns the names of the directories which matched none of the include
|
---|
361 | patterns. The names are relative to the base directory.
|
---|
362 | <P>
|
---|
363 | <DD><DL>
|
---|
364 |
|
---|
365 | <DT><B>Returns:</B><DD>the names of the directories which matched none of the include
|
---|
366 | patterns.</DL>
|
---|
367 | </DD>
|
---|
368 | </DL>
|
---|
369 | <HR>
|
---|
370 |
|
---|
371 | <A NAME="getNotIncludedFiles()"><!-- --></A><H3>
|
---|
372 | getNotIncludedFiles</H3>
|
---|
373 | <PRE>
|
---|
374 | public java.lang.String[] <B>getNotIncludedFiles</B>()</PRE>
|
---|
375 | <DL>
|
---|
376 | <DD>Returns the names of the files which matched none of the include
|
---|
377 | patterns. The names are relative to the base directory.
|
---|
378 | <P>
|
---|
379 | <DD><DL>
|
---|
380 |
|
---|
381 | <DT><B>Returns:</B><DD>the names of the files which matched none of the include
|
---|
382 | patterns.</DL>
|
---|
383 | </DD>
|
---|
384 | </DL>
|
---|
385 | <HR>
|
---|
386 |
|
---|
387 | <A NAME="scan()"><!-- --></A><H3>
|
---|
388 | scan</H3>
|
---|
389 | <PRE>
|
---|
390 | public void <B>scan</B>()
|
---|
391 | throws java.lang.IllegalStateException</PRE>
|
---|
392 | <DL>
|
---|
393 | <DD>Scans the base directory for files which match at least one include
|
---|
394 | pattern and don't match any exclude patterns.
|
---|
395 | <P>
|
---|
396 | <DD><DL>
|
---|
397 |
|
---|
398 | <DT><B>Throws:</B>
|
---|
399 | <DD><CODE>java.lang.IllegalStateException</CODE> - if the base directory was set
|
---|
400 | incorrectly (i.e. if it is <code>null</code>, doesn't exist,
|
---|
401 | or isn't a directory).</DL>
|
---|
402 | </DD>
|
---|
403 | </DL>
|
---|
404 | <HR>
|
---|
405 |
|
---|
406 | <A NAME="setBasedir(java.lang.String)"><!-- --></A><H3>
|
---|
407 | setBasedir</H3>
|
---|
408 | <PRE>
|
---|
409 | public void <B>setBasedir</B>(java.lang.String basedir)</PRE>
|
---|
410 | <DL>
|
---|
411 | <DD>Sets the base directory to be scanned. This is the directory which is
|
---|
412 | scanned recursively. All '/' and '\' characters should be replaced by
|
---|
413 | <code>File.separatorChar</code>, so the separator used need not match
|
---|
414 | <code>File.separatorChar</code>.
|
---|
415 | <P>
|
---|
416 | <DD><DL>
|
---|
417 | <DT><B>Parameters:</B><DD><CODE>basedir</CODE> - The base directory to scan.
|
---|
418 | Must not be <code>null</code>.</DL>
|
---|
419 | </DD>
|
---|
420 | </DL>
|
---|
421 | <HR>
|
---|
422 |
|
---|
423 | <A NAME="setBasedir(java.io.File)"><!-- --></A><H3>
|
---|
424 | setBasedir</H3>
|
---|
425 | <PRE>
|
---|
426 | public void <B>setBasedir</B>(java.io.File basedir)</PRE>
|
---|
427 | <DL>
|
---|
428 | <DD>Sets the base directory to be scanned. This is the directory which is
|
---|
429 | scanned recursively.
|
---|
430 | <P>
|
---|
431 | <DD><DL>
|
---|
432 | <DT><B>Parameters:</B><DD><CODE>basedir</CODE> - The base directory for scanning.
|
---|
433 | Should not be <code>null</code>.</DL>
|
---|
434 | </DD>
|
---|
435 | </DL>
|
---|
436 | <HR>
|
---|
437 |
|
---|
438 | <A NAME="setExcludes(java.lang.String[])"><!-- --></A><H3>
|
---|
439 | setExcludes</H3>
|
---|
440 | <PRE>
|
---|
441 | public void <B>setExcludes</B>(java.lang.String[] excludes)</PRE>
|
---|
442 | <DL>
|
---|
443 | <DD>Sets the list of exclude patterns to use.
|
---|
444 | <P>
|
---|
445 | <DD><DL>
|
---|
446 | <DT><B>Parameters:</B><DD><CODE>excludes</CODE> - A list of exclude patterns.
|
---|
447 | May be <code>null</code>, indicating that no files
|
---|
448 | should be excluded. If a non-<code>null</code> list is
|
---|
449 | given, all elements must be non-<code>null</code>.</DL>
|
---|
450 | </DD>
|
---|
451 | </DL>
|
---|
452 | <HR>
|
---|
453 |
|
---|
454 | <A NAME="setIncludes(java.lang.String[])"><!-- --></A><H3>
|
---|
455 | setIncludes</H3>
|
---|
456 | <PRE>
|
---|
457 | public void <B>setIncludes</B>(java.lang.String[] includes)</PRE>
|
---|
458 | <DL>
|
---|
459 | <DD>Sets the list of include patterns to use.
|
---|
460 | <P>
|
---|
461 | <DD><DL>
|
---|
462 | <DT><B>Parameters:</B><DD><CODE>includes</CODE> - A list of include patterns.
|
---|
463 | May be <code>null</code>, indicating that all files
|
---|
464 | should be included. If a non-<code>null</code>
|
---|
465 | list is given, all elements must be
|
---|
466 | non-<code>null</code>.</DL>
|
---|
467 | </DD>
|
---|
468 | </DL>
|
---|
469 | <HR>
|
---|
470 |
|
---|
471 | <A NAME="setCaseSensitive(boolean)"><!-- --></A><H3>
|
---|
472 | setCaseSensitive</H3>
|
---|
473 | <PRE>
|
---|
474 | public void <B>setCaseSensitive</B>(boolean isCaseSensitive)</PRE>
|
---|
475 | <DL>
|
---|
476 | <DD>Sets whether or not the file system should be regarded as case sensitive.
|
---|
477 | <P>
|
---|
478 | <DD><DL>
|
---|
479 | <DT><B>Parameters:</B><DD><CODE>isCaseSensitive</CODE> - whether or not the file system should be
|
---|
480 | regarded as a case sensitive one</DL>
|
---|
481 | </DD>
|
---|
482 | </DL>
|
---|
483 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
484 | <HR>
|
---|
485 |
|
---|
486 |
|
---|
487 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
488 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
489 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
490 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
491 | <TR>
|
---|
492 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
493 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
494 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
495 | <TR ALIGN="center" VALIGN="top">
|
---|
496 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
497 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
498 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
499 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
500 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
501 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
502 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
503 | </TR>
|
---|
504 | </TABLE>
|
---|
505 | </TD>
|
---|
506 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
507 | </EM>
|
---|
508 | </TD>
|
---|
509 | </TR>
|
---|
510 |
|
---|
511 | <TR>
|
---|
512 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
513 | <A HREF="../../../../org/apache/tools/ant/Executor.html" title="interface in org.apache.tools.ant"><B>PREV CLASS</B></A>
|
---|
514 | <A HREF="../../../../org/apache/tools/ant/SubBuildListener.html" title="interface in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
515 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
516 | <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
517 | <A HREF="FileScanner.html" target="_top"><B>NO FRAMES</B></A>
|
---|
518 | <SCRIPT type="text/javascript">
|
---|
519 | <!--
|
---|
520 | if(window==top) {
|
---|
521 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
522 | }
|
---|
523 | //-->
|
---|
524 | </SCRIPT>
|
---|
525 | <NOSCRIPT>
|
---|
526 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
527 | </NOSCRIPT>
|
---|
528 |
|
---|
529 | </FONT></TD>
|
---|
530 | </TR>
|
---|
531 | <TR>
|
---|
532 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
533 | SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
534 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
535 | DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
536 | </TR>
|
---|
537 | </TABLE>
|
---|
538 | <A NAME="skip-navbar_bottom"></A>
|
---|
539 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
540 |
|
---|
541 | <HR>
|
---|
542 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
543 | </BODY>
|
---|
544 | </HTML>
|
---|