Class XMLException

  • All Implemented Interfaces:
    java.io.Serializable

    public class XMLException
    extends java.lang.RuntimeException
    This class encapsulates a general XML error or warning.

    This class can contain basic error or warning information from either the parser or the application.

    If the application needs to pass through other types of exceptions, it must wrap those exceptions in a XMLException.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.Exception exception  
    • Constructor Summary

      Constructors 
      Constructor Description
      XMLException​(java.lang.Exception e)
      Creates a new XMLException wrapping an existing exception.
      XMLException​(java.lang.String message)
      Creates a new XMLException.
      XMLException​(java.lang.String message, java.lang.Exception e)
      Creates a new XMLException from an existing exception.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Exception getException()
      Return the embedded exception, if any.
      java.lang.String getMessage()
      Return a detail message for this exception.
      void printStackTrace()
      Prints this Exception and its backtrace to the standard error stream.
      void printStackTrace​(java.io.PrintStream s)
      Prints this Exception and its backtrace to the specified print stream.
      void printStackTrace​(java.io.PrintWriter s)
      Prints this Exception and its backtrace to the specified print writer.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • exception

        protected java.lang.Exception exception
    • Constructor Detail

      • XMLException

        public XMLException​(java.lang.String message)
        Creates a new XMLException.
        Parameters:
        message - The error or warning message.
      • XMLException

        public XMLException​(java.lang.Exception e)
        Creates a new XMLException wrapping an existing exception.

        The existing exception will be embedded in the new one, and its message will become the default message for the XMLException.

        Parameters:
        e - The exception to be wrapped in a XMLException.
      • XMLException

        public XMLException​(java.lang.String message,
                            java.lang.Exception e)
        Creates a new XMLException 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 a embedded exception, and if the XMLException 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.
      • printStackTrace

        public void printStackTrace()
        Prints this Exception and its backtrace to the standard error stream.
        Overrides:
        printStackTrace in class java.lang.Throwable
      • printStackTrace

        public void printStackTrace​(java.io.PrintStream s)
        Prints this Exception and its backtrace to the specified print stream.
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        s - PrintStream to use for output
      • printStackTrace

        public void printStackTrace​(java.io.PrintWriter s)
        Prints this Exception and its backtrace to the specified print writer.
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        s - PrintWriter to use for output