Module java.xml
Package org.xml.sax

Class SAXException

  • All Implemented Interfaces:
    Serializable
    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:
    1.4, SAX 1.0
    Version:
    2.0.1 (sax2r2)
    See Also:
    SAXParseException, Serialized Form

    • Constructor Detail

      • SAXException

        public SAXException​()
        Create a new SAXException.

      • SAXException

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

      • 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.

      • 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.

    • Method Detail

      • 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.

      • getException

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

      • getCause

        public Throwable getCause​()
        Return the cause of the exception
        Overrides:
        getCause in class Throwable
        Returns:
        Return the cause of the exception

      • toString

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