archive/JavaAdminAPI/AFSException.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 AFSException (Java AFS API)
   8 </TITLE>
   9 <META NAME="keywords" CONTENT="org.openafs.jafs.AFSException,AFSException 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="AFSException (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/AFSException.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;PREV CLASS&nbsp;
  46 &nbsp;<A HREF="../../../org/openafs/jafs/AFSFileException.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="AFSException.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 AFSException</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               +--<B>org.openafs.jafs.AFSException</B>
  87 </PRE>
  88 <DL>
  89 <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>
  90 </DL>
  91 <HR>
  92 <DL>
  93 <DT>public class <B>AFSException</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html">Exception</A></DL>
  94
  95 <P>
  96 An exception indicating that an error has occurred in the Java AFS
  97  API, in the Java AFS JNI, or in the AFS file system.
  98 <P>
  99
 100 <P>
 101 <DL>
 102 <DT><B>Version:</B></DT>
 103   <DD>1.0, 04/16/2001</DD>
 104 <DT><B>See Also:</B><DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html"><CODE>Exception</CODE></A>,
 105 <A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.AFSException">Serialized Form</A></DL>
 106 <HR>
 107
 108 <P>
 109 <!-- ======== NESTED CLASS SUMMARY ======== -->
 110
 111
 112 <!-- =========== FIELD SUMMARY =========== -->
 113
 114 <A NAME="field_summary"><!-- --></A>
 115 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 117 <TD COLSPAN=2><FONT SIZE="+2">
 118 <B>Field Summary</B></FONT></TD>
 119 </TR>
 120 <TR BGCOLOR="white" CLASS="TableRowColor">
 121 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 122 <CODE>protected &nbsp;int</CODE></FONT></TD>
 123 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#errno">errno</A></B></CODE>
 124
 125 <BR>
 126 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The AFS specific error number (code).</TD>
 127 </TR>
 128 </TABLE>
 129 &nbsp;<A NAME="fields_inherited_from_class_java.lang.Exception"><!-- --></A>
 130 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 131 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 132 <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>
 133 </TR>
 134 <TR BGCOLOR="white" CLASS="TableRowColor">
 135 <TD><CODE></CODE></TD>
 136 </TR>
 137 </TABLE>
 138 &nbsp;
 139 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 140
 141 <A NAME="constructor_summary"><!-- --></A>
 142 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 144 <TD COLSPAN=2><FONT SIZE="+2">
 145 <B>Constructor Summary</B></FONT></TD>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#AFSException(int)">AFSException</A></B>(int&nbsp;errno)</CODE>
 149
 150 <BR>
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSException</code> with the specified error code.
 152  </TD>
 153 </TR>
 154 <TR BGCOLOR="white" CLASS="TableRowColor">
 155 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#AFSException(java.lang.String)">AFSException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason)</CODE>
 156
 157 <BR>
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSException</code> with the specified detail
 159  message.</TD>
 160 </TR>
 161 <TR BGCOLOR="white" CLASS="TableRowColor">
 162 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#AFSException(java.lang.String, int)">AFSException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason,
 163              int&nbsp;errno)</CODE>
 164
 165 <BR>
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSException</code> with the specified detail message
 167  and specified error code.  </TD>
 168 </TR>
 169 </TABLE>
 170 &nbsp;
 171 <!-- ========== METHOD SUMMARY =========== -->
 172
 173 <A NAME="method_summary"><!-- --></A>
 174 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 175 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 176 <TD COLSPAN=2><FONT SIZE="+2">
 177 <B>Method Summary</B></FONT></TD>
 178 </TR>
 179 <TR BGCOLOR="white" CLASS="TableRowColor">
 180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 181 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 182 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#getAFSMessage()">getAFSMessage</A></B>()</CODE>
 183
 184 <BR>
 185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message string defined by the <code>ErrorTable
 186  </code> class.  </TD>
 187 </TR>
 188 <TR BGCOLOR="white" CLASS="TableRowColor">
 189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 190 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 191 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.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>
 192
 193 <BR>
 194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message defined by the <code>ErrorTable</code>
 195  class.  </TD>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 199 <CODE>&nbsp;int</CODE></FONT></TD>
 200 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
 201
 202 <BR>
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS specific error number (code).  </TD>
 204 </TR>
 205 <TR BGCOLOR="white" CLASS="TableRowColor">
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 207 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 208 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#getMessage()">getMessage</A></B>()</CODE>
 209
 210 <BR>
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the error message string of this exception.</TD>
 212 </TR>
 213 <TR BGCOLOR="white" CLASS="TableRowColor">
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 215 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 216 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.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>
 217
 218 <BR>
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the locale specific error message string of this exception.</TD>
 220 </TR>
 221 <TR BGCOLOR="white" CLASS="TableRowColor">
 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 223 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 224 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSException.html#toString()">toString</A></B>()</CODE>
 225
 226 <BR>
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this AFS Exception.
 228
 229  </TD>
 230 </TR>
 231 </TABLE>
 232 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
 233 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 234 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 235 <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>
 236 </TR>
 237 <TR BGCOLOR="white" CLASS="TableRowColor">
 238 <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>
 239 </TR>
 240 </TABLE>
 241 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 242 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 243 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 244 <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>
 245 </TR>
 246 <TR BGCOLOR="white" CLASS="TableRowColor">
 247 <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>
 248 </TR>
 249 </TABLE>
 250 &nbsp;
 251 <P>
 252
 253 <!-- ============ FIELD DETAIL =========== -->
 254
 255 <A NAME="field_detail"><!-- --></A>
 256 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 257 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 258 <TD COLSPAN=1><FONT SIZE="+2">
 259 <B>Field Detail</B></FONT></TD>
 260 </TR>
 261 </TABLE>
 262
 263 <A NAME="errno"><!-- --></A><H3>
 264 errno</H3>
 265 <PRE>
 266 protected int <B>errno</B></PRE>
 267 <DL>
 268 <DD>The AFS specific error number (code).
 269 <P>
 270 <DL>
 271 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSException.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></DL>
 272 </DL>
 273
 274 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 275
 276 <A NAME="constructor_detail"><!-- --></A>
 277 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 278 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 279 <TD COLSPAN=1><FONT SIZE="+2">
 280 <B>Constructor Detail</B></FONT></TD>
 281 </TR>
 282 </TABLE>
 283
 284 <A NAME="AFSException(java.lang.String)"><!-- --></A><H3>
 285 AFSException</H3>
 286 <PRE>
 287 public <B>AFSException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason)</PRE>
 288 <DL>
 289 <DD>Constructs an <code>AFSException</code> with the specified detail
 290  message.
 291 <P>
 292 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.</DL>
 293 <HR>
 294
 295 <A NAME="AFSException(int)"><!-- --></A><H3>
 296 AFSException</H3>
 297 <PRE>
 298 public <B>AFSException</B>(int&nbsp;errno)</PRE>
 299 <DL>
 300 <DD>Constructs an <code>AFSException</code> with the specified error code.
 301  This constructor will also generate the appropriate error message
 302  respective to the specified error code.
 303 <P>
 304 <DT><B>Parameters:</B><DD><CODE>errno</CODE> - the AFS error number (error code).</DL>
 305 <HR>
 306
 307 <A NAME="AFSException(java.lang.String, int)"><!-- --></A><H3>
 308 AFSException</H3>
 309 <PRE>
 310 public <B>AFSException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason,
 311                     int&nbsp;errno)</PRE>
 312 <DL>
 313 <DD>Constructs an <code>AFSException</code> with the specified detail message
 314  and specified error code.  In this constructor the specified detail message
 315  overrides the default AFS error message defined by the
 316  <code>ErrorTable</code> class.  Therefore, to retrieve the AFS specific
 317  error message, you must use the <code><A HREF="../../../org/openafs/jafs/AFSException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></code> method.
 318  The <code><A HREF="../../../org/openafs/jafs/AFSException.html#getMessage()"><CODE>getMessage()</CODE></A></code> method will return the message specified
 319  in this constructor.
 320 <P>
 321 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.<DD><CODE>errno</CODE> - the AFS error number (error code).</DL>
 322
 323 <!-- ============ METHOD DETAIL ========== -->
 324
 325 <A NAME="method_detail"><!-- --></A>
 326 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 327 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 328 <TD COLSPAN=1><FONT SIZE="+2">
 329 <B>Method Detail</B></FONT></TD>
 330 </TR>
 331 </TABLE>
 332
 333 <A NAME="getErrorCode()"><!-- --></A><H3>
 334 getErrorCode</H3>
 335 <PRE>
 336 public int <B>getErrorCode</B>()</PRE>
 337 <DL>
 338 <DD>Returns the AFS specific error number (code).  This code can be interpreted
 339  by use of the <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code> class method
 340  <code><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></code>.
 341 <P>
 342 <DD><DL>
 343
 344 <DT><B>Returns:</B><DD>the AFS error code of this <code>AFSException</code>
 345           object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></DL>
 346 </DD>
 347 </DL>
 348 <HR>
 349
 350 <A NAME="getMessage()"><!-- --></A><H3>
 351 getMessage</H3>
 352 <PRE>
 353 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>()</PRE>
 354 <DL>
 355 <DD>Returns the error message string of this exception.
 356 <P>
 357 <DD><DL>
 358 <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>
 359 </DD>
 360 <DD><DL>
 361
 362 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
 363 </DD>
 364 </DL>
 365 <HR>
 366
 367 <A NAME="getMessage(java.util.Locale)"><!-- --></A><H3>
 368 getMessage</H3>
 369 <PRE>
 370 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>
 371 <DL>
 372 <DD>Returns the locale specific error message string of this exception.
 373 <P>
 374 <DD><DL>
 375 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
 376 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
 377 </DD>
 378 </DL>
 379 <HR>
 380
 381 <A NAME="getAFSMessage()"><!-- --></A><H3>
 382 getAFSMessage</H3>
 383 <PRE>
 384 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>()</PRE>
 385 <DL>
 386 <DD>Returns the AFS error message string defined by the <code>ErrorTable
 387  </code> class.  The message will be formatted according to the default
 388  Locale.
 389
 390  <P> This message is also available from this object's super class
 391  method <code>getMessage</code>. However, this method will always return
 392  the string message associated with the actual AFS error code/number
 393  specified, whereas the <A HREF="../../../org/openafs/jafs/AFSException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
 394  string message intended for this Exception object, which may be
 395  an overridden message defined in the constructor of this Exception.
 396 <P>
 397 <DD><DL>
 398
 399 <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/AFSException.html#getAFSMessage(java.util.Locale)"><CODE>getAFSMessage(Locale)</CODE></A>,
 400 <A HREF="../../../org/openafs/jafs/AFSException.html#AFSException(java.lang.String, int)"><CODE>AFSException(String, int)</CODE></A>,
 401 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A>,
 402 <CODE>Throwable.getMessage()</CODE></DL>
 403 </DD>
 404 </DL>
 405 <HR>
 406
 407 <A NAME="getAFSMessage(java.util.Locale)"><!-- --></A><H3>
 408 getAFSMessage</H3>
 409 <PRE>
 410 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>
 411 <DL>
 412 <DD>Returns the AFS error message defined by the <code>ErrorTable</code>
 413  class.  The message will be formatted according to the specified Locale.
 414
 415  <P> This message is also available from this object's super class
 416  method <code>getMessage</code>. However, this method will always return
 417  the string message associated with the actual AFS error code/number
 418  specified, whereas the <A HREF="../../../org/openafs/jafs/AFSException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
 419  string message intended for this Exception object, which may be
 420  an overridden message defined in the constructor of this Exception.
 421 <P>
 422 <DD><DL>
 423 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
 424 <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/AFSException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>,
 425 <A HREF="../../../org/openafs/jafs/AFSException.html#AFSException(java.lang.String, int)"><CODE>AFSException(String, int)</CODE></A>,
 426 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int, java.util.Locale)"><CODE>ErrorTable.getMessage(int, Locale)</CODE></A>,
 427 <CODE>Throwable.getMessage()</CODE></DL>
 428 </DD>
 429 </DL>
 430 <HR>
 431
 432 <A NAME="toString()"><!-- --></A><H3>
 433 toString</H3>
 434 <PRE>
 435 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
 436 <DL>
 437 <DD>Returns a string representation of this AFS Exception.
 438
 439  <P> The message will be formatted according to the specified Locale.
 440 <P>
 441 <DD><DL>
 442 <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>
 443 </DD>
 444 <DD><DL>
 445
 446 <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/AFSException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>,
 447 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A>,
 448 <CODE>Throwable.getMessage()</CODE></DL>
 449 </DD>
 450 </DL>
 451 <!-- ========= END OF CLASS DATA ========= -->
 452 <HR>
 453
 454 <!-- ========== START OF NAVBAR ========== -->
 455 <A NAME="navbar_bottom"><!-- --></A>
 456 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 457 <TR>
 458 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 459 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 460 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 461   <TR ALIGN="center" VALIGN="top">
 462   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 463   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 464   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AFSException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 465   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 466   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 467   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 468   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 469   </TR>
 470 </TABLE>
 471 </TD>
 472 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 473 <B>JAFS API v2</B></EM>
 474 </TD>
 475 </TR>
 476
 477 <TR>
 478 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 479 &nbsp;PREV CLASS&nbsp;
 480 &nbsp;<A HREF="../../../org/openafs/jafs/AFSFileException.html"><B>NEXT CLASS</B></A></FONT></TD>
 481 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 482   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 483 &nbsp;<A HREF="AFSException.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
 484 &nbsp;
 485 <SCRIPT>
 486   <!--
 487   if(window==top) {
 488     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
 489   }
 490   //-->
 491 </SCRIPT>
 492 <NOSCRIPT>
 493 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
 494 </NOSCRIPT>
 495 </FONT></TD>
 496 </TR>
 497 <TR>
 498 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 499   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>
 500 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 501 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>
 502 </TR>
 503 </TABLE>
 504 <!-- =========== END OF NAVBAR =========== -->
 505
 506 <HR>
 507
 508 </BODY>
 509 </HTML>