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>
|
---|
7 | FTP.FTPDirectoryScanner.AntFTPFile (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile class">
|
---|
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="FTP.FTPDirectoryScanner.AntFTPFile (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/taskdefs/optional/net/FTP.FTPDirectoryScanner.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.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>
|
---|
56 | <A HREF="FTP.FTPDirectoryScanner.AntFTPFile.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
74 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.taskdefs.optional.net</FONT>
|
---|
85 | <BR>
|
---|
86 | Class FTP.FTPDirectoryScanner.AntFTPFile</H2>
|
---|
87 | <PRE>
|
---|
88 | java.lang.Object
|
---|
89 | <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile</B>
|
---|
90 | </PRE>
|
---|
91 | <DL>
|
---|
92 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner.AntFTPRootFile</A></DD>
|
---|
93 | </DL>
|
---|
94 | <DL>
|
---|
95 | <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>
|
---|
96 | </DL>
|
---|
97 | <HR>
|
---|
98 | <DL>
|
---|
99 | <DT>protected class <B>FTP.FTPDirectoryScanner.AntFTPFile</B><DT>extends java.lang.Object</DL>
|
---|
100 |
|
---|
101 | <P>
|
---|
102 | an AntFTPFile is a representation of a remote file
|
---|
103 | <P>
|
---|
104 |
|
---|
105 | <P>
|
---|
106 | <DL>
|
---|
107 | <DT><B>Since:</B></DT>
|
---|
108 | <DD>Ant 1.6</DD>
|
---|
109 | </DL>
|
---|
110 | <HR>
|
---|
111 |
|
---|
112 | <P>
|
---|
113 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
114 |
|
---|
115 |
|
---|
116 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
117 |
|
---|
118 |
|
---|
119 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
120 |
|
---|
121 | <A NAME="constructor_summary"><!-- --></A>
|
---|
122 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
123 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
124 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
125 | <B>Constructor Summary</B></FONT></TD>
|
---|
126 | </TR>
|
---|
127 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
128 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#FTP.FTPDirectoryScanner.AntFTPFile(org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile, java.lang.String)">FTP.FTPDirectoryScanner.AntFTPFile</A></B>(<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> parent,
|
---|
129 | java.lang.String path)</CODE>
|
---|
130 |
|
---|
131 | <BR>
|
---|
132 | other constructor</TD>
|
---|
133 | </TR>
|
---|
134 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
135 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#FTP.FTPDirectoryScanner.AntFTPFile(FTPClient, FTPFile, java.lang.String)">FTP.FTPDirectoryScanner.AntFTPFile</A></B>(FTPClient client,
|
---|
136 | FTPFile ftpFile,
|
---|
137 | java.lang.String curpwd)</CODE>
|
---|
138 |
|
---|
139 | <BR>
|
---|
140 | constructor</TD>
|
---|
141 | </TR>
|
---|
142 | </TABLE>
|
---|
143 |
|
---|
144 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
145 |
|
---|
146 | <A NAME="method_summary"><!-- --></A>
|
---|
147 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
148 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
149 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
150 | <B>Method Summary</B></FONT></TD>
|
---|
151 | </TR>
|
---|
152 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
153 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
154 | <CODE> boolean</CODE></FONT></TD>
|
---|
155 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#exists()">exists</A></B>()</CODE>
|
---|
156 |
|
---|
157 | <BR>
|
---|
158 | find out if the file exists</TD>
|
---|
159 | </TR>
|
---|
160 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
161 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
162 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
163 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getAbsolutePath()">getAbsolutePath</A></B>()</CODE>
|
---|
164 |
|
---|
165 | <BR>
|
---|
166 | find out the absolute path of the file</TD>
|
---|
167 | </TR>
|
---|
168 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
169 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
170 | <CODE>protected FTPClient</CODE></FONT></TD>
|
---|
171 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getClient()">getClient</A></B>()</CODE>
|
---|
172 |
|
---|
173 | <BR>
|
---|
174 | return the attached FTP client object.</TD>
|
---|
175 | </TR>
|
---|
176 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
177 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
178 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
179 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getCurpwd()">getCurpwd</A></B>()</CODE>
|
---|
180 |
|
---|
181 | <BR>
|
---|
182 | returns the path of the directory containing the AntFTPFile.</TD>
|
---|
183 | </TR>
|
---|
184 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
186 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
187 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getFastRelativePath()">getFastRelativePath</A></B>()</CODE>
|
---|
188 |
|
---|
189 | <BR>
|
---|
190 | find out the relative path assuming that the path used to construct
|
---|
191 | this AntFTPFile was spelled properly with regards to case.</TD>
|
---|
192 | </TR>
|
---|
193 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
195 | <CODE> FTPFile</CODE></FONT></TD>
|
---|
196 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getFile(FTPFile[], java.lang.String)">getFile</A></B>(FTPFile[] theFiles,
|
---|
197 | java.lang.String lastpathelement)</CODE>
|
---|
198 |
|
---|
199 | <BR>
|
---|
200 | find a file matching a string in an array of FTPFile.</TD>
|
---|
201 | </TR>
|
---|
202 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
203 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
204 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
205 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getLink()">getLink</A></B>()</CODE>
|
---|
206 |
|
---|
207 | <BR>
|
---|
208 | if the file is a symbolic link, find out to what it is pointing</TD>
|
---|
209 | </TR>
|
---|
210 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
212 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
213 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getName()">getName</A></B>()</CODE>
|
---|
214 |
|
---|
215 | <BR>
|
---|
216 | get the name of the file</TD>
|
---|
217 | </TR>
|
---|
218 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
219 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
220 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
221 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#getRelativePath()">getRelativePath</A></B>()</CODE>
|
---|
222 |
|
---|
223 | <BR>
|
---|
224 | find out the relative path to the rootPath of the enclosing scanner.</TD>
|
---|
225 | </TR>
|
---|
226 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
227 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
228 | <CODE> boolean</CODE></FONT></TD>
|
---|
229 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isDirectory()">isDirectory</A></B>()</CODE>
|
---|
230 |
|
---|
231 | <BR>
|
---|
232 | tell if a file is a directory.</TD>
|
---|
233 | </TR>
|
---|
234 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
235 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
236 | <CODE> boolean</CODE></FONT></TD>
|
---|
237 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isSymbolicLink()">isSymbolicLink</A></B>()</CODE>
|
---|
238 |
|
---|
239 | <BR>
|
---|
240 | tell if a file is a symbolic link</TD>
|
---|
241 | </TR>
|
---|
242 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
243 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
244 | <CODE> boolean</CODE></FONT></TD>
|
---|
245 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#isTraverseSymlinks()">isTraverseSymlinks</A></B>()</CODE>
|
---|
246 |
|
---|
247 | <BR>
|
---|
248 | find out if a symbolic link is encountered in the relative path of this file
|
---|
249 | from rootPath.</TD>
|
---|
250 | </TR>
|
---|
251 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
252 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
253 | <CODE>protected void</CODE></FONT></TD>
|
---|
254 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html#setCurpwd(java.lang.String)">setCurpwd</A></B>(java.lang.String curpwd)</CODE>
|
---|
255 |
|
---|
256 | <BR>
|
---|
257 | sets the current path of an AntFTPFile</TD>
|
---|
258 | </TR>
|
---|
259 | </TABLE>
|
---|
260 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
261 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
262 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
263 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
264 | </TR>
|
---|
265 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
266 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
267 | </TR>
|
---|
268 | </TABLE>
|
---|
269 |
|
---|
270 | <P>
|
---|
271 |
|
---|
272 | <!-- ============ FIELD DETAIL =========== -->
|
---|
273 |
|
---|
274 |
|
---|
275 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
276 |
|
---|
277 | <A NAME="constructor_detail"><!-- --></A>
|
---|
278 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
279 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
280 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
281 | <B>Constructor Detail</B></FONT></TD>
|
---|
282 | </TR>
|
---|
283 | </TABLE>
|
---|
284 |
|
---|
285 | <A NAME="FTP.FTPDirectoryScanner.AntFTPFile(FTPClient, FTPFile, java.lang.String)"><!-- --></A><H3>
|
---|
286 | FTP.FTPDirectoryScanner.AntFTPFile</H3>
|
---|
287 | <PRE>
|
---|
288 | public <B>FTP.FTPDirectoryScanner.AntFTPFile</B>(FTPClient client,
|
---|
289 | FTPFile ftpFile,
|
---|
290 | java.lang.String curpwd)</PRE>
|
---|
291 | <DL>
|
---|
292 | <DD>constructor
|
---|
293 | <P>
|
---|
294 | <DT><B>Parameters:</B><DD><CODE>client</CODE> - ftp client variable<DD><CODE>ftpFile</CODE> - the file<DD><CODE>curpwd</CODE> - absolute remote path where the file is found</DL>
|
---|
295 | <HR>
|
---|
296 |
|
---|
297 | <A NAME="FTP.FTPDirectoryScanner.AntFTPFile(org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile, java.lang.String)"><!-- --></A><H3>
|
---|
298 | FTP.FTPDirectoryScanner.AntFTPFile</H3>
|
---|
299 | <PRE>
|
---|
300 | public <B>FTP.FTPDirectoryScanner.AntFTPFile</B>(<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> parent,
|
---|
301 | java.lang.String path)</PRE>
|
---|
302 | <DL>
|
---|
303 | <DD>other constructor
|
---|
304 | <P>
|
---|
305 | <DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent file<DD><CODE>path</CODE> - a relative path to the parent file</DL>
|
---|
306 |
|
---|
307 | <!-- ============ METHOD DETAIL ========== -->
|
---|
308 |
|
---|
309 | <A NAME="method_detail"><!-- --></A>
|
---|
310 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
311 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
312 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
313 | <B>Method Detail</B></FONT></TD>
|
---|
314 | </TR>
|
---|
315 | </TABLE>
|
---|
316 |
|
---|
317 | <A NAME="exists()"><!-- --></A><H3>
|
---|
318 | exists</H3>
|
---|
319 | <PRE>
|
---|
320 | public boolean <B>exists</B>()</PRE>
|
---|
321 | <DL>
|
---|
322 | <DD>find out if the file exists
|
---|
323 | <P>
|
---|
324 | <DD><DL>
|
---|
325 |
|
---|
326 | <DT><B>Returns:</B><DD>true if the file exists</DL>
|
---|
327 | </DD>
|
---|
328 | </DL>
|
---|
329 | <HR>
|
---|
330 |
|
---|
331 | <A NAME="getLink()"><!-- --></A><H3>
|
---|
332 | getLink</H3>
|
---|
333 | <PRE>
|
---|
334 | public java.lang.String <B>getLink</B>()</PRE>
|
---|
335 | <DL>
|
---|
336 | <DD>if the file is a symbolic link, find out to what it is pointing
|
---|
337 | <P>
|
---|
338 | <DD><DL>
|
---|
339 |
|
---|
340 | <DT><B>Returns:</B><DD>the target of the symbolic link</DL>
|
---|
341 | </DD>
|
---|
342 | </DL>
|
---|
343 | <HR>
|
---|
344 |
|
---|
345 | <A NAME="getName()"><!-- --></A><H3>
|
---|
346 | getName</H3>
|
---|
347 | <PRE>
|
---|
348 | public java.lang.String <B>getName</B>()</PRE>
|
---|
349 | <DL>
|
---|
350 | <DD>get the name of the file
|
---|
351 | <P>
|
---|
352 | <DD><DL>
|
---|
353 |
|
---|
354 | <DT><B>Returns:</B><DD>the name of the file</DL>
|
---|
355 | </DD>
|
---|
356 | </DL>
|
---|
357 | <HR>
|
---|
358 |
|
---|
359 | <A NAME="getAbsolutePath()"><!-- --></A><H3>
|
---|
360 | getAbsolutePath</H3>
|
---|
361 | <PRE>
|
---|
362 | public java.lang.String <B>getAbsolutePath</B>()</PRE>
|
---|
363 | <DL>
|
---|
364 | <DD>find out the absolute path of the file
|
---|
365 | <P>
|
---|
366 | <DD><DL>
|
---|
367 |
|
---|
368 | <DT><B>Returns:</B><DD>absolute path as string</DL>
|
---|
369 | </DD>
|
---|
370 | </DL>
|
---|
371 | <HR>
|
---|
372 |
|
---|
373 | <A NAME="getFastRelativePath()"><!-- --></A><H3>
|
---|
374 | getFastRelativePath</H3>
|
---|
375 | <PRE>
|
---|
376 | public java.lang.String <B>getFastRelativePath</B>()</PRE>
|
---|
377 | <DL>
|
---|
378 | <DD>find out the relative path assuming that the path used to construct
|
---|
379 | this AntFTPFile was spelled properly with regards to case.
|
---|
380 | This is OK on a case sensitive system such as UNIX
|
---|
381 | <P>
|
---|
382 | <DD><DL>
|
---|
383 |
|
---|
384 | <DT><B>Returns:</B><DD>relative path</DL>
|
---|
385 | </DD>
|
---|
386 | </DL>
|
---|
387 | <HR>
|
---|
388 |
|
---|
389 | <A NAME="getRelativePath()"><!-- --></A><H3>
|
---|
390 | getRelativePath</H3>
|
---|
391 | <PRE>
|
---|
392 | public java.lang.String <B>getRelativePath</B>()
|
---|
393 | throws java.io.IOException,
|
---|
394 | <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
395 | <DL>
|
---|
396 | <DD>find out the relative path to the rootPath of the enclosing scanner.
|
---|
397 | this relative path is spelled exactly like on disk,
|
---|
398 | for instance if the AntFTPFile has been instantiated as ALPHA,
|
---|
399 | but the file is really called alpha, this method will return alpha.
|
---|
400 | If a symbolic link is encountered, it is followed, but the name of the link
|
---|
401 | rather than the name of the target is returned.
|
---|
402 | (ie does not behave like File.getCanonicalPath())
|
---|
403 | <P>
|
---|
404 | <DD><DL>
|
---|
405 |
|
---|
406 | <DT><B>Returns:</B><DD>relative path, separated by remoteFileSep
|
---|
407 | <DT><B>Throws:</B>
|
---|
408 | <DD><CODE>java.io.IOException</CODE> - if a change directory fails, ...
|
---|
409 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if one of the components of the relative path cannot
|
---|
410 | be found.</DL>
|
---|
411 | </DD>
|
---|
412 | </DL>
|
---|
413 | <HR>
|
---|
414 |
|
---|
415 | <A NAME="getFile(FTPFile[], java.lang.String)"><!-- --></A><H3>
|
---|
416 | getFile</H3>
|
---|
417 | <PRE>
|
---|
418 | public FTPFile <B>getFile</B>(FTPFile[] theFiles,
|
---|
419 | java.lang.String lastpathelement)</PRE>
|
---|
420 | <DL>
|
---|
421 | <DD>find a file matching a string in an array of FTPFile.
|
---|
422 | This method will find "alpha" when requested for "ALPHA"
|
---|
423 | if and only if the caseSensitive attribute is set to false.
|
---|
424 | When caseSensitive is set to true, only the exact match is returned.
|
---|
425 | <P>
|
---|
426 | <DD><DL>
|
---|
427 | <DT><B>Parameters:</B><DD><CODE>theFiles</CODE> - array of files<DD><CODE>lastpathelement</CODE> - the file name being sought
|
---|
428 | <DT><B>Returns:</B><DD>null if the file cannot be found, otherwise return the matching file.</DL>
|
---|
429 | </DD>
|
---|
430 | </DL>
|
---|
431 | <HR>
|
---|
432 |
|
---|
433 | <A NAME="isDirectory()"><!-- --></A><H3>
|
---|
434 | isDirectory</H3>
|
---|
435 | <PRE>
|
---|
436 | public boolean <B>isDirectory</B>()</PRE>
|
---|
437 | <DL>
|
---|
438 | <DD>tell if a file is a directory.
|
---|
439 | note that it will return false for symbolic links pointing to directories.
|
---|
440 | <P>
|
---|
441 | <DD><DL>
|
---|
442 |
|
---|
443 | <DT><B>Returns:</B><DD><code>true</code> for directories</DL>
|
---|
444 | </DD>
|
---|
445 | </DL>
|
---|
446 | <HR>
|
---|
447 |
|
---|
448 | <A NAME="isSymbolicLink()"><!-- --></A><H3>
|
---|
449 | isSymbolicLink</H3>
|
---|
450 | <PRE>
|
---|
451 | public boolean <B>isSymbolicLink</B>()</PRE>
|
---|
452 | <DL>
|
---|
453 | <DD>tell if a file is a symbolic link
|
---|
454 | <P>
|
---|
455 | <DD><DL>
|
---|
456 |
|
---|
457 | <DT><B>Returns:</B><DD><code>true</code> for symbolic links</DL>
|
---|
458 | </DD>
|
---|
459 | </DL>
|
---|
460 | <HR>
|
---|
461 |
|
---|
462 | <A NAME="getClient()"><!-- --></A><H3>
|
---|
463 | getClient</H3>
|
---|
464 | <PRE>
|
---|
465 | protected FTPClient <B>getClient</B>()</PRE>
|
---|
466 | <DL>
|
---|
467 | <DD>return the attached FTP client object.
|
---|
468 | Warning : this instance is really shared with the enclosing class.
|
---|
469 | <P>
|
---|
470 | <DD><DL>
|
---|
471 |
|
---|
472 | <DT><B>Returns:</B><DD>FTP client</DL>
|
---|
473 | </DD>
|
---|
474 | </DL>
|
---|
475 | <HR>
|
---|
476 |
|
---|
477 | <A NAME="setCurpwd(java.lang.String)"><!-- --></A><H3>
|
---|
478 | setCurpwd</H3>
|
---|
479 | <PRE>
|
---|
480 | protected void <B>setCurpwd</B>(java.lang.String curpwd)</PRE>
|
---|
481 | <DL>
|
---|
482 | <DD>sets the current path of an AntFTPFile
|
---|
483 | <P>
|
---|
484 | <DD><DL>
|
---|
485 | <DT><B>Parameters:</B><DD><CODE>curpwd</CODE> - the current path one wants to set</DL>
|
---|
486 | </DD>
|
---|
487 | </DL>
|
---|
488 | <HR>
|
---|
489 |
|
---|
490 | <A NAME="getCurpwd()"><!-- --></A><H3>
|
---|
491 | getCurpwd</H3>
|
---|
492 | <PRE>
|
---|
493 | public java.lang.String <B>getCurpwd</B>()</PRE>
|
---|
494 | <DL>
|
---|
495 | <DD>returns the path of the directory containing the AntFTPFile.
|
---|
496 | of the full path of the file itself in case of AntFTPRootFile
|
---|
497 | <P>
|
---|
498 | <DD><DL>
|
---|
499 |
|
---|
500 | <DT><B>Returns:</B><DD>parent directory of the AntFTPFile</DL>
|
---|
501 | </DD>
|
---|
502 | </DL>
|
---|
503 | <HR>
|
---|
504 |
|
---|
505 | <A NAME="isTraverseSymlinks()"><!-- --></A><H3>
|
---|
506 | isTraverseSymlinks</H3>
|
---|
507 | <PRE>
|
---|
508 | public boolean <B>isTraverseSymlinks</B>()
|
---|
509 | throws java.io.IOException,
|
---|
510 | <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
511 | <DL>
|
---|
512 | <DD>find out if a symbolic link is encountered in the relative path of this file
|
---|
513 | from rootPath.
|
---|
514 | <P>
|
---|
515 | <DD><DL>
|
---|
516 |
|
---|
517 | <DT><B>Returns:</B><DD><code>true</code> if a symbolic link is encountered in the relative path.
|
---|
518 | <DT><B>Throws:</B>
|
---|
519 | <DD><CODE>java.io.IOException</CODE> - if one of the change directory or directory listing operations
|
---|
520 | fails
|
---|
521 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if a path component in the relative path cannot be found.</DL>
|
---|
522 | </DD>
|
---|
523 | </DL>
|
---|
524 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
525 | <HR>
|
---|
526 |
|
---|
527 |
|
---|
528 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
529 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
530 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
531 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
532 | <TR>
|
---|
533 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
534 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
535 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
536 | <TR ALIGN="center" VALIGN="top">
|
---|
537 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
538 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
539 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
540 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
541 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
542 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
543 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
544 | </TR>
|
---|
545 | </TABLE>
|
---|
546 | </TD>
|
---|
547 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
548 | </EM>
|
---|
549 | </TD>
|
---|
550 | </TR>
|
---|
551 |
|
---|
552 | <TR>
|
---|
553 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
554 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>
|
---|
555 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
556 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
557 | <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
558 | <A HREF="FTP.FTPDirectoryScanner.AntFTPFile.html" target="_top"><B>NO FRAMES</B></A>
|
---|
559 | <SCRIPT type="text/javascript">
|
---|
560 | <!--
|
---|
561 | if(window==top) {
|
---|
562 | document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
563 | }
|
---|
564 | //-->
|
---|
565 | </SCRIPT>
|
---|
566 | <NOSCRIPT>
|
---|
567 | <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
568 | </NOSCRIPT>
|
---|
569 |
|
---|
570 | </FONT></TD>
|
---|
571 | </TR>
|
---|
572 | <TR>
|
---|
573 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
574 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
575 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
576 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
577 | </TR>
|
---|
578 | </TABLE>
|
---|
579 | <A NAME="skip-navbar_bottom"></A>
|
---|
580 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
581 |
|
---|
582 | <HR>
|
---|
583 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
584 | </BODY>
|
---|
585 | </HTML>
|
---|