| // SAX exception class. |
| // No warranty; no copyright -- use this as you will. |
| // $Id$ |
| |
| package org.xml.sax; |
| |
| /** |
| * Encapsulate a general SAX error or warning. |
| * |
| * <blockquote> |
| * <em>This module, both source code and documentation, is in the |
| * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> |
| * </blockquote> |
| * |
| * <p>This class can contain basic error or warning information from |
| * either the XML parser or the application: a parser writer or |
| * application writer can subclass it to provide additional |
| * functionality. SAX handlers may throw this exception or |
| * any exception subclassed from it.</p> |
| * |
| * <p>If the application needs to pass through other types of |
| * exceptions, it must wrap those exceptions in a SAXException |
| * or an exception derived from a SAXException.</p> |
| * |
| * <p>If the parser or application needs to include information about a |
| * specific location in an XML document, it should use the |
| * {@link org.xml.sax.SAXParseException SAXParseException} subclass.</p> |
| * |
| * @since SAX 1.0 |
| * @author David Megginson, |
| * <a href="mailto:sax@megginson.com">sax@megginson.com</a> |
| * @version 2.0 |
| * @see org.xml.sax.SAXParseException |
| */ |
| public class SAXException extends Exception { |
| |
| |
| /** |
| * Create a new SAXException. |
| * |
| * @param message The error or warning message. |
| * @see org.xml.sax.Parser#setLocale |
| */ |
| public SAXException (String message) { |
| super(message); |
| this.exception = null; |
| } |
| |
| |
| /** |
| * Create a new SAXException wrapping an existing exception. |
| * |
| * <p>The existing exception will be embedded in the new |
| * one, and its message will become the default message for |
| * the SAXException.</p> |
| * |
| * @param e The exception to be wrapped in a SAXException. |
| */ |
| public SAXException (Exception e) |
| { |
| super(); |
| this.exception = e; |
| } |
| |
| |
| /** |
| * Create a new SAXException from an existing exception. |
| * |
| * <p>The existing exception will be embedded in the new |
| * one, but the new exception will have its own message.</p> |
| * |
| * @param message The detail message. |
| * @param e The exception to be wrapped in a SAXException. |
| * @see org.xml.sax.Parser#setLocale |
| */ |
| public SAXException (String message, Exception e) |
| { |
| super(message); |
| this.exception = e; |
| } |
| |
| |
| /** |
| * Return a detail message for this exception. |
| * |
| * <p>If there is an embedded exception, and if the SAXException |
| * has no detail message of its own, this method will return |
| * the detail message from the embedded exception.</p> |
| * |
| * @return The error or warning message. |
| * @see org.xml.sax.Parser#setLocale |
| */ |
| public String getMessage () |
| { |
| String message = super.getMessage(); |
| |
| if (message == null && exception != null) { |
| return exception.getMessage(); |
| } else { |
| return message; |
| } |
| } |
| |
| |
| /** |
| * Return the embedded exception, if any. |
| * |
| * @return The embedded exception, or null if there is none. |
| */ |
| public Exception getException () |
| { |
| return exception; |
| } |
| |
| |
| /** |
| * Override toString to pick up any embedded exception. |
| * |
| * @return A string representation of this exception. |
| */ |
| public String toString () |
| { |
| if (exception != null) { |
| return exception.toString(); |
| } else { |
| return super.toString(); |
| } |
| } |
| |
| |
| |
| ////////////////////////////////////////////////////////////////////// |
| // Internal state. |
| ////////////////////////////////////////////////////////////////////// |
| |
| |
| /** |
| * @serial The embedded exception if tunnelling, or null. |
| */ |
| private Exception exception; |
| |
| } |
| |
| // end of SAXException.java |