nu.xom

## Class XMLException

- Object
- - Throwable
  - - Exception
    - - RuntimeException
      - - nu.xom.XMLException

- All Implemented Interfaces:
    Serializable
  Direct Known Subclasses:
    NoSuchAttributeException, NoSuchChildException, UnavailableCharacterException, WellformednessException

      public class XMLException
      extends RuntimeException

  The generic superclass for most runtime exceptions thrown in `nu.xom`. The general principle followed is that anything that can normally be detected by testing such as using spaces in an element name is a runtime exception. Exceptions that depend on environmental conditions, such as might occur when parsing an external file, are checked exceptions, because these depend on variable input, and thus all problems may not be detected during testing.

  Version:
    1.1b3
  Author:
    Elliotte Rusty Harold
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `XMLException(String message)` Creates a new `XMLException` with the specified detail message.
    `XMLException(String message, Throwable cause)` Creates a new `XMLException` with the specified detail message and an underlying root cause.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Throwable` | `getCause()` Return the original cause that led to this exception, or null if there was no original exception.
    `Throwable` | `initCause(Throwable cause)` Sets the root cause of this exception.

    - ### Methods inherited from class Throwable

      `addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

    - ### Methods inherited from class Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### XMLException

          public XMLException(String message,
                              Throwable cause)

      Creates a new `XMLException` with the specified detail message and an underlying root cause.

      Parameters:
        `message` - information about the cause of the exception
        `cause` - the nested exception that caused this exception

    - #### XMLException

          public XMLException(String message)

      Creates a new `XMLException` with the specified detail message.

      Parameters:
        `message` - information about the cause of the exception

  - ### Method Detail

    - #### getCause

          public Throwable getCause()

      Return the original cause that led to this exception, or null if there was no original exception.

      Overrides:
        `getCause` in class `Throwable`
      Returns:
        the root cause of this exception

    - #### initCause

          public final Throwable initCause(Throwable cause)

      Sets the root cause of this exception. This may only be called once. Subsequent calls throw an `IllegalStateException`.

      This method is unnecessary in Java 1.4 where it could easily be inherited from the superclass. However, including it here allows this method to be used in Java 1.3 and earlier.

      Overrides:
        `initCause` in class `Throwable`
      Parameters:
        `cause` - the root cause of this exception
      Returns:
        this `XMLException`
      Throws:
        `IllegalArgumentException` - if the cause is this exception (An exception cannot be its own cause.)
        `IllegalStateException` - if this method is called twice

Copyright 2002-2020 Elliotte Rusty Harold
elharo@ibiblio.org