| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Thu Aug 23 18:22:32 PDT 2001 --> |
| <TITLE> |
| : Class ServletException |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../javax/servlet/UnavailableException.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="ServletException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.servlet</FONT> |
| <BR> |
| Class ServletException</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--java.lang.Throwable |
| | |
| +--java.lang.Exception |
| | |
| +--<B>javax.servlet.ServletException</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../javax/servlet/UnavailableException.html">UnavailableException</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>ServletException</B><DT>extends java.lang.Exception</DL> |
| |
| <P> |
| Defines a general exception a servlet can throw when it |
| encounters difficulty. |
| <P> |
| <DL> |
| <DT><B>See Also: </B><DD><A HREF="../../serialized-form.html#javax.servlet.ServletException">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/servlet/ServletException.html#ServletException()">ServletException</A></B>()</CODE> |
| |
| <BR> |
| Constructs a new servlet exception.</TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/servlet/ServletException.html#ServletException(java.lang.String)">ServletException</A></B>(java.lang.String message)</CODE> |
| |
| <BR> |
| Constructs a new servlet exception with the |
| specified message.</TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/servlet/ServletException.html#ServletException(java.lang.String, java.lang.Throwable)">ServletException</A></B>(java.lang.String message, |
| java.lang.Throwable rootCause)</CODE> |
| |
| <BR> |
| Constructs a new servlet exception when the servlet |
| needs to throw an exception and include a message |
| about the "root cause" exception that interfered with its |
| normal operation, including a description message.</TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/servlet/ServletException.html#ServletException(java.lang.Throwable)">ServletException</A></B>(java.lang.Throwable rootCause)</CODE> |
| |
| <BR> |
| Constructs a new servlet exception when the servlet |
| needs to throw an exception and include a message |
| about the "root cause" exception that interfered with its |
| normal operation.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Throwable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/servlet/ServletException.html#getRootCause()">getRootCause</A></B>()</CODE> |
| |
| <BR> |
| Returns the exception that caused this servlet exception.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Throwable</B></TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE>fillInStackTrace, |
| getLocalizedMessage, |
| getMessage, |
| printStackTrace, |
| printStackTrace, |
| printStackTrace, |
| toString</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" ID="TableRowColor"> |
| <TD><CODE>clone, |
| equals, |
| finalize, |
| getClass, |
| hashCode, |
| notify, |
| notifyAll, |
| wait, |
| wait, |
| wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ServletException()"><!-- --></A><H3> |
| ServletException</H3> |
| <PRE> |
| public <B>ServletException</B>()</PRE> |
| <DL> |
| <DD>Constructs a new servlet exception.</DL> |
| <HR> |
| |
| <A NAME="ServletException(java.lang.String)"><!-- --></A><H3> |
| ServletException</H3> |
| <PRE> |
| public <B>ServletException</B>(java.lang.String message)</PRE> |
| <DL> |
| <DD>Constructs a new servlet exception with the |
| specified message. The message can be written |
| to the server log and/or displayed for the user.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> |
| specifying the text of |
| the exception message</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="ServletException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3> |
| ServletException</H3> |
| <PRE> |
| public <B>ServletException</B>(java.lang.String message, |
| java.lang.Throwable rootCause)</PRE> |
| <DL> |
| <DD>Constructs a new servlet exception when the servlet |
| needs to throw an exception and include a message |
| about the "root cause" exception that interfered with its |
| normal operation, including a description message.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> containing |
| the text of the exception message<DD><CODE>rootCause</CODE> - the <code>Throwable</code> exception |
| that interfered with the servlet's |
| normal operation, making this servlet |
| exception necessary</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="ServletException(java.lang.Throwable)"><!-- --></A><H3> |
| ServletException</H3> |
| <PRE> |
| public <B>ServletException</B>(java.lang.Throwable rootCause)</PRE> |
| <DL> |
| <DD>Constructs a new servlet exception when the servlet |
| needs to throw an exception and include a message |
| about the "root cause" exception that interfered with its |
| normal operation. The exception's message is based on the localized |
| message of the underlying exception. |
| |
| <p>This method calls the <code>getLocalizedMessage</code> method |
| on the <code>Throwable</code> exception to get a localized exception |
| message. When subclassing <code>ServletException</code>, |
| this method can be overridden to create an exception message |
| designed for a specific locale.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>rootCause</CODE> - the <code>Throwable</code> exception |
| that interfered with the servlet's |
| normal operation, making the servlet exception |
| necessary</DL> |
| </DD> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getRootCause()"><!-- --></A><H3> |
| getRootCause</H3> |
| <PRE> |
| public java.lang.Throwable <B>getRootCause</B>()</PRE> |
| <DL> |
| <DD>Returns the exception that caused this servlet exception.<DD><DL> |
| <DT><B>Returns:</B><DD>the <code>Throwable</code> |
| that caused this servlet exception</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../javax/servlet/UnavailableException.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="ServletException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
