Empty archive directory into keep or delete
[openafs-wiki.git] / delete / JavaAdminAPI / AFSFileException.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:40 PDT 2003 -->
6 <TITLE>
7 AFSFileException (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.AFSFileException,AFSFileException class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="AFSFileException (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
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>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AFSFileException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/AFSException.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;<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>  &nbsp;
49 &nbsp;<A HREF="AFSFileException.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class AFSFileException</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">java.lang.Throwable</A>
83         |
84         +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html">java.lang.Exception</A>
85               |
86               +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html">java.io.IOException</A>
87                     |
88                     +--<B>org.openafs.jafs.AFSFileException</B>
89 </PRE>
90 <DL>
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>
92 </DL>
93 <HR>
94 <DL>
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>
96
97 <P>
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.
100
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>.
104 <P>
105
106 <P>
107 <DL>
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>
113 <HR>
114
115 <P>
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
117
118
119 <!-- =========== FIELD SUMMARY =========== -->
120
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>
126 </TR>
127 <TR BGCOLOR="white" CLASS="TableRowColor">
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129 <CODE>protected &nbsp;int</CODE></FONT></TD>
130 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#errno">errno</A></B></CODE>
131
132 <BR>
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The AFS specific error number (code).</TD>
134 </TR>
135 </TABLE>
136 &nbsp;<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>
140 </TR>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD><CODE></CODE></TD>
143 </TR>
144 </TABLE>
145 &nbsp;
146 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
147
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>
153 </TR>
154 <TR BGCOLOR="white" CLASS="TableRowColor">
155 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#AFSFileException(int)">AFSFileException</A></B>(int&nbsp;errno)</CODE>
156
157 <BR>
158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSFileException</code> with the specified error
159  code. </TD>
160 </TR>
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>&nbsp;reason)</CODE>
163
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSFileException</code> with the specified detail
166  message.</TD>
167 </TR>
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>&nbsp;reason,
170                  int&nbsp;errno)</CODE>
171
172 <BR>
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSFileException</code> with the specified detail
174  message and specified error code.  </TD>
175 </TR>
176 </TABLE>
177 &nbsp;
178 <!-- ========== METHOD SUMMARY =========== -->
179
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>
185 </TR>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE>&nbsp;<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>
190
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message string defined by the <code>ErrorTable
193  </code> class.  </TD>
194 </TR>
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <CODE>&nbsp;<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>&nbsp;locale)</CODE>
199
200 <BR>
201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message defined by the <code>ErrorTable</code>
202  class.  </TD>
203 </TR>
204 <TR BGCOLOR="white" CLASS="TableRowColor">
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206 <CODE>&nbsp;int</CODE></FONT></TD>
207 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
208
209 <BR>
210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS specific error number (code).  </TD>
211 </TR>
212 <TR BGCOLOR="white" CLASS="TableRowColor">
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214 <CODE>&nbsp;<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>
216
217 <BR>
218 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the error message string of this exception.</TD>
219 </TR>
220 <TR BGCOLOR="white" CLASS="TableRowColor">
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222 <CODE>&nbsp;<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>&nbsp;locale)</CODE>
224
225 <BR>
226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the locale specific error message string of this exception.</TD>
227 </TR>
228 <TR BGCOLOR="white" CLASS="TableRowColor">
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230 <CODE>&nbsp;<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>
232
233 <BR>
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this AFS Exception.</TD>
235 </TR>
236 </TABLE>
237 &nbsp;<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>
241 </TR>
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>
244 </TR>
245 </TABLE>
246 &nbsp;<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>
250 </TR>
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>
253 </TR>
254 </TABLE>
255 &nbsp;
256 <P>
257
258 <!-- ============ FIELD DETAIL =========== -->
259
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>
265 </TR>
266 </TABLE>
267
268 <A NAME="errno"><!-- --></A><H3>
269 errno</H3>
270 <PRE>
271 protected int <B>errno</B></PRE>
272 <DL>
273 <DD>The AFS specific error number (code).
274 <P>
275 <DL>
276 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSFileException.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></DL>
277 </DL>
278
279 <!-- ========= CONSTRUCTOR DETAIL ======== -->
280
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>
286 </TR>
287 </TABLE>
288
289 <A NAME="AFSFileException(java.lang.String)"><!-- --></A><H3>
290 AFSFileException</H3>
291 <PRE>
292 public <B>AFSFileException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason)</PRE>
293 <DL>
294 <DD>Constructs an <code>AFSFileException</code> with the specified detail
295  message.
296 <P>
297 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.</DL>
298 <HR>
299
300 <A NAME="AFSFileException(int)"><!-- --></A><H3>
301 AFSFileException</H3>
302 <PRE>
303 public <B>AFSFileException</B>(int&nbsp;errno)</PRE>
304 <DL>
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.
308 <P>
309 <DT><B>Parameters:</B><DD><CODE>errno</CODE> - the AFS error number (error code).</DL>
310 <HR>
311
312 <A NAME="AFSFileException(java.lang.String, int)"><!-- --></A><H3>
313 AFSFileException</H3>
314 <PRE>
315 public <B>AFSFileException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason,
316                         int&nbsp;errno)</PRE>
317 <DL>
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.
325 <P>
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>
327
328 <!-- ============ METHOD DETAIL ========== -->
329
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>
335 </TR>
336 </TABLE>
337
338 <A NAME="getErrorCode()"><!-- --></A><H3>
339 getErrorCode</H3>
340 <PRE>
341 public int <B>getErrorCode</B>()</PRE>
342 <DL>
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>.
346 <P>
347 <DD><DL>
348
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>
351 </DD>
352 </DL>
353 <HR>
354
355 <A NAME="getMessage()"><!-- --></A><H3>
356 getMessage</H3>
357 <PRE>
358 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>()</PRE>
359 <DL>
360 <DD>Returns the error message string of this exception.
361 <P>
362 <DD><DL>
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>
364 </DD>
365 <DD><DL>
366
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>
368 </DD>
369 </DL>
370 <HR>
371
372 <A NAME="getMessage(java.util.Locale)"><!-- --></A><H3>
373 getMessage</H3>
374 <PRE>
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>&nbsp;locale)</PRE>
376 <DL>
377 <DD>Returns the locale specific error message string of this exception.
378 <P>
379 <DD><DL>
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>
382 </DD>
383 </DL>
384 <HR>
385
386 <A NAME="getAFSMessage()"><!-- --></A><H3>
387 getAFSMessage</H3>
388 <PRE>
389 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>()</PRE>
390 <DL>
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
393  Locale.
394
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.
401 <P>
402 <DD><DL>
403
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>
408 </DD>
409 </DL>
410 <HR>
411
412 <A NAME="getAFSMessage(java.util.Locale)"><!-- --></A><H3>
413 getAFSMessage</H3>
414 <PRE>
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>&nbsp;locale)</PRE>
416 <DL>
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.
419
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.
426 <P>
427 <DD><DL>
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>
433 </DD>
434 </DL>
435 <HR>
436
437 <A NAME="toString()"><!-- --></A><H3>
438 toString</H3>
439 <PRE>
440 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
441 <DL>
442 <DD>Returns a string representation of this AFS Exception.
443 <P>
444 <DD><DL>
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>
446 </DD>
447 <DD><DL>
448
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>
451 </DD>
452 </DL>
453 <!-- ========= END OF CLASS DATA ========= -->
454 <HR>
455
456 <!-- ========== START OF NAVBAR ========== -->
457 <A NAME="navbar_bottom"><!-- --></A>
458 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
459 <TR>
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>&nbsp;</TD>
465   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
466   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AFSFileException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
467   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
468   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
469   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
470   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
471   </TR>
472 </TABLE>
473 </TD>
474 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
475 <B>JAFS API v2</B></EM>
476 </TD>
477 </TR>
478
479 <TR>
480 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
481 &nbsp;<A HREF="../../../org/openafs/jafs/AFSException.html"><B>PREV CLASS</B></A>&nbsp;
482 &nbsp;<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>  &nbsp;
485 &nbsp;<A HREF="AFSFileException.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
486 &nbsp;
487 <SCRIPT>
488   <!--
489   if(window==top) {
490     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
491   }
492   //-->
493 </SCRIPT>
494 <NOSCRIPT>
495 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
496 </NOSCRIPT>
497 </FONT></TD>
498 </TR>
499 <TR>
500 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
501   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
502 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
503 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
504 </TR>
505 </TABLE>
506 <!-- =========== END OF NAVBAR =========== -->
507
508 <HR>
509
510 </BODY>
511 </HTML>