1 // SAX exception class.
2 // http://www.saxproject.org
3 // No warranty; no copyright -- use this as you will.
4 // $Id: SAXException.java,v 1.7 2002/01/30 21:13:48 dbrownell Exp $
9 * Encapsulate a general SAX error or warning.
12 * <em>This module, both source code and documentation, is in the
13 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
14 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
15 * for further information.
18 * <p>This class can contain basic error or warning information from
19 * either the XML parser or the application: a parser writer or
20 * application writer can subclass it to provide additional
21 * functionality. SAX handlers may throw this exception or
22 * any exception subclassed from it.</p>
24 * <p>If the application needs to pass through other types of
25 * exceptions, it must wrap those exceptions in a SAXException
26 * or an exception derived from a SAXException.</p>
28 * <p>If the parser or application needs to include information about a
29 * specific location in an XML document, it should use the
30 * {@link org.xml.sax.SAXParseException SAXParseException} subclass.</p>
33 * @author David Megginson
34 * @version 2.0.1 (sax2r2)
35 * @see org.xml.sax.SAXParseException
37 public class SAXException extends Exception {
41 * Create a new SAXException.
43 public SAXException ()
46 this.exception = null;
51 * Create a new SAXException.
53 * @param message The error or warning message.
55 public SAXException (String message) {
57 this.exception = null;
62 * Create a new SAXException wrapping an existing exception.
64 * <p>The existing exception will be embedded in the new
65 * one, and its message will become the default message for
66 * the SAXException.</p>
68 * @param e The exception to be wrapped in a SAXException.
70 public SAXException (Exception e)
78 * Create a new SAXException from an existing exception.
80 * <p>The existing exception will be embedded in the new
81 * one, but the new exception will have its own message.</p>
83 * @param message The detail message.
84 * @param e The exception to be wrapped in a SAXException.
86 public SAXException (String message, Exception e)
94 * Return a detail message for this exception.
96 * <p>If there is an embedded exception, and if the SAXException
97 * has no detail message of its own, this method will return
98 * the detail message from the embedded exception.</p>
100 * @return The error or warning message.
103 public String getMessage ()
105 String message = super.getMessage();
107 if (message == null && exception != null) {
108 return exception.getMessage();
116 * Return the embedded exception, if any.
118 * @return The embedded exception, or null if there is none.
120 public Exception getException ()
127 * Override toString to pick up any embedded exception.
129 * @return A string representation of this exception.
132 public String toString ()
134 if (exception != null) {
135 return exception.toString();
137 return super.toString();
143 //////////////////////////////////////////////////////////////////////
145 //////////////////////////////////////////////////////////////////////
149 * @serial The embedded exception if tunnelling, or null.
151 private Exception exception;
155 // end of SAXException.java