source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.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: 15.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:28 NZST 2007 -->
6<TITLE>
7FTP.FTPDirectoryScanner.AntFTPRootFile (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile 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="FTP.FTPDirectoryScanner.AntFTPRootFile (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/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/MimeMail.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><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="FTP.FTPDirectoryScanner.AntFTPRootFile.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.net</FONT>
85<BR>
86Class FTP.FTPDirectoryScanner.AntFTPRootFile</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile</B>
91</PRE>
92<DL>
93<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner</A></DD>
94</DL>
95<HR>
96<DL>
97<DT>protected class <B>FTP.FTPDirectoryScanner.AntFTPRootFile</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner.AntFTPFile</A></DL>
98
99<P>
100special class to represent the remote directory itself
101<P>
102
103<P>
104<DL>
105<DT><B>Since:</B></DT>
106 <DD>Ant 1.6</DD>
107</DL>
108<HR>
109
110<P>
111<!-- ======== NESTED CLASS SUMMARY ======== -->
112
113
114<!-- =========== FIELD SUMMARY =========== -->
115
116
117<!-- ======== CONSTRUCTOR SUMMARY ======== -->
118
119<A NAME="constructor_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>Constructor Summary</B></FONT></TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html#FTP.FTPDirectoryScanner.AntFTPRootFile(FTPClient, java.lang.String)">FTP.FTPDirectoryScanner.AntFTPRootFile</A></B>(FTPClient&nbsp;aclient,
127 java.lang.String&nbsp;remotedir)</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;constructor</TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- ========== METHOD SUMMARY =========== -->
135
136<A NAME="method_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TD COLSPAN=2><FONT SIZE="+2">
140<B>Method Summary</B></FONT></TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html#getAbsolutePath()">getAbsolutePath</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;find the absolute path</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html#getRelativePath()">getRelativePath</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;find out the relative path to root</TD>
157</TR>
158</TABLE>
159&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
162<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner.AntFTPFile</A></B></TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#exists()">exists</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getClient()">getClient</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getCurpwd()">getCurpwd</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getFastRelativePath()">getFastRelativePath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getFile(FTPFile[], java.lang.String)">getFile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getLink()">getLink</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getName()">getName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isDirectory()">isDirectory</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isSymbolicLink()">isSymbolicLink</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isTraverseSymlinks()">isTraverseSymlinks</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#setCurpwd(java.lang.String)">setCurpwd</A></CODE></TD>
166</TR>
167</TABLE>
168&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<TD><B>Methods inherited from class java.lang.Object</B></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
175</TR>
176</TABLE>
177&nbsp;
178<P>
179
180<!-- ============ FIELD DETAIL =========== -->
181
182
183<!-- ========= CONSTRUCTOR DETAIL ======== -->
184
185<A NAME="constructor_detail"><!-- --></A>
186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188<TD COLSPAN=1><FONT SIZE="+2">
189<B>Constructor Detail</B></FONT></TD>
190</TR>
191</TABLE>
192
193<A NAME="FTP.FTPDirectoryScanner.AntFTPRootFile(FTPClient, java.lang.String)"><!-- --></A><H3>
194FTP.FTPDirectoryScanner.AntFTPRootFile</H3>
195<PRE>
196public <B>FTP.FTPDirectoryScanner.AntFTPRootFile</B>(FTPClient&nbsp;aclient,
197 java.lang.String&nbsp;remotedir)</PRE>
198<DL>
199<DD>constructor
200<P>
201<DT><B>Parameters:</B><DD><CODE>aclient</CODE> - FTP client<DD><CODE>remotedir</CODE> - remote directory</DL>
202
203<!-- ============ METHOD DETAIL ========== -->
204
205<A NAME="method_detail"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
208<TD COLSPAN=1><FONT SIZE="+2">
209<B>Method Detail</B></FONT></TD>
210</TR>
211</TABLE>
212
213<A NAME="getAbsolutePath()"><!-- --></A><H3>
214getAbsolutePath</H3>
215<PRE>
216public java.lang.String <B>getAbsolutePath</B>()</PRE>
217<DL>
218<DD>find the absolute path
219<P>
220<DD><DL>
221<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getAbsolutePath()">getAbsolutePath</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner.AntFTPFile</A></CODE></DL>
222</DD>
223<DD><DL>
224
225<DT><B>Returns:</B><DD>absolute path</DL>
226</DD>
227</DL>
228<HR>
229
230<A NAME="getRelativePath()"><!-- --></A><H3>
231getRelativePath</H3>
232<PRE>
233public java.lang.String <B>getRelativePath</B>()
234 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A>,
235 java.io.IOException</PRE>
236<DL>
237<DD>find out the relative path to root
238<P>
239<DD><DL>
240<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getRelativePath()">getRelativePath</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner.AntFTPFile</A></CODE></DL>
241</DD>
242<DD><DL>
243
244<DT><B>Returns:</B><DD>empty string
245<DT><B>Throws:</B>
246<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - actually never
247<DD><CODE>java.io.IOException</CODE> - actually never</DL>
248</DD>
249</DL>
250<!-- ========= END OF CLASS DATA ========= -->
251<HR>
252
253
254<!-- ======= START OF BOTTOM NAVBAR ====== -->
255<A NAME="navbar_bottom"><!-- --></A>
256<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
257<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
258<TR>
259<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
260<A NAME="navbar_bottom_firstrow"><!-- --></A>
261<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
262 <TR ALIGN="center" VALIGN="top">
263 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
264 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
265 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
266 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
267 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
268 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
269 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
270 </TR>
271</TABLE>
272</TD>
273<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
274</EM>
275</TD>
276</TR>
277
278<TR>
279<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
280&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
281&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/MimeMail.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
282<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
283 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
284&nbsp;<A HREF="FTP.FTPDirectoryScanner.AntFTPRootFile.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
285&nbsp;<SCRIPT type="text/javascript">
286 <!--
287 if(window==top) {
288 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
289 }
290 //-->
291</SCRIPT>
292<NOSCRIPT>
293 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
294</NOSCRIPT>
295
296</FONT></TD>
297</TR>
298<TR>
299<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
300 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
301<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
302DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
303</TR>
304</TABLE>
305<A NAME="skip-navbar_bottom"></A>
306<!-- ======== END OF BOTTOM NAVBAR ======= -->
307
308<HR>
309Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
310</BODY>
311</HTML>
Note: See TracBrowser for help on using the repository browser.