Class XMLStreamException

javax.xml.stream.XMLStreamException

All Implemented Interfaces:: Serializable

public class XMLStreamException extends Exception

The base exception for unexpected processing errors. This Exception class is used to report well-formedness errors as well as unexpected processing conditions.

Since:

1.6

See Also:

Field Summary

Modifier and Type	Field	Description
`protected Location`	`location`	The location of the error.
`protected Throwable`	`nested`	The nested exception.

Constructor Summary

Constructor	Description
`XMLStreamException()`	Default constructor
`XMLStreamException(String msg)`	Construct an exception with the associated message.
`XMLStreamException(String msg, Throwable th)`	Construct an exception with the associated message and exception
`XMLStreamException(String msg, Location location)`	Construct an exception with the associated message, exception and location.
`XMLStreamException(String msg, Location location, Throwable th)`	Construct an exception with the associated message, exception and location.
`XMLStreamException(Throwable th)`	Construct an exception with the associated exception

Method Summary

Modifier and Type	Method	Description
`Location`	`getLocation()`	Gets the location of the exception
`Throwable`	`getNestedException()`	Gets the nested exception.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Modifier and Type	Method	Description
`final void`	`addSuppressed(Throwable exception)`	Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()`	Fills in the execution stack trace.
`Throwable`	`getCause()`	Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
`String`	`getLocalizedMessage()`	Creates a localized description of this throwable.
`String`	`getMessage()`	Returns the detail message string of this throwable.
`StackTraceElement[]`	`getStackTrace()`	Provides programmatic access to the stack trace information printed by `Throwable.printStackTrace()`.
`final Throwable[]`	`getSuppressed()`	Returns an array containing all of the exceptions that were suppressed, typically by the `try`-with-resources statement, in order to deliver this exception.
`Throwable`	`initCause(Throwable cause)`	Initializes the cause of this throwable to the specified value.
`void`	`printStackTrace()`	Prints this throwable and its backtrace to the standard error stream.
`void`	`printStackTrace(PrintStream s)`	Prints this throwable and its backtrace to the specified print stream.
`void`	`printStackTrace(PrintWriter s)`	Prints this throwable and its backtrace to the specified print writer.
`void`	`setStackTrace(StackTraceElement[] stackTrace)`	Sets the stack trace elements that will be returned by `Throwable.getStackTrace()` and printed by `Throwable.printStackTrace()` and related methods.
`String`	`toString()`	Returns a short description of this throwable.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

nested

protected Throwable nested

The nested exception.

location

protected Location location

The location of the error.

Constructor Details

XMLStreamException

public XMLStreamException()

Default constructor

XMLStreamException

public XMLStreamException(String msg)

Construct an exception with the associated message.

Parameters:: msg - the message to report

XMLStreamException

public XMLStreamException(Throwable th)

Construct an exception with the associated exception

Parameters:: th - a nested exception

XMLStreamException

public XMLStreamException(String msg, Throwable th)

Construct an exception with the associated message and exception

Parameters:: msg - the message to report; th - a nested exception

XMLStreamException

public XMLStreamException(String msg, Location location, Throwable th)

Construct an exception with the associated message, exception and location.

Parameters:: msg - the message to report; location - the location of the error; th - a nested exception

XMLStreamException

public XMLStreamException(String msg, Location location)

Construct an exception with the associated message, exception and location.

Parameters:: msg - the message to report; location - the location of the error

Method Details

getNestedException

public Throwable getNestedException()

Gets the nested exception.

Returns:: Nested exception

getLocation

public Location getLocation()

Gets the location of the exception

Returns:: the location of the exception, may be null if none is available

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.