1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5 <!-- Generated by javadoc on Mon Jun 09 15:53:37 PDT 2003 -->
9 <META NAME="keywords" CONTENT="org.openafs.jafs.File,File class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="File (Java AFS API)";
18 <BODY BGCOLOR="white" onload="asd();">
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27 <TR ALIGN="center" VALIGN="top">
28 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
29 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
30 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/File.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 <A HREF="../../../org/openafs/jafs/ErrorTable.html"><B>PREV CLASS</B></A>
46 <A HREF="../../../org/openafs/jafs/FileInputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
49 <A HREF="File.html" TARGET="_top"><B>NO FRAMES</B></A>
54 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_java.io.File">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
70 <!-- =========== END OF NAVBAR =========== -->
73 <!-- ======== START OF CLASS DATA ======== -->
76 org.openafs.jafs</FONT>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
82 +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">java.io.File</A>
84 +--<B>org.openafs.jafs.File</B>
87 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
91 <DT>public class <B>File</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></DL>
94 An abstract representation of AFS file and directory pathnames.
96 This class is an extension of the standard Java File class with file-based
97 manipulation methods overridden by integrated AFS native methods.
99 <p> Extension methods include:
102 <li> <code><A HREF="../../../org/openafs/jafs/File.html#isMountPoint()"><CODE>isMountPoint()</CODE></A></code>
103 <li> <code><A HREF="../../../org/openafs/jafs/File.html#isLink()"><CODE>isLink()</CODE></A></code>
104 <li> <code><A HREF="../../../org/openafs/jafs/File.html#isValidated()"><CODE>isValidated()</CODE></A></code>
105 <li> <code><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></code>
106 <li> <code><A HREF="../../../org/openafs/jafs/File.html#refresh()"><CODE>refresh()</CODE></A></code>
107 <li> <code><A HREF="../../../org/openafs/jafs/File.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></code>
108 <li> <code><A HREF="../../../org/openafs/jafs/File.html#getErrorMessage()"><CODE>getErrorMessage()</CODE></A></code>
111 <p> For performance optimization, all newly constructed <code>File</code>
112 objects are only validated once. Furthermore, if an abstract pathname
113 denotes a symbolic-link, then the <A HREF="../../../org/openafs/jafs/File.html#isLink()"><CODE>isLink()</CODE></A> attribute is set
114 to true and the <A HREF="../../../org/openafs/jafs/File.html#getTarget()"><CODE>getTarget()</CODE></A> field member is populated with
115 this symbolic-link's target resource. (see <A HREF="../../../org/openafs/jafs/File.html#getTarget()"><CODE>getTarget()</CODE></A>)
117 <p> If you are interested in validating the target resource, simply
118 call <A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A> before calling any of the attribute accessors.
119 This action will <code>stat</code> the target resource, identifying
120 its associated attributes and populating them in this objects field
123 <p> Following is an example of how to construct a new AFS File Object:
126 File file = new File("/afs/mycell.com/proj/");
127 if (file.isDirectory()) {
128 System.out.println("This is a directory.");
129 } else if (file.isLink()) {
130 System.out.println("This is a symbolic-link.");
131 System.out.println(" Its target is: " + file.getTarget());
134 System.out.println(" This object is now a file!");
135 } else if (file.isDirectory()) {
136 System.out.println(" This object is now a directory!");
137 } else if (file.isMountPoint()) {
138 System.out.println(" This object is now a volume mount point!");
140 } else if (file.isMountPoint()) {
141 System.out.println("This is a volume mount point.");
142 } else if (file.isFile()) {
143 System.out.println("This is file.");
144 System.out.println(" its size is: " + file.length());
146 } catch (AFSFileException ae) {
147 System.out.println("AFS Exception: " + ae.getMessage());
148 System.out.println("AFS Error Code: " + ae.getErrorCode());
149 } catch (Exception e) {
150 System.out.println("Exception: " + e.getMessage());
158 <DT><B>Version:</B></DT>
159 <DD>2.0, 04/16/2001 - Completely revised class for efficiency., 1.3, 10/12/2000 - Introduced error code capture from native methods., 1.2, 05/30/2000</DD>
160 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.File">Serialized Form</A></DL>
164 <!-- ======== NESTED CLASS SUMMARY ======== -->
167 <!-- =========== FIELD SUMMARY =========== -->
169 <A NAME="field_summary"><!-- --></A>
170 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
172 <TD COLSPAN=2><FONT SIZE="+2">
173 <B>Field Summary</B></FONT></TD>
176 <A NAME="fields_inherited_from_class_java.io.File"><!-- --></A>
177 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
178 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179 <TD><B>Fields inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></B></TD>
181 <TR BGCOLOR="white" CLASS="TableRowColor">
182 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#pathSeparator">pathSeparator</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#pathSeparatorChar">pathSeparatorChar</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#separator">separator</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#separatorChar">separatorChar</A></CODE></TD>
186 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
188 <A NAME="constructor_summary"><!-- --></A>
189 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191 <TD COLSPAN=2><FONT SIZE="+2">
192 <B>Constructor Summary</B></FONT></TD>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(org.openafs.jafs.File, java.lang.String)">File</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> parent,
196 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename)</CODE>
199 Creates a new <code>File</code> instance from a parent abstract
200 pathname and a child pathname string and validates it against the file system.
204 <TR BGCOLOR="white" CLASS="TableRowColor">
205 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(org.openafs.jafs.File, java.lang.String, boolean)">File</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> parent,
206 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename,
207 boolean validate)</CODE>
210 Creates a new <code>File</code> instance from a parent abstract
211 pathname and a child pathname string.
215 <TR BGCOLOR="white" CLASS="TableRowColor">
216 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String)">File</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pathname)</CODE>
219 Creates a new <code>File</code> instance by converting the given
220 pathname string into an abstract pathname and validating it against
221 the file system. </TD>
223 <TR BGCOLOR="white" CLASS="TableRowColor">
224 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String, boolean)">File</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pathname,
225 boolean validate)</CODE>
228 Creates a new <code>File</code> instance by converting the given
229 pathname string into an abstract pathname. </TD>
231 <TR BGCOLOR="white" CLASS="TableRowColor">
232 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String, java.lang.String)">File</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> parent,
233 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename)</CODE>
236 Creates a new <code>File</code> instance from a parent pathname string
237 and a child pathname string and validates it against the file system.
241 <TR BGCOLOR="white" CLASS="TableRowColor">
242 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String, java.lang.String, boolean)">File</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> parent,
243 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename,
244 boolean validate)</CODE>
247 Creates a new <code>File</code> instance from a parent pathname string
248 and a child pathname string.
254 <!-- ========== METHOD SUMMARY =========== -->
256 <A NAME="method_summary"><!-- --></A>
257 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
258 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
259 <TD COLSPAN=2><FONT SIZE="+2">
260 <B>Method Summary</B></FONT></TD>
262 <TR BGCOLOR="white" CLASS="TableRowColor">
263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264 <CODE> boolean</CODE></FONT></TD>
265 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canAdmin()">canAdmin</A></B>()</CODE>
268 Tests whether the user can administer the ACL (see: <A HREF="../../../org/openafs/jafs/ACL.html"><CODE>ACL</CODE></A>
269 of the directory denoted by this abstract pathname.</TD>
271 <TR BGCOLOR="white" CLASS="TableRowColor">
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273 <CODE> boolean</CODE></FONT></TD>
274 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canDelete()">canDelete</A></B>()</CODE>
277 Tests whether the current user can delete the files or subdirectories of
278 the directory denoted by this abstract pathname.</TD>
280 <TR BGCOLOR="white" CLASS="TableRowColor">
281 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282 <CODE> boolean</CODE></FONT></TD>
283 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canInsert()">canInsert</A></B>()</CODE>
286 Tests whether the current user can insert a file into the directory
287 denoted by this abstract pathname.</TD>
289 <TR BGCOLOR="white" CLASS="TableRowColor">
290 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291 <CODE> boolean</CODE></FONT></TD>
292 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canLock()">canLock</A></B>()</CODE>
295 Tests whether the current user can lock the file denoted by this
296 abstract pathname.</TD>
298 <TR BGCOLOR="white" CLASS="TableRowColor">
299 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300 <CODE> boolean</CODE></FONT></TD>
301 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canLookup()">canLookup</A></B>()</CODE>
304 Tests whether the current user can lookup the contents of the directory
305 denoted by this abstract pathname.</TD>
307 <TR BGCOLOR="white" CLASS="TableRowColor">
308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309 <CODE> boolean</CODE></FONT></TD>
310 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canRead()">canRead</A></B>()</CODE>
313 Tests whether the current user can read the file denoted by this
314 abstract pathname.</TD>
316 <TR BGCOLOR="white" CLASS="TableRowColor">
317 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318 <CODE> boolean</CODE></FONT></TD>
319 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#canWrite()">canWrite</A></B>()</CODE>
322 Tests whether the current user can modify to the file denoted by this
323 abstract pathname.</TD>
325 <TR BGCOLOR="white" CLASS="TableRowColor">
326 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327 <CODE> boolean</CODE></FONT></TD>
328 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#close()">close</A></B>()</CODE>
331 Closes the directory denoted by this abstract pathname.</TD>
333 <TR BGCOLOR="white" CLASS="TableRowColor">
334 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
335 <CODE> int</CODE></FONT></TD>
336 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#compareTo(org.openafs.jafs.File)">compareTo</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> file)</CODE>
339 Compares two File objects relative to their filenames and <B>does not</B>
340 compare their respective absolute paths. </TD>
342 <TR BGCOLOR="white" CLASS="TableRowColor">
343 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344 <CODE> int</CODE></FONT></TD>
345 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A> o)</CODE>
348 Compares this file to another File object. </TD>
350 <TR BGCOLOR="white" CLASS="TableRowColor">
351 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352 <CODE> boolean</CODE></FONT></TD>
353 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#copyTo(org.openafs.jafs.File)">copyTo</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> dest)</CODE>
356 Copies the file denoted by this abstract pathname to the destination
359 <TR BGCOLOR="white" CLASS="TableRowColor">
360 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361 <CODE> boolean</CODE></FONT></TD>
362 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#delete()">delete</A></B>()</CODE>
365 Deletes the file or directory denoted by this abstract pathname. </TD>
367 <TR BGCOLOR="white" CLASS="TableRowColor">
368 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369 <CODE> boolean</CODE></FONT></TD>
370 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#exists()">exists</A></B>()</CODE>
373 Tests whether the file denoted by this abstract pathname exists.</TD>
375 <TR BGCOLOR="white" CLASS="TableRowColor">
376 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377 <CODE> int</CODE></FONT></TD>
378 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#getErrorCode()">getErrorCode</A></B>()</CODE>
381 Returns the AFS specific error number (code). </TD>
383 <TR BGCOLOR="white" CLASS="TableRowColor">
384 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
386 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#getErrorMessage()">getErrorMessage</A></B>()</CODE>
389 Returns the AFS error message string defined by the <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code>
392 <TR BGCOLOR="white" CLASS="TableRowColor">
393 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394 <CODE> int</CODE></FONT></TD>
395 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#getPermissionsMask()">getPermissionsMask</A></B>()</CODE>
398 Returns the permissions mask of the ACL for this object relative to the user accessing it.</TD>
400 <TR BGCOLOR="white" CLASS="TableRowColor">
401 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
403 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#getTarget()">getTarget</A></B>()</CODE>
406 Returns an abstract pathname string that represents the target resource of
407 of this file, if it is a symbolic-link.
411 <TR BGCOLOR="white" CLASS="TableRowColor">
412 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413 <CODE> boolean</CODE></FONT></TD>
414 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#isDirectory()">isDirectory</A></B>()</CODE>
417 Tests whether the file denoted by this abstract pathname is a
420 <TR BGCOLOR="white" CLASS="TableRowColor">
421 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
422 <CODE> boolean</CODE></FONT></TD>
423 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#isFile()">isFile</A></B>()</CODE>
426 Tests whether the file denoted by this abstract pathname is a normal
429 <TR BGCOLOR="white" CLASS="TableRowColor">
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
431 <CODE> boolean</CODE></FONT></TD>
432 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#isLink()">isLink</A></B>()</CODE>
435 Tests whether the file denoted by this abstract pathname is a
438 <TR BGCOLOR="white" CLASS="TableRowColor">
439 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
440 <CODE> boolean</CODE></FONT></TD>
441 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#isMountPoint()">isMountPoint</A></B>()</CODE>
444 Tests whether the file denoted by this abstract pathname is an
445 AFS Volume Mount Point.</TD>
447 <TR BGCOLOR="white" CLASS="TableRowColor">
448 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
449 <CODE> boolean</CODE></FONT></TD>
450 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#isValidated()">isValidated</A></B>()</CODE>
453 Tests whether the file denoted by this abstract pathname has
458 <TR BGCOLOR="white" CLASS="TableRowColor">
459 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
460 <CODE> long</CODE></FONT></TD>
461 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#lastModified()">lastModified</A></B>()</CODE>
464 Returns the time that the file denoted by this abstract pathname was
467 <TR BGCOLOR="white" CLASS="TableRowColor">
468 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
469 <CODE> long</CODE></FONT></TD>
470 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#length()">length</A></B>()</CODE>
473 Returns the length of the file denoted by this abstract pathname.</TD>
475 <TR BGCOLOR="white" CLASS="TableRowColor">
476 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
477 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
478 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#list()">list</A></B>()</CODE>
481 Returns an array of strings naming the files and directories in the
482 directory denoted by this abstract pathname.
486 <TR BGCOLOR="white" CLASS="TableRowColor">
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
488 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
489 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#listArray()">listArray</A></B>()</CODE>
492 Returns an ArrayList object containing strings naming the files and
493 directories in the directory denoted by this abstract pathname.
497 <TR BGCOLOR="white" CLASS="TableRowColor">
498 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
499 <CODE> boolean</CODE></FONT></TD>
500 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#mkdir()">mkdir</A></B>()</CODE>
503 Creates the directory named by this abstract pathname.</TD>
505 <TR BGCOLOR="white" CLASS="TableRowColor">
506 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
507 <CODE> void</CODE></FONT></TD>
508 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#refresh()">refresh</A></B>()</CODE>
511 Refreshes this AFS file object by updating its attributes.
514 <TR BGCOLOR="white" CLASS="TableRowColor">
515 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
516 <CODE> boolean</CODE></FONT></TD>
517 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#renameTo(org.openafs.jafs.File)">renameTo</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> dest)</CODE>
520 Renames the file denoted by this abstract pathname.</TD>
522 <TR BGCOLOR="white" CLASS="TableRowColor">
523 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
524 <CODE> boolean</CODE></FONT></TD>
525 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#setAttributes()">setAttributes</A></B>()</CODE>
528 Performs a file <code>stat</code> on the actual AFS file and populates
529 this object's respective field members with the appropriate values.
532 <TR BGCOLOR="white" CLASS="TableRowColor">
533 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
534 <CODE> void</CODE></FONT></TD>
535 <TD><CODE><B><A HREF="../../../org/openafs/jafs/File.html#validate()">validate</A></B>()</CODE>
538 Validates this abstract pathname as an attributed AFS file object.
542 <A NAME="methods_inherited_from_class_java.io.File"><!-- --></A>
543 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
544 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
545 <TD><B>Methods inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></B></TD>
547 <TR BGCOLOR="white" CLASS="TableRowColor">
548 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#compareTo(java.io.File)">compareTo</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#createNewFile()">createNewFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#createTempFile(java.lang.String, java.lang.String)">createTempFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#createTempFile(java.lang.String, java.lang.String, java.io.File)">createTempFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#deleteOnExit()">deleteOnExit</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getAbsoluteFile()">getAbsoluteFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getAbsolutePath()">getAbsolutePath</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getCanonicalFile()">getCanonicalFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getCanonicalPath()">getCanonicalPath</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getName()">getName</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getParent()">getParent</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getParentFile()">getParentFile</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#getPath()">getPath</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#isAbsolute()">isAbsolute</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#isHidden()">isHidden</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#list(java.io.FilenameFilter)">list</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#listFiles()">listFiles</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#listFiles(java.io.FileFilter)">listFiles</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#listFiles(java.io.FilenameFilter)">listFiles</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#listRoots()">listRoots</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#mkdirs()">mkdirs</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#renameTo(java.io.File)">renameTo</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#setLastModified(long)">setLastModified</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#setReadOnly()">setReadOnly</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#toURI()">toURI</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#toURL()">toURL</A></CODE></TD>
551 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
552 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
553 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
554 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></B></TD>
556 <TR BGCOLOR="white" CLASS="TableRowColor">
557 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
563 <!-- ============ FIELD DETAIL =========== -->
566 <!-- ========= CONSTRUCTOR DETAIL ======== -->
568 <A NAME="constructor_detail"><!-- --></A>
569 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
570 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
571 <TD COLSPAN=1><FONT SIZE="+2">
572 <B>Constructor Detail</B></FONT></TD>
576 <A NAME="File(java.lang.String)"><!-- --></A><H3>
579 public <B>File</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pathname)
580 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
582 <DD>Creates a new <code>File</code> instance by converting the given
583 pathname string into an abstract pathname and validating it against
584 the file system. If the given string is an empty string, then the
585 result is the empty abstract pathname; otherwise the abstract pathname
586 is <code>validated</code> to represent a qualified file object.
588 <DT><B>Parameters:</B><DD><CODE>pathname</CODE> - A pathname string
590 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If the <code>pathname</code> argument is <code>null</code>
591 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If the user constructing this AFS file object is denied
592 access to stat the file or simply a stat cannot be performed
593 on the file. The reason code and message will be available
594 from <A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>AFSFileException.getErrorCode()</CODE></A> and
595 <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>AFSFileException.getMessage()</CODE></A> respectively.
596 <p> This exception <U>will not</U> be thrown if the file does not
597 exist. Rather, the <A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A> attribute will be set to
598 <code>false</code>.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
601 <A NAME="File(java.lang.String, boolean)"><!-- --></A><H3>
604 public <B>File</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pathname,
605 boolean validate)</PRE>
607 <DD>Creates a new <code>File</code> instance by converting the given
608 pathname string into an abstract pathname. If the given string is
609 an empty string, then the result is the empty abstract pathname.
611 <p> The abstract pathname will remain <B>abstract</B> unless the
612 <code>validate</code> parameter is set to <code>true</code>. This
613 means that the abstract pathname will <U>not</U> be <code>validated</code>
614 and therefore the file object will not represent a qualified, attributed,
615 AFS file resource. Rather, this constructor provides a method by which
616 you can construct a non-validated <code>File</code> object (one that
617 does not contain the file's complete status information).
619 <p> This constructor is useful for creating file objects of file/path names
620 that you know exist, however are unauthorized to <code>validate</code> (or
621 <code>stat</code> - to obtain complete status information). For example,
622 if you are permitted to <code>lookup</code> (see: <A HREF="../../../org/openafs/jafs/File.html#canLookup()"><CODE>canLookup()</CODE></A>) the
623 contents of a given directory yet <U>not</U> permitted to <code>read</code>
624 (see: <A HREF="../../../org/openafs/jafs/File.html#canRead()"><CODE>canRead()</CODE></A>), then this constructor would enable you to render the
625 contents of the directory without validating each entry.
627 <p> <B>Please note:</B> this is the only constructor that does not throw an AFSFileException.
629 <DT><B>Parameters:</B><DD><CODE>pathname</CODE> - A pathname string<DD><CODE>validate</CODE> - A boolean flag to indicate if this abstract path
632 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If the <code>pathname</code> argument is <code>null</code><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String)"><CODE>File(String)</CODE></A>,
633 <A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
636 <A NAME="File(java.lang.String, java.lang.String)"><!-- --></A><H3>
639 public <B>File</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> parent,
640 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename)
641 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
643 <DD>Creates a new <code>File</code> instance from a parent pathname string
644 and a child pathname string and validates it against the file system.
646 <p> If <code>parent</code> is <code>null</code> then the new
647 <code>File</code> instance is created as if by invoking the
648 single-argument <code>File</code> constructor on the given
649 <code>filename</code> string (child pathname).
651 <p> Otherwise the <code>parent</code> pathname string is taken to denote
652 a directory, and the <code>filename</code> string is taken to
653 denote either a directory or a file. The directory or file will then be
654 <code>validated</code> to represent a qualified file object.
656 <DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent pathname string<DD><CODE>filename</CODE> - This file's pathname string (child of specified parent)
658 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <code>child</code> is <code>null</code>
659 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If the user constructing this AFS file object is denied
660 access to stat the file or simply a stat cannot be performed
661 on the file. The reason code and message will be available
662 from <A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>AFSFileException.getErrorCode()</CODE></A> and
663 <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>AFSFileException.getMessage()</CODE></A> respectively.
664 <p> This exception <U>will not</U> be thrown if the file does not
665 exist. Rather, the <A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A> attribute will be set to
666 <code>false</code>.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
669 <A NAME="File(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
672 public <B>File</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> parent,
673 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename,
674 boolean validate)
675 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
677 <DD>Creates a new <code>File</code> instance from a parent pathname string
678 and a child pathname string.
680 <p> If <code>parent</code> is <code>null</code> then the new
681 <code>File</code> instance is created as if by invoking the
682 single-argument <code>File</code> constructor on the given
683 <code>filename</code> string (child pathname).
685 <p> Otherwise the <code>parent</code> pathname string is taken to denote
686 a directory, and the <code>filename</code> string is taken to
687 denote either a directory or a file.
689 <p> The abstract pathname will remain <B>abstract</B> unless the
690 <code>validate</code> parameter is set to <code>true</code>. This
691 means that the abstract pathname will <U>not</U> be <code>validated</code>
692 and therefore the file object will not represent a qualified, attributed,
693 AFS file resource. Rather, this constructor provides a method by which
694 you can construct a non-validated <code>File</code> object (one that
695 does not contain the file's complete status information).
697 <p> This constructor is useful for creating file objects of file/path names
698 that you know exist, however are unauthorized to <code>validate</code> (or
699 <code>stat</code> - to obtain complete status information). For example,
700 if you are permitted to <code>lookup</code> (see: <A HREF="../../../org/openafs/jafs/File.html#canLookup()"><CODE>canLookup()</CODE></A>) the
701 contents of a given directory yet <U>not</U> permitted to <code>read</code>
702 (see: <A HREF="../../../org/openafs/jafs/File.html#canRead()"><CODE>canRead()</CODE></A>), then this constructor would enable you to render the
703 contents of the directory without validating each entry.
705 <DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent pathname string<DD><CODE>filename</CODE> - This file's pathname string (child of specified parent)<DD><CODE>validate</CODE> - A boolean flag to indicate if this abstract path
708 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <code>child</code> is <code>null</code>
709 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If the user constructing this AFS file object is denied
710 access to stat the file or simply a stat cannot be performed
711 on the file. The reason code and message will be available
712 from <A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>AFSFileException.getErrorCode()</CODE></A> and
713 <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>AFSFileException.getMessage()</CODE></A> respectively.
714 <p> This exception <U>will not</U> be thrown if the file does not
715 exist. Rather, the <A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A> attribute will be set to
716 <code>false</code>.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#File(java.lang.String, java.lang.String)"><CODE>File(String, String)</CODE></A>,
717 <A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
720 <A NAME="File(org.openafs.jafs.File, java.lang.String)"><!-- --></A><H3>
723 public <B>File</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> parent,
724 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename)
725 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
727 <DD>Creates a new <code>File</code> instance from a parent abstract
728 pathname and a child pathname string and validates it against the file system.
730 <p> If <code>parent</code> is <code>null</code> then the new
731 <code>File</code> instance is created as if by invoking the
732 single-argument <code>File</code> constructor on the given
733 <code>filename</code> string (child pathname).
735 <p> Otherwise the <code>parent</code> abstract pathname is taken to
736 denote a directory, and the <code>filename</code> string is taken
737 to denote either a directory or a file. The directory or file will then be
738 <code>validated</code> to represent a qualified file object.
740 <DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent abstract pathname<DD><CODE>filename</CODE> - This file's pathname string (child of specified parent)
742 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <code>child</code> is <code>null</code>
743 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If the user constructing this AFS file object is denied
744 access to stat the file or simply a stat cannot be performed
745 on the file. The reason code and message will be available
746 from <A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>AFSFileException.getErrorCode()</CODE></A> and
747 <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>AFSFileException.getMessage()</CODE></A> respectively.
748 <p> This exception <U>will not</U> be thrown if the file does not
749 exist. Rather, the <A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A> attribute will be set to
750 <code>false</code>.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
753 <A NAME="File(org.openafs.jafs.File, java.lang.String, boolean)"><!-- --></A><H3>
756 public <B>File</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> parent,
757 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> filename,
758 boolean validate)
759 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
761 <DD>Creates a new <code>File</code> instance from a parent abstract
762 pathname and a child pathname string.
764 <p> If <code>parent</code> is <code>null</code> then the new
765 <code>File</code> instance is created as if by invoking the
766 single-argument <code>File</code> constructor on the given
767 <code>filename</code> string (child pathname).
769 <p> Otherwise the <code>parent</code> abstract pathname is taken to
770 denote a directory, and the <code>filename</code> string is taken
771 to denote either a directory or a file.
773 <p> The abstract pathname will remain <B>abstract</B> unless the
774 <code>validate</code> parameter is set to <code>true</code>. This
775 means that the abstract pathname will <U>not</U> be <code>validated</code>
776 and therefore the file object will not represent a qualified, attributed,
777 AFS file resource. Rather, this constructor provides a method by which
778 you can construct a non-validated <code>File</code> object (one that
779 does not contain the file's complete status information).
781 <p> This constructor is useful for creating file objects of file/path names
782 that you know exist, however are unauthorized to <code>validate</code> (or
783 <code>stat</code> - to obtain complete status information). For example,
784 if you are permitted to <code>lookup</code> (see: <A HREF="../../../org/openafs/jafs/File.html#canLookup()"><CODE>canLookup()</CODE></A>) the
785 contents of a given directory yet <U>not</U> permitted to <code>read</code>
786 (see: <A HREF="../../../org/openafs/jafs/File.html#canRead()"><CODE>canRead()</CODE></A>), then this constructor would enable you to render the
787 contents of the directory without validating each entry.
789 <DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent abstract pathname<DD><CODE>filename</CODE> - This file's pathname string (child of specified parent)<DD><CODE>validate</CODE> - A boolean flag to indicate if this abstract path
792 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <code>child</code> is <code>null</code>
793 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If the user constructing this AFS file object is denied
794 access to stat the file or simply a stat cannot be performed
795 on the file. The reason code and message will be available
796 from <A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>AFSFileException.getErrorCode()</CODE></A> and
797 <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>AFSFileException.getMessage()</CODE></A> respectively.
798 <p> This exception <U>will not</U> be thrown if the file does not
799 exist. Rather, the <A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A> attribute will be set to
800 <code>false</code>.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A>,
801 <A HREF="../../../org/openafs/jafs/File.html#File(org.openafs.jafs.File, java.lang.String)"><CODE>File(File, String)</CODE></A></DL>
803 <!-- ============ METHOD DETAIL ========== -->
805 <A NAME="method_detail"><!-- --></A>
806 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
807 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
808 <TD COLSPAN=1><FONT SIZE="+2">
809 <B>Method Detail</B></FONT></TD>
813 <A NAME="validate()"><!-- --></A><H3>
816 public void <B>validate</B>()
817 throws <A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></PRE>
819 <DD>Validates this abstract pathname as an attributed AFS file object.
820 This method will, if authorized, perform a <code>stat</code> on the
821 actual AFS file and update its respective field members; defining
822 this file object's attributes.
830 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></CODE> - If an AFS exception occurs while attempting to stat and set this
831 AFS file object's attributes.</DL>
836 <A NAME="isValidated()"><!-- --></A><H3>
839 public boolean <B>isValidated</B>()</PRE>
841 <DD>Tests whether the file denoted by this abstract pathname has
844 <P> Validation is always attempted upon construction of the file object,
845 therefore if this method returns false, then you are not permitted to
846 <code>validate</code> this file and consequently all attribute accessors
849 <P> This method should return <code>true</code> even if this abstract
850 pathname does not exist. If this is abstract pathname does not exist then
851 the <code><A HREF="../../../org/openafs/jafs/File.html#exists()"><CODE>exists()</CODE></A></code> method should return false, however this
852 implies that the attribute accessors are valid and accurate; thus implying
853 successful validation.
855 <P> This method is useful before calling any of the attribute accessors
856 to ensure a valid response.
863 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
864 abstract pathname has been validated during or after object construction;
865 <code>false</code> otherwise</DL>
870 <A NAME="refresh()"><!-- --></A><H3>
873 public void <B>refresh</B>()
874 throws <A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></PRE>
876 <DD>Refreshes this AFS file object by updating its attributes.
877 This method currently provides the same functionality as
878 <A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A>.
886 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></CODE> - If an AFS exception occurs while attempting to stat and update this
887 AFS file object's attributes.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
892 <A NAME="isDirectory()"><!-- --></A><H3>
895 public boolean <B>isDirectory</B>()</PRE>
897 <DD>Tests whether the file denoted by this abstract pathname is a
901 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#isDirectory()">isDirectory</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
905 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
906 abstract pathname exists <em>and</em> is a directory;
907 <code>false</code> otherwise</DL>
912 <A NAME="isFile()"><!-- --></A><H3>
915 public boolean <B>isFile</B>()</PRE>
917 <DD>Tests whether the file denoted by this abstract pathname is a normal
918 file. A file is <em>normal</em> if it is not a directory and, in
919 addition, satisfies other system-dependent criteria. Any non-directory
920 file created by a Java application is guaranteed to be a normal file.
923 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#isFile()">isFile</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
927 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
928 abstract pathname exists <em>and</em> is a normal file;
929 <code>false</code> otherwise</DL>
934 <A NAME="isMountPoint()"><!-- --></A><H3>
937 public boolean <B>isMountPoint</B>()</PRE>
939 <DD>Tests whether the file denoted by this abstract pathname is an
940 AFS Volume Mount Point.
947 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
948 abstract pathname exists <em>and</em> is a mount point;
949 <code>false</code> otherwise</DL>
954 <A NAME="isLink()"><!-- --></A><H3>
957 public boolean <B>isLink</B>()</PRE>
959 <DD>Tests whether the file denoted by this abstract pathname is a
967 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
968 abstract pathname exists <em>and</em> is a symbolic-link;
969 <code>false</code> otherwise</DL>
974 <A NAME="exists()"><!-- --></A><H3>
977 public boolean <B>exists</B>()</PRE>
979 <DD>Tests whether the file denoted by this abstract pathname exists.
982 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#exists()">exists</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
986 <DT><B>Returns:</B><DD><code>true</code> if and only if the file denoted by this
987 abstract pathname exists; <code>false</code> otherwise</DL>
992 <A NAME="lastModified()"><!-- --></A><H3>
995 public long <B>lastModified</B>()</PRE>
997 <DD>Returns the time that the file denoted by this abstract pathname was
1001 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#lastModified()">lastModified</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1005 <DT><B>Returns:</B><DD>A <code>long</code> value representing the time the file was
1006 last modified, measured in milliseconds since the epoch
1007 (00:00:00 GMT, January 1, 1970), or <code>0L</code> if the
1008 file does not exist or if an I/O error occurs</DL>
1013 <A NAME="length()"><!-- --></A><H3>
1016 public long <B>length</B>()</PRE>
1018 <DD>Returns the length of the file denoted by this abstract pathname.
1021 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#length()">length</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1025 <DT><B>Returns:</B><DD>The length, in bytes, of the file denoted by this abstract
1026 pathname, or <code>0L</code> if the file does not exist</DL>
1031 <A NAME="getTarget()"><!-- --></A><H3>
1034 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getTarget</B>()</PRE>
1036 <DD>Returns an abstract pathname string that represents the target resource of
1037 of this file, if it is a symbolic-link.
1039 <p> If this abstract pathname <B>does not</B> denote a symbolic-link, then this
1040 method returns <code>null</code>. Otherwise a string is
1041 returned that represents the target resource of this symbolic-link.
1048 <DT><B>Returns:</B><DD>A string representation of this symbolic-link's target resource.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#isLink()"><CODE>isLink()</CODE></A></DL>
1053 <A NAME="list()"><!-- --></A><H3>
1056 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>list</B>()</PRE>
1058 <DD>Returns an array of strings naming the files and directories in the
1059 directory denoted by this abstract pathname.
1061 <p> If this abstract pathname does not denote a directory, then this
1062 method returns <code>null</code>. Otherwise an array of strings is
1063 returned, one for each file or directory in the directory. Names
1064 denoting the directory itself and the directory's parent directory are
1065 not included in the result. Each string is a file name rather than a
1068 <p> There is no guarantee that the name strings in the resulting array
1069 will appear in any specific order; they are not, in particular,
1070 guaranteed to appear in alphabetical order.
1073 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#list()">list</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1077 <DT><B>Returns:</B><DD>An array of strings naming the files and directories in the
1078 directory denoted by this abstract pathname. The array will be
1079 empty if the directory is empty. Returns <code>null</code> if
1080 this abstract pathname does not denote a directory, or if an
1081 I/O error occurs.</DL>
1086 <A NAME="listArray()"><!-- --></A><H3>
1089 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>listArray</B>()
1090 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
1092 <DD>Returns an ArrayList object containing strings naming the files and
1093 directories in the directory denoted by this abstract pathname.
1095 <p> If this abstract pathname does not denote a directory, then this
1096 method returns <code>null</code>. Otherwise an array of strings is
1097 returned, one for each file or directory in the directory. Names
1098 denoting the directory itself and the directory's parent directory are
1099 not included in the result. Each string is a file name rather than a
1102 <p> There is no guarantee that the name strings in the resulting array
1103 will appear in any specific order; they are not, in particular,
1104 guaranteed to appear in alphabetical order.
1111 <DT><B>Returns:</B><DD>An array of strings naming the files and directories in the
1112 directory denoted by this abstract pathname. The array will be
1113 empty if the directory is empty. Returns <code>null</code> if
1114 this abstract pathname does not denote a directory, or if an
1117 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></CODE> - If you are not authorized to list the contents of this directory
1118 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If this file object is not a <code>mount point</code>, <code>link
1119 </code>, or <code>directory</code> <B>or</B> an unexpected AFS
1120 error occurs.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#list()"><CODE>list()</CODE></A></DL>
1125 <A NAME="delete()"><!-- --></A><H3>
1128 public boolean <B>delete</B>()</PRE>
1130 <DD>Deletes the file or directory denoted by this abstract pathname. If
1131 this pathname denotes a directory, then the directory must be empty in
1132 order to be deleted.
1135 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#delete()">delete</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1139 <DT><B>Returns:</B><DD><code>true</code> if and only if the file or directory is
1140 successfully deleted; <code>false</code> otherwise</DL>
1145 <A NAME="copyTo(org.openafs.jafs.File)"><!-- --></A><H3>
1148 public boolean <B>copyTo</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> dest)
1149 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
1151 <DD>Copies the file denoted by this abstract pathname to the destination
1152 file provided. Then checks the newly copied file's size to
1153 test for file size consistency.
1159 <DT><B>Parameters:</B><DD><CODE>dest</CODE> - The new abstract pathname for the named file
1160 <DT><B>Returns:</B><DD><code>true</code> if and only if the file that was copied
1161 reports the same file size (length) as that of this file;
1162 <code>false</code> otherwise
1164 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If an I/O or AFS exception is encountered while copying the file.</DL>
1169 <A NAME="getPermissionsMask()"><!-- --></A><H3>
1170 getPermissionsMask</H3>
1172 public int <B>getPermissionsMask</B>()</PRE>
1174 <DD>Returns the permissions mask of the ACL for this object relative to the user accessing it.
1181 <DT><B>Returns:</B><DD>the permissions mask of this object based upon the current user.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#getPermissionsMask()"><CODE>ACL.Entry.getPermissionsMask()</CODE></A></DL>
1186 <A NAME="canAdmin()"><!-- --></A><H3>
1189 public boolean <B>canAdmin</B>()</PRE>
1191 <DD>Tests whether the user can administer the ACL (see: <A HREF="../../../org/openafs/jafs/ACL.html"><CODE>ACL</CODE></A>
1192 of the directory denoted by this abstract pathname.
1199 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory specified by this
1200 abstract pathname exists <em>and</em> can be administered by the
1201 current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canAdmin()"><CODE>ACL.Entry.canAdmin()</CODE></A></DL>
1206 <A NAME="canDelete()"><!-- --></A><H3>
1209 public boolean <B>canDelete</B>()</PRE>
1211 <DD>Tests whether the current user can delete the files or subdirectories of
1212 the directory denoted by this abstract pathname.
1219 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory specified by this
1220 abstract pathname exists <em>and</em> permits deletion of its files
1221 and subdirectories by the current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canDelete()"><CODE>ACL.Entry.canDelete()</CODE></A></DL>
1226 <A NAME="canInsert()"><!-- --></A><H3>
1229 public boolean <B>canInsert</B>()</PRE>
1231 <DD>Tests whether the current user can insert a file into the directory
1232 denoted by this abstract pathname.
1239 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory specified by this
1240 abstract pathname exists <em>and</em> a file can be inserted by the
1241 current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canInsert()"><CODE>ACL.Entry.canInsert()</CODE></A></DL>
1246 <A NAME="canLock()"><!-- --></A><H3>
1249 public boolean <B>canLock</B>()</PRE>
1251 <DD>Tests whether the current user can lock the file denoted by this
1259 <DT><B>Returns:</B><DD><code>true</code> if and only if the file specified by this
1260 abstract pathname exists <em>and</em> can be locked by the
1261 current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canLock()"><CODE>ACL.Entry.canLock()</CODE></A></DL>
1266 <A NAME="canLookup()"><!-- --></A><H3>
1269 public boolean <B>canLookup</B>()</PRE>
1271 <DD>Tests whether the current user can lookup the contents of the directory
1272 denoted by this abstract pathname.
1279 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory specified by this
1280 abstract pathname exists <em>and</em> its contents can be listed by the
1281 current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canLookup()"><CODE>ACL.Entry.canLookup()</CODE></A></DL>
1286 <A NAME="canRead()"><!-- --></A><H3>
1289 public boolean <B>canRead</B>()</PRE>
1291 <DD>Tests whether the current user can read the file denoted by this
1295 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#canRead()">canRead</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1299 <DT><B>Returns:</B><DD><code>true</code> if and only if the file specified by this
1300 abstract pathname exists <em>and</em> can be read by the
1301 current user; <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canRead()"><CODE>ACL.Entry.canRead()</CODE></A></DL>
1306 <A NAME="canWrite()"><!-- --></A><H3>
1309 public boolean <B>canWrite</B>()</PRE>
1311 <DD>Tests whether the current user can modify to the file denoted by this
1315 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#canWrite()">canWrite</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1319 <DT><B>Returns:</B><DD><code>true</code> if and only if the file system actually
1320 contains a file denoted by this abstract pathname <em>and</em>
1321 the current user is allowed to write to the file;
1322 <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#canWrite()"><CODE>ACL.Entry.canWrite()</CODE></A></DL>
1327 <A NAME="close()"><!-- --></A><H3>
1330 public boolean <B>close</B>()</PRE>
1332 <DD>Closes the directory denoted by this abstract pathname.
1339 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory is
1340 successfully closed; <code>false</code> otherwise</DL>
1345 <A NAME="getErrorCode()"><!-- --></A><H3>
1348 public int <B>getErrorCode</B>()</PRE>
1350 <DD>Returns the AFS specific error number (code). This code can be interpreted
1351 by use of <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code> static class method
1352 <code><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></code>
1359 <DT><B>Returns:</B><DD>the AFS error code (number) associated with the last action performed
1360 on this object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></DL>
1365 <A NAME="getErrorMessage()"><!-- --></A><H3>
1366 getErrorMessage</H3>
1368 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getErrorMessage</B>()</PRE>
1370 <DD>Returns the AFS error message string defined by the <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code>
1378 <DT><B>Returns:</B><DD>the AFS error message string associated with the last action performed
1379 on this object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></DL>
1384 <A NAME="compareTo(org.openafs.jafs.File)"><!-- --></A><H3>
1387 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> file)</PRE>
1389 <DD>Compares two File objects relative to their filenames and <B>does not</B>
1390 compare their respective absolute paths. Alphabetic case is significant in
1391 comparing filenames.
1397 <DT><B>Parameters:</B><DD><CODE>file</CODE> - The File object to be compared to this file's filename
1398 <DT><B>Returns:</B><DD>Zero if the argument is equal to this file's filename, a
1399 value less than zero if this file's filename is
1400 lexicographically less than the argument, or a value greater
1401 than zero if this file's filename is lexicographically
1402 greater than the argument<DT><B>Since:</B></DT>
1409 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
1412 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A> o)
1413 throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/ClassCastException.html">ClassCastException</A></PRE>
1415 <DD>Compares this file to another File object. If the other object
1416 is an abstract pathname, then this function behaves like <code><A HREF="../../../org/openafs/jafs/File.html#compareTo(org.openafs.jafs.File)"><CODE>compareTo(File)</CODE></A></code>. Otherwise, it throws a
1417 <code>ClassCastException</code>, since File objects can only be
1418 compared to File objects.
1421 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#compareTo(java.lang.Object)">compareTo</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1424 <DT><B>Parameters:</B><DD><CODE>o</CODE> - The <code>Object</code> to be compared to this abstract pathname
1425 <DT><B>Returns:</B><DD>If the argument is an File object, returns zero
1426 if the argument is equal to this file's filename, a value
1427 less than zero if this file's filename is lexicographically
1428 less than the argument, or a value greater than zero if this
1429 file's filename is lexicographically greater than the
1432 <DD><CODE><code>ClassCastException</code></CODE> - if the argument is not an
1434 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/ClassCastException.html">ClassCastException</A></CODE><DT><B>Since:</B></DT>
1436 <DT><B>See Also:</B><DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html"><CODE>Comparable</CODE></A></DL>
1441 <A NAME="mkdir()"><!-- --></A><H3>
1444 public boolean <B>mkdir</B>()</PRE>
1446 <DD>Creates the directory named by this abstract pathname.
1449 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html#mkdir()">mkdir</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html">File</A></CODE></DL>
1453 <DT><B>Returns:</B><DD><code>true</code> if and only if the directory was
1454 created; <code>false</code> otherwise</DL>
1459 <A NAME="renameTo(org.openafs.jafs.File)"><!-- --></A><H3>
1462 public boolean <B>renameTo</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A> dest)</PRE>
1464 <DD>Renames the file denoted by this abstract pathname.
1470 <DT><B>Parameters:</B><DD><CODE>dest</CODE> - The new abstract pathname for the named file
1471 <DT><B>Returns:</B><DD><code>true</code> if and only if the renaming succeeded;
1472 <code>false</code> otherwise
1474 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If parameter <code>dest</code> is <code>null</code></DL>
1479 <A NAME="setAttributes()"><!-- --></A><H3>
1482 public boolean <B>setAttributes</B>()
1483 throws <A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></PRE>
1485 <DD>Performs a file <code>stat</code> on the actual AFS file and populates
1486 this object's respective field members with the appropriate values.
1487 method will, if authorized, perform a <code>stat</code> on the
1488 actual AFS file and update its respective field members; defining
1489 this file object's attributes.
1491 <P><B>This method should not be used directly for refreshing or validating
1492 this AFS file object. Please use <A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A> instead.</B>
1499 <DT><B>Returns:</B><DD><code>true</code> if and only if the current user is allowed to stat the file;
1500 <code>false</code> otherwise.
1501 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSSecurityException.html">AFSSecurityException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html#validate()"><CODE>validate()</CODE></A></DL>
1504 <!-- ========= END OF CLASS DATA ========= -->
1507 <!-- ========== START OF NAVBAR ========== -->
1508 <A NAME="navbar_bottom"><!-- --></A>
1509 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
1511 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1512 <A NAME="navbar_bottom_firstrow"><!-- --></A>
1513 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
1514 <TR ALIGN="center" VALIGN="top">
1515 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1516 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1517 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/File.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
1518 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1519 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1520 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1521 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1525 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1526 <B>JAFS API v2</B></EM>
1531 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1532 <A HREF="../../../org/openafs/jafs/ErrorTable.html"><B>PREV CLASS</B></A>
1533 <A HREF="../../../org/openafs/jafs/FileInputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
1534 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1535 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
1536 <A HREF="File.html" TARGET="_top"><B>NO FRAMES</B></A>
1541 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
1546 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
1551 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1552 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_java.io.File">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
1553 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1554 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
1557 <!-- =========== END OF NAVBAR =========== -->