org.xml.sax
Class SAXException

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

public class SAXException
extends java.lang.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.

This is ARP specific documentation, for the general SAX documentation try the Xerces copy.

In ARP, three subclasses of SAXException are used.

SAXException
Used both in RDF and XML processing, to report non location specific errors by being thrown into user code; may be used to wrap some other exception.
SAXParseException
Used in XML processing, to report location specific parse errors typically by calling an error handler.
ParseException
Used in RDF processing, to report location specific parse errors typically by calling an error handler.

When using instanceof to distinguish these note that ParseException is a subclass of SAXParseException.

A SAXException may be created by an ARP user, to be an exception thrown by an ErrorHandler. Such an exception is not consumed by the ARP code, but reappears in user code thrown from ARP.load.

subclass.

Since:
SAX 1.0
See Also:
SAXParseException, Serialized Form

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

Constructor Detail

SAXException

public SAXException(java.lang.String message)
Create a new SAXException.
Parameters:
message - The error or warning message.

SAXException

public SAXException(java.lang.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.

SAXException

public SAXException(java.lang.String message,
                    java.lang.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.
Method Detail

getMessage

public java.lang.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 java.lang.Throwable
Returns:
The error or warning message.

getException

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

toString

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