// SAX exception class.
// http://www.saxproject.org
// No warranty; no copyright -- use this as you will.
// $Id: SAXException.java 226184 2005-04-08 10:53:24Z neeraj $

package org.xml.sax;

Encapsulate a general SAX error or warning.

This module, both source code and documentation, is in the
Public Domain, and comes with NO WARRANTY.
See http://www.saxproject.org
for further information.

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.
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.
If the parser or application needs to include information about a specific location in an XML document, it should use the SAXParseException subclass.
Author:
David Megginson
See Also:
SAXParseException
Since:
SAX 1.0
Version:
2.0.1 (sax2r2)/**
 * 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>
 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
 * for further information.
 * </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
 * @version 2.0.1 (sax2r2)
 * @see org.xml.sax.SAXParseException
 */
public class SAXException extends Exception {


    
Create a new SAXException.
/**
     * Create a new SAXException.
     */
    public SAXException ()
    {
	super();
	this.exception = null;
    }
    
    
    
Create a new SAXException.
Params:
message – The error or warning message./**
     * Create a new SAXException.
     *
     * @param message The error or warning message.
     */
    public SAXException (String message) {
	super(message);
	this.exception = null;
    }
    
    
    
Create a new SAXException wrapping an existing exception.
The existing exception will be embedded in the new
one, and its message will become the default message for
the SAXException.
Params:
e – The exception to be wrapped in a SAXException./**
     * 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.
The existing exception will be embedded in the new
one, but the new exception will have its own message.
Params:
message – The detail message.
e – The exception to be wrapped in a SAXException./**
     * 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.
     */
    public SAXException (String message, Exception e)
    {
	super(message);
	this.exception = e;
    }
    
    
    
Return a detail message for this exception.
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.
Returns:
The error or warning message./**
     * 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.
     */
    public String getMessage ()
    {
	String message = super.getMessage();
	
	if (message == null && exception != null) {
	    return exception.getMessage();
	} else {
	    return message;
	}
    }
    
    
    
Return the embedded exception, if any.
Returns:
The embedded exception, or null if there is none./**
     * 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.
Returns:
A string representation of this 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./**
     * @serial The embedded exception if tunnelling, or null.
     */    
    private Exception exception;
    
    // Added serialVersionUID to preserve binary compatibility 
    static final long serialVersionUID = 583241635256073760L;
}

// end of SAXException.java