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:40 PDT 2003 -->
7 AFSFileException (Java AFS API)
9 <META NAME="keywords" CONTENT="org.openafs.jafs.AFSFileException,AFSFileException class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="AFSFileException (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/AFSFileException.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/AFSException.html"><B>PREV CLASS</B></A>
46 <A HREF="../../../org/openafs/jafs/AFSSecurityException.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="AFSFileException.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="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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>
78 Class AFSFileException</H2>
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/lang/Throwable.html">java.lang.Throwable</A>
84 +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html">java.lang.Exception</A>
86 +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html">java.io.IOException</A>
88 +--<B>org.openafs.jafs.AFSFileException</B>
91 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
95 <DT>public class <B>AFSFileException</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html">IOException</A></DL>
98 An exception indicating that a file related error has occured in the
99 Java AFS API, in the Java AFS JNI, or in the AFS file system.
101 <P> This exception extends Java's <code>java.io.IOException</code>
102 and is therefore often used as a substitution for
103 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html"><CODE>IOException</CODE></A>.
108 <DT><B>Version:</B></DT>
109 <DD>2.0, 04/16/2001, 1.0, 05/25/2000</DD>
110 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A>,
111 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html"><CODE>IOException</CODE></A>,
112 <A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.AFSFileException">Serialized Form</A></DL>
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
119 <!-- =========== FIELD SUMMARY =========== -->
121 <A NAME="field_summary"><!-- --></A>
122 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124 <TD COLSPAN=2><FONT SIZE="+2">
125 <B>Field Summary</B></FONT></TD>
127 <TR BGCOLOR="white" CLASS="TableRowColor">
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129 <CODE>protected int</CODE></FONT></TD>
130 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#errno">errno</A></B></CODE>
133 The AFS specific error number (code).</TD>
136 <A NAME="fields_inherited_from_class_java.lang.Exception"><!-- --></A>
137 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
138 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
139 <TD><B>Fields inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html">Exception</A></B></TD>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD><CODE></CODE></TD>
146 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
148 <A NAME="constructor_summary"><!-- --></A>
149 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
151 <TD COLSPAN=2><FONT SIZE="+2">
152 <B>Constructor Summary</B></FONT></TD>
154 <TR BGCOLOR="white" CLASS="TableRowColor">
155 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(int)">AFSFileException</A></B>(int errno)</CODE>
158 Constructs an <code>AFSFileException</code> with the specified error
161 <TR BGCOLOR="white" CLASS="TableRowColor">
162 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(java.lang.String)">AFSFileException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> reason)</CODE>
165 Constructs an <code>AFSFileException</code> with the specified detail
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(java.lang.String, int)">AFSFileException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> reason,
170 int errno)</CODE>
173 Constructs an <code>AFSFileException</code> with the specified detail
174 message and specified error code. </TD>
178 <!-- ========== METHOD SUMMARY =========== -->
180 <A NAME="method_summary"><!-- --></A>
181 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
182 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183 <TD COLSPAN=2><FONT SIZE="+2">
184 <B>Method Summary</B></FONT></TD>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()">getAFSMessage</A></B>()</CODE>
192 Returns the AFS error message string defined by the <code>ErrorTable
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
198 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage(java.util.Locale)">getAFSMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A> locale)</CODE>
201 Returns the AFS error message defined by the <code>ErrorTable</code>
204 <TR BGCOLOR="white" CLASS="TableRowColor">
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206 <CODE> int</CODE></FONT></TD>
207 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
210 Returns the AFS specific error number (code). </TD>
212 <TR BGCOLOR="white" CLASS="TableRowColor">
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
215 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()">getMessage</A></B>()</CODE>
218 Returns the error message string of this exception.</TD>
220 <TR BGCOLOR="white" CLASS="TableRowColor">
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
223 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage(java.util.Locale)">getMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A> locale)</CODE>
226 Returns the locale specific error message string of this exception.</TD>
228 <TR BGCOLOR="white" CLASS="TableRowColor">
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
231 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#toString()">toString</A></B>()</CODE>
234 Returns a string representation of this AFS Exception.</TD>
237 <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
238 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
239 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
240 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></B></TD>
242 <TR BGCOLOR="white" CLASS="TableRowColor">
243 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#fillInStackTrace()">fillInStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getCause()">getCause</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getLocalizedMessage()">getLocalizedMessage</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getStackTrace()">getStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#initCause(java.lang.Throwable)">initCause</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace()">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement[])">setStackTrace</A></CODE></TD>
246 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
247 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
248 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
249 <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>
251 <TR BGCOLOR="white" CLASS="TableRowColor">
252 <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#equals(java.lang.Object)">equals</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#hashCode()">hashCode</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>
258 <!-- ============ FIELD DETAIL =========== -->
260 <A NAME="field_detail"><!-- --></A>
261 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
262 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
263 <TD COLSPAN=1><FONT SIZE="+2">
264 <B>Field Detail</B></FONT></TD>
268 <A NAME="errno"><!-- --></A><H3>
271 protected int <B>errno</B></PRE>
273 <DD>The AFS specific error number (code).
276 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></DL>
279 <!-- ========= CONSTRUCTOR DETAIL ======== -->
281 <A NAME="constructor_detail"><!-- --></A>
282 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
283 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
284 <TD COLSPAN=1><FONT SIZE="+2">
285 <B>Constructor Detail</B></FONT></TD>
289 <A NAME="AFSFileException(java.lang.String)"><!-- --></A><H3>
290 AFSFileException</H3>
292 public <B>AFSFileException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> reason)</PRE>
294 <DD>Constructs an <code>AFSFileException</code> with the specified detail
297 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.</DL>
300 <A NAME="AFSFileException(int)"><!-- --></A><H3>
301 AFSFileException</H3>
303 public <B>AFSFileException</B>(int errno)</PRE>
305 <DD>Constructs an <code>AFSFileException</code> with the specified error
306 code. This constructor will also generate the appropriate error message
307 respective to the specified error code.
309 <DT><B>Parameters:</B><DD><CODE>errno</CODE> - the AFS error number (error code).</DL>
312 <A NAME="AFSFileException(java.lang.String, int)"><!-- --></A><H3>
313 AFSFileException</H3>
315 public <B>AFSFileException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> reason,
316 int errno)</PRE>
318 <DD>Constructs an <code>AFSFileException</code> with the specified detail
319 message and specified error code. In this constructor the specified
320 detail message overrides the default AFS error message defined by the
321 <code>ErrorTable</code> class. Therefore, to retrieve the AFS specific
322 error message, you must use the <code><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>
323 </code> method. The <code><A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>getMessage()</CODE></A></code> method will return
324 the message specified in this constructor.
326 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.<DD><CODE>errno</CODE> - the AFS error number (error code).<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
328 <!-- ============ METHOD DETAIL ========== -->
330 <A NAME="method_detail"><!-- --></A>
331 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
332 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
333 <TD COLSPAN=1><FONT SIZE="+2">
334 <B>Method Detail</B></FONT></TD>
338 <A NAME="getErrorCode()"><!-- --></A><H3>
341 public int <B>getErrorCode</B>()</PRE>
343 <DD>Returns the AFS specific error number (code). This code can be interpreted
344 by use of the <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code> class method
345 <code><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></code>.
349 <DT><B>Returns:</B><DD>the AFS error code of this <code>AFSException</code>
350 object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></DL>
355 <A NAME="getMessage()"><!-- --></A><H3>
358 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>()</PRE>
360 <DD>Returns the error message string of this exception.
363 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getMessage()">getMessage</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
367 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
372 <A NAME="getMessage(java.util.Locale)"><!-- --></A><H3>
375 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A> locale)</PRE>
377 <DD>Returns the locale specific error message string of this exception.
380 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
381 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
386 <A NAME="getAFSMessage()"><!-- --></A><H3>
389 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>()</PRE>
391 <DD>Returns the AFS error message string defined by the <code>ErrorTable
392 </code> class. The message will be formatted according to the default
395 <P> This message is also available from this object's super class
396 method <code>getMessage</code>. However, this method will always return
397 the string message associated with the actual AFS error code/number
398 specified, whereas the <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
399 string message intended for this Exception object, which may be
400 an overridden message defined in the constructor of this Exception.
404 <DT><B>Returns:</B><DD>the AFS error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage(java.util.Locale)"><CODE>getAFSMessage(Locale)</CODE></A>,
405 <A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(java.lang.String, int)"><CODE>AFSFileException(String, int)</CODE></A>,
406 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A>,
407 <CODE>Throwable.getMessage()</CODE></DL>
412 <A NAME="getAFSMessage(java.util.Locale)"><!-- --></A><H3>
415 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A> locale)</PRE>
417 <DD>Returns the AFS error message defined by the <code>ErrorTable</code>
418 class. The message will be formatted according to the specified Locale.
420 <P> This message is also available from this object's super class
421 method <code>getMessage</code>. However, this method will always return
422 the string message associated with the actual AFS error code/number
423 specified, whereas the <A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
424 string message intended for this Exception object, which may be
425 an overridden message defined in the constructor of this Exception.
428 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
429 <DT><B>Returns:</B><DD>the AFS error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>,
430 <A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(java.lang.String, int)"><CODE>AFSFileException(String, int)</CODE></A>,
431 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int, java.util.Locale)"><CODE>ErrorTable.getMessage(int, Locale)</CODE></A>,
432 <CODE>Throwable.getMessage()</CODE></DL>
437 <A NAME="toString()"><!-- --></A><H3>
440 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
442 <DD>Returns a string representation of this AFS Exception.
445 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
449 <DT><B>Returns:</B><DD>the AFS error message string of this
450 <code>AFSFileException</code> object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getMessage()"><CODE>getMessage()</CODE></A></DL>
453 <!-- ========= END OF CLASS DATA ========= -->
456 <!-- ========== START OF NAVBAR ========== -->
457 <A NAME="navbar_bottom"><!-- --></A>
458 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
460 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
461 <A NAME="navbar_bottom_firstrow"><!-- --></A>
462 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
463 <TR ALIGN="center" VALIGN="top">
464 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
465 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
466 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AFSFileException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
467 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
468 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
469 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
470 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
474 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
475 <B>JAFS API v2</B></EM>
480 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
481 <A HREF="../../../org/openafs/jafs/AFSException.html"><B>PREV CLASS</B></A>
482 <A HREF="../../../org/openafs/jafs/AFSSecurityException.html"><B>NEXT CLASS</B></A></FONT></TD>
483 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
484 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
485 <A HREF="AFSFileException.html" TARGET="_top"><B>NO FRAMES</B></A>
490 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
495 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
500 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
501 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
502 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
503 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
506 <!-- =========== END OF NAVBAR =========== -->