SAXException

AI-generated Key Takeaways

• SAXException is a class used to encapsulate general SAX errors or warnings that may arise during XML processing.

• It can wrap existing exceptions, providing a way to handle various error types within the SAX framework.

• SAXParseException, a subclass of SAXException, provides additional functionality for including location information about errors or warnings within an XML document.

• SAX handlers and applications can utilize SAXException and its subclasses to manage and communicate exceptional conditions during XML parsing.

• The class offers methods to retrieve the embedded exception, detail message, and a string representation of the exception for debugging and error reporting purposes.

public class SAXException extends Exception

Known Direct Subclasses SAXNotRecognizedException, SAXNotSupportedException, SAXParseException SAXNotRecognizedException Exception class for an unrecognized identifier.  SAXNotSupportedException Exception class for an unsupported operation.  SAXParseException Encapsulate an XML parse error or warning.

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.

See Also

• SAXParseException

Public Constructor Summary

	SAXException() Create a new SAXException.
	SAXException(String message) Create a new SAXException.
	SAXException(Exception e) Create a new SAXException wrapping an existing exception.
	SAXException(String message, Exception e) Create a new SAXException from an existing exception.

Public Method Summary

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.

Inherited Method Summary

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized 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 printStackTrace().
synchronized 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.
synchronized 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(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public SAXException ()

Create a new SAXException.

public SAXException (String message)

Create a new SAXException.

Parameters

message	The error or warning message.

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.

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.

Public Methods

public Exception getException ()

Return the embedded exception, if any.

Returns

• The embedded exception, or null if there is none.

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.

Returns

• The error or warning message.

public String toString ()

Override toString to pick up any embedded exception.

Returns

• A string representation of this exception.