1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
\r
5 <!-- Generated by javadoc on Wed Apr 10 17:43:54 PDT 2002 -->
\r
7 Java AFS Admin API: Class AFSAdminException
\r
9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
11 <BODY BGCOLOR="white">
\r
13 <!-- ========== START OF NAVBAR ========== -->
\r
14 <A NAME="navbar_top"><!-- --></A>
\r
15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
\r
17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
18 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
\r
20 <TR ALIGN="center" VALIGN="top">
\r
21 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
22 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
23 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AFSAdminException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
24 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
25 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
26 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
27 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
31 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
32 <B>Java AFS Admin API v1.3</B></EM>
\r
37 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
38 PREV CLASS
\r
39 NEXT CLASS</FONT></TD>
\r
40 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
41 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
\r
42 <A HREF="AFSAdminException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
\r
45 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
46 SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
47 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
48 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
51 <!-- =========== END OF NAVBAR =========== -->
\r
54 <!-- ======== START OF CLASS DATA ======== -->
\r
57 org.openafs.jafsadm</FONT>
\r
59 Class AFSAdminException</H2>
\r
61 <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
\r
63 +--<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html">java.lang.Throwable</A>
\r
65 +--<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Exception.html">java.lang.Exception</A>
\r
67 +--<B>org.openafs.jafsadm.AFSAdminException</B>
\r
70 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/Serializable.html">Serializable</A></DD>
\r
74 <DT>public class <B>AFSAdminException</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Exception.html">Exception</A></DL>
\r
77 An exception indicating that an error has occured in the Java AFS
\r
78 Administrative API, in the Java AFS Administrative JNI, or in the
\r
82 <DT><B>Version: </B><DD>1.0, 6/29/01</DD>
\r
83 <DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.openafs.jafsadm.AFSAdminException">Serialized Form</A></DL>
\r
87 <!-- ======== INNER CLASS SUMMARY ======== -->
\r
90 <!-- =========== FIELD SUMMARY =========== -->
\r
93 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
95 <A NAME="constructor_summary"><!-- --></A>
\r
96 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
97 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
98 <TD COLSPAN=2><FONT SIZE="+2">
\r
99 <B>Constructor Summary</B></FONT></TD>
\r
101 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
102 <TD><CODE><B><A HREF="AFSAdminException.html#AFSAdminException(int)">AFSAdminException</A></B>(int errno)</CODE>
\r
105 Constructs a <code>AFSAdminException</code> with the specified error
\r
108 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
109 <TD><CODE><B><A HREF="AFSAdminException.html#AFSAdminException(java.lang.String)">AFSAdminException</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> message)</CODE>
\r
112 Constructs a <code>AFSAdminException</code> with the specified detail
\r
115 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
116 <TD><CODE><B><A HREF="AFSAdminException.html#AFSAdminException(java.lang.String, int)">AFSAdminException</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> message,
\r
117 int errno)</CODE>
\r
120 Constructs a <code>AFSAdminException</code> with the specified detail
\r
122 and specified error code.</TD>
\r
126 <!-- ========== METHOD SUMMARY =========== -->
\r
128 <A NAME="method_summary"><!-- --></A>
\r
129 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
131 <TD COLSPAN=2><FONT SIZE="+2">
\r
132 <B>Method Summary</B></FONT></TD>
\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
136 <CODE> int</CODE></FONT></TD>
\r
137 <TD><CODE><B><A HREF="AFSAdminException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
\r
140 Returns the AFS specific error code (number).</TD>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="AFSAdminException.html#getMessage()">getMessage</A></B>()</CODE>
\r
148 Returns the error message string of this Exception.</TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="AFSAdminException.html#toString()">toString</A></B>()</CODE>
\r
156 Returns a String representation of this AFS Exception.</TD>
\r
159 <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
\r
160 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
161 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
162 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html">Throwable</A></B></TD>
\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
165 <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#fillInStackTrace()">fillInStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#getLocalizedMessage()">getLocalizedMessage</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#printStackTrace()">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)">printStackTrace</A></CODE></TD>
\r
168 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
169 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
170 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
171 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
174 <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
\r
180 <!-- ============ FIELD DETAIL =========== -->
\r
183 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
185 <A NAME="constructor_detail"><!-- --></A>
\r
186 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
188 <TD COLSPAN=1><FONT SIZE="+2">
\r
189 <B>Constructor Detail</B></FONT></TD>
\r
193 <A NAME="AFSAdminException(java.lang.String)"><!-- --></A><H3>
\r
194 AFSAdminException</H3>
\r
196 public <B>AFSAdminException</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> message)</PRE>
\r
198 <DD>Constructs a <code>AFSAdminException</code> with the specified detail
\r
200 <DT><B>Parameters:</B><DD><CODE>message</CODE> - the detail message.</DL>
\r
205 <A NAME="AFSAdminException(int)"><!-- --></A><H3>
\r
206 AFSAdminException</H3>
\r
208 public <B>AFSAdminException</B>(int errno)</PRE>
\r
210 <DD>Constructs a <code>AFSAdminException</code> with the specified error
\r
212 <DT><B>Parameters:</B><DD><CODE>errno</CODE> - the AFS error code (error number).</DL>
\r
217 <A NAME="AFSAdminException(java.lang.String, int)"><!-- --></A><H3>
\r
218 AFSAdminException</H3>
\r
220 public <B>AFSAdminException</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> message,
\r
221 int errno)</PRE>
\r
223 <DD>Constructs a <code>AFSAdminException</code> with the specified detail
\r
225 and specified error code.<DD><DL>
\r
226 <DT><B>Parameters:</B><DD><CODE>message</CODE> - the detail message.<DD><CODE>errno</CODE> - the AFS error code (error number).</DL>
\r
230 <!-- ============ METHOD DETAIL ========== -->
\r
232 <A NAME="method_detail"><!-- --></A>
\r
233 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
\r
234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
235 <TD COLSPAN=1><FONT SIZE="+2">
\r
236 <B>Method Detail</B></FONT></TD>
\r
240 <A NAME="getErrorCode()"><!-- --></A><H3>
\r
243 public int <B>getErrorCode</B>()</PRE>
\r
245 <DD>Returns the AFS specific error code (number). This code can be used for
\r
246 numeric conditional handling or for indexing in a message catalog.<DD><DL>
\r
247 <DT><B>Returns:</B><DD>the AFS error code of this <code>AFSAdminException</code>
\r
253 <A NAME="getMessage()"><!-- --></A><H3>
\r
256 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>getMessage</B>()</PRE>
\r
258 <DD>Returns the error message string of this Exception. By default only the
\r
259 AFS error code (number) is returned returned by the system and used to
\r
260 construct this exception object, thus this method will render a simple
\r
261 string that reveals the AFS error code.
\r
263 <P> Example: "Message not available. Error code: 180484"<DD><DL>
\r
264 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#getMessage()">getMessage</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
\r
267 <DT><B>Returns:</B><DD>the error message string of this <code>AFSAdminException</code>
\r
268 object.<DT><B>See Also: </B><DD><A HREF="AFSAdminException.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></DL>
\r
273 <A NAME="toString()"><!-- --></A><H3>
\r
276 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
\r
278 <DD>Returns a String representation of this AFS Exception.
\r
280 <P> The message will be formatted according to the specified Locale.<DD><DL>
\r
281 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
\r
284 <DT><B>Returns:</B><DD>the AFS error message string of this
\r
285 <code>AFSAdminException</code> object.<DT><B>See Also: </B><DD><A HREF="AFSAdminException.html#getMessage()"><CODE>getMessage()</CODE></A></DL>
\r
288 <!-- ========= END OF CLASS DATA ========= -->
\r
291 <!-- ========== START OF NAVBAR ========== -->
\r
292 <A NAME="navbar_bottom"><!-- --></A>
\r
293 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
\r
295 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
296 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
297 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
\r
298 <TR ALIGN="center" VALIGN="top">
\r
299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
300 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AFSAdminException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
304 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
309 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
310 Java AFS Admin (jafsadm) API for OpenAFS</EM>
\r
315 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
316 PREV CLASS
\r
317 NEXT CLASS</FONT></TD>
\r
318 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
319 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
\r
320 <A HREF="AFSAdminException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
\r
323 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
324 SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
325 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
326 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
329 <!-- =========== END OF NAVBAR =========== -->
\r
332 <FONT FACE=Arial,Helvetica SIZE="1">Copyright (c) 2001-2002 International Business Machines Corp.<BR> All rights reserved.<BR> See <A HREF=copyright.html>copyright statement</A>.<BR></FONT>
\r