org.xml.sax
Class SAXException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.xml.sax.SAXException
Direct Known Subclasses:
SAXNotRecognizedException, SAXNotSupportedException, SAXParseException

public class SAXException
extends Exception

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.

Since:
SAX 1.0
See Also:
SAXParseException

Constructor Summary
SAXException()
          Create a new SAXException.
SAXException(Exception e)
          Create a new SAXException wrapping an existing exception.
SAXException(String message)
          Create a new SAXException.
SAXException(String message, Exception e)
          Create a new SAXException from an existing exception.
 
Method Summary
 Exception getException()
          Return the embedded exception, if any.
 String getMessage()
          Return a detail message for this exception.
 String toString()
          Override toString to pick up any embedded exception.
 
Methods inherited from class java.lang.Throwable
printStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SAXException

public SAXException()
Create a new SAXException.
Since:
JDE 4.3.0

SAXException

public SAXException(Exception e)
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.

Parameters:
e - The exception to be wrapped in a SAXException.
Since:
JDE 4.3.0

SAXException

public SAXException(String message)
Create a new SAXException.
Parameters:
message - The error or warning message.
Since:
JDE 4.0.0

SAXException

public SAXException(String message,
                    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.

Parameters:
message - The detail message.
e - The exception to be wrapped in a SAXException.
Since:
JDE 4.3.0
Method Detail

getException

public Exception getException()
Return the embedded exception, if any.
Returns:
The embedded exception, or null if there is none.
Since:
JDE 4.3.0

getMessage

public String getMessage()
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.

Overrides:
getMessage in class Throwable
Returns:
The error or warning message.
Since:
JDE 4.3.0

toString

public String toString()
Override toString to pick up any embedded exception.
Overrides:
toString in class Throwable
Returns:
A string representation of this exception.
Since:
JDE 4.3.0



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.