Class SAXException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.xml.sax.SAXException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SAXNotRecognizedException, SAXNotSupportedException, SAXParseException
public class SAXException extends Exception
Encapsulate a general SAX error or warning.

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
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    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

    Modifier and Type
    Method
    Description
    Throwable
    getCause()
    Return the cause of the exception
    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 declared in class Throwable

    addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
    Modifier and Type
    Method
    Description
    final void
    addSuppressed(Throwable exception)
    The specified exception is going to be suppressed in order to give priority to this exception (primary exception) and to be appended to the list of suppressed exceptions.
    Throwable
    fillInStackTrace()
    Record in the receiver a walkback from the point where this message was sent.
    String
    getLocalizedMessage()
    Answers the extra information message which was provided when the throwable was created.
    StackTraceElement[]
    getStackTrace()
    Answers an array of StackTraceElement.
    final Throwable[]
    getSuppressed()
    Returns an array of exceptions suppressed, typically by the automatically generated code from the try-with-resources statement, in order to give priority to this exception (primary exception).
    Throwable
    initCause(Throwable throwable)
    Initialize the cause of the receiver.
    void
    printStackTrace()
    Outputs a printable representation of the receiver's walkback on the System.err stream.
    void
    printStackTrace(PrintStream err)
    Outputs a printable representation of the receiver's walkback on the stream specified by the argument.
    void
    printStackTrace(PrintWriter err)
    Outputs a printable representation of the receiver's walkback on the writer specified by the argument.
    void
    setStackTrace(StackTraceElement[] trace)
    Sets the array of StackTraceElements.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

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

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