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

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

initial import of the gs3-release-maker
File size: 12.7 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:25 NZST 2007 -->
6<TITLE>
7DirectoryIterator (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.depend.DirectoryIterator 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="DirectoryIterator (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/Depend.html" title="class in org.apache.tools.ant.taskdefs.optional.depend"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/JarFileIterator.html" title="class in org.apache.tools.ant.taskdefs.optional.depend"><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="DirectoryIterator.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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.depend</FONT>
85<BR>
86Class DirectoryIterator</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.depend.DirectoryIterator</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html" title="interface in org.apache.tools.ant.taskdefs.optional.depend">ClassFileIterator</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>DirectoryIterator</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html" title="interface in org.apache.tools.ant.taskdefs.optional.depend">ClassFileIterator</A></DL>
97
98<P>
99An iterator which iterates through the contents of a java directory. The
100 iterator should be created with the directory at the root of the Java
101 namespace.
102<P>
103
104<P>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110
111<!-- =========== FIELD SUMMARY =========== -->
112
113
114<!-- ======== CONSTRUCTOR SUMMARY ======== -->
115
116<A NAME="constructor_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TD COLSPAN=2><FONT SIZE="+2">
120<B>Constructor Summary</B></FONT></TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.html#DirectoryIterator(java.io.File, boolean)">DirectoryIterator</A></B>(java.io.File&nbsp;rootDirectory,
124 boolean&nbsp;changeInto)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a directory iterator.</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ========== METHOD SUMMARY =========== -->
132
133<A NAME="method_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TD COLSPAN=2><FONT SIZE="+2">
137<B>Method Summary</B></FONT></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFile.html" title="class in org.apache.tools.ant.taskdefs.optional.depend">ClassFile</A></CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.html#getNextClassFile()">getNextClassFile</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Template method to allow subclasses to supply elements for the
146 iteration.</TD>
147</TR>
148</TABLE>
149&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
152<TD><B>Methods inherited from class java.lang.Object</B></TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
156</TR>
157</TABLE>
158&nbsp;
159<P>
160
161<!-- ============ FIELD DETAIL =========== -->
162
163
164<!-- ========= CONSTRUCTOR DETAIL ======== -->
165
166<A NAME="constructor_detail"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TD COLSPAN=1><FONT SIZE="+2">
170<B>Constructor Detail</B></FONT></TD>
171</TR>
172</TABLE>
173
174<A NAME="DirectoryIterator(java.io.File, boolean)"><!-- --></A><H3>
175DirectoryIterator</H3>
176<PRE>
177public <B>DirectoryIterator</B>(java.io.File&nbsp;rootDirectory,
178 boolean&nbsp;changeInto)
179 throws java.io.IOException</PRE>
180<DL>
181<DD>Creates a directory iterator. The directory iterator is created to
182 scan the root directory. If the changeInto flag is given, then the
183 entries returned will be relative to this directory and not the
184 current directory.
185<P>
186<DT><B>Parameters:</B><DD><CODE>rootDirectory</CODE> - the root if the directory namespace which is to
187 be iterated over<DD><CODE>changeInto</CODE> - if true then the returned entries will be relative
188 to the rootDirectory and not the current directory.
189<DT><B>Throws:</B>
190<DD><CODE>java.io.IOException</CODE> - if there is a problem reading the directory
191 information.</DL>
192
193<!-- ============ METHOD DETAIL ========== -->
194
195<A NAME="method_detail"><!-- --></A>
196<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
197<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
198<TD COLSPAN=1><FONT SIZE="+2">
199<B>Method Detail</B></FONT></TD>
200</TR>
201</TABLE>
202
203<A NAME="getNextClassFile()"><!-- --></A><H3>
204getNextClassFile</H3>
205<PRE>
206public <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFile.html" title="class in org.apache.tools.ant.taskdefs.optional.depend">ClassFile</A> <B>getNextClassFile</B>()</PRE>
207<DL>
208<DD>Template method to allow subclasses to supply elements for the
209 iteration. The directory iterator maintains a stack of iterators
210 covering each level in the directory hierarchy. The current iterator
211 covers the current directory being scanned. If the next entry in that
212 directory is a subdirectory, the current iterator is pushed onto the
213 stack and a new iterator is created for the subdirectory. If the
214 entry is a file, it is returned as the next element and the iterator
215 remains valid. If there are no more entries in the current directory,
216 the topmost iterator on the stack is popped off to become the
217 current iterator.
218<P>
219<DD><DL>
220<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html#getNextClassFile()">getNextClassFile</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html" title="interface in org.apache.tools.ant.taskdefs.optional.depend">ClassFileIterator</A></CODE></DL>
221</DD>
222<DD><DL>
223
224<DT><B>Returns:</B><DD>the next ClassFile in the iteration.</DL>
225</DD>
226</DL>
227<!-- ========= END OF CLASS DATA ========= -->
228<HR>
229
230
231<!-- ======= START OF BOTTOM NAVBAR ====== -->
232<A NAME="navbar_bottom"><!-- --></A>
233<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
234<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
235<TR>
236<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
237<A NAME="navbar_bottom_firstrow"><!-- --></A>
238<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
239 <TR ALIGN="center" VALIGN="top">
240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
241 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
242 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
243 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
244 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
245 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
247 </TR>
248</TABLE>
249</TD>
250<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
251</EM>
252</TD>
253</TR>
254
255<TR>
256<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
257&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/Depend.html" title="class in org.apache.tools.ant.taskdefs.optional.depend"><B>PREV CLASS</B></A>&nbsp;
258&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/depend/JarFileIterator.html" title="class in org.apache.tools.ant.taskdefs.optional.depend"><B>NEXT CLASS</B></A></FONT></TD>
259<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
260 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
261&nbsp;<A HREF="DirectoryIterator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
262&nbsp;<SCRIPT type="text/javascript">
263 <!--
264 if(window==top) {
265 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
266 }
267 //-->
268</SCRIPT>
269<NOSCRIPT>
270 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
271</NOSCRIPT>
272
273</FONT></TD>
274</TR>
275<TR>
276<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
277 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
278<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
279DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
280</TR>
281</TABLE>
282<A NAME="skip-navbar_bottom"></A>
283<!-- ======== END OF BOTTOM NAVBAR ======= -->
284
285<HR>
286Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
287</BODY>
288</HTML>
Note: See TracBrowser for help on using the repository browser.