Added in API level 1

SAXParseException

public class SAXParseException
extends SAXException

java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ org.xml.sax.SAXException
         ↳ org.xml.sax.SAXParseException


Encapsulate an XML parse 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 exception may include information for locating the error in the original XML document, as if it came from a Locator object. Note that although the application will receive a SAXParseException as the argument to the handlers in the ErrorHandler interface, the application is not actually required to throw the exception; instead, it can simply read the information in it and take a different action.

Since this exception is a subclass of SAXException, it inherits the ability to wrap another exception.

Summary

Public constructors

SAXParseException(String message, String publicId, String systemId, int lineNumber, int columnNumber)

Create a new SAXParseException.

SAXParseException(String message, String publicId, String systemId, int lineNumber, int columnNumber, Exception e)

Create a new SAXParseException with an embedded exception.

SAXParseException(String message, Locator locator)

Create a new SAXParseException from a message and a Locator.

SAXParseException(String message, Locator locator, Exception e)

Wrap an existing exception in a SAXParseException.

Public methods

int getColumnNumber()

The column number of the end of the text where the exception occurred.

int getLineNumber()

The line number of the end of the text where the exception occurred.

String getPublicId()

Get the public identifier of the entity where the exception occurred.

String getSystemId()

Get the system identifier of the entity where the exception occurred.

Inherited methods

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.

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

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the 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.

String toString()

Returns a string representation of the object.

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.

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()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

SAXParseException

Added in API level 1
public SAXParseException (String message, 
                String publicId, 
                String systemId, 
                int lineNumber, 
                int columnNumber)

Create a new SAXParseException.

This constructor is most useful for parser writers.

All parameters except the message are as if they were provided by a Locator. For example, if the system identifier is a URL (including relative filename), the caller must resolve it fully before creating the exception.

Parameters
message String: The error or warning message.

publicId String: The public identifier of the entity that generated the error or warning.

systemId String: The system identifier of the entity that generated the error or warning.

lineNumber int: The line number of the end of the text that caused the error or warning.

columnNumber int: The column number of the end of the text that cause the error or warning.

SAXParseException

Added in API level 1
public SAXParseException (String message, 
                String publicId, 
                String systemId, 
                int lineNumber, 
                int columnNumber, 
                Exception e)

Create a new SAXParseException with an embedded exception.

This constructor is most useful for parser writers who need to wrap an exception that is not a subclass of SAXException.

All parameters except the message and exception are as if they were provided by a Locator. For example, if the system identifier is a URL (including relative filename), the caller must resolve it fully before creating the exception.

Parameters
message String: The error or warning message, or null to use the message from the embedded exception.

publicId String: The public identifier of the entity that generated the error or warning.

systemId String: The system identifier of the entity that generated the error or warning.

lineNumber int: The line number of the end of the text that caused the error or warning.

columnNumber int: The column number of the end of the text that cause the error or warning.

e Exception: Another exception to embed in this one.

SAXParseException

Added in API level 1
public SAXParseException (String message, 
                Locator locator)

Create a new SAXParseException from a message and a Locator.

This constructor is especially useful when an application is creating its own exception from within a ContentHandler callback.

Parameters
message String: The error or warning message.

locator Locator: The locator object for the error or warning (may be null).

See also:

SAXParseException

Added in API level 1
public SAXParseException (String message, 
                Locator locator, 
                Exception e)

Wrap an existing exception in a SAXParseException.

This constructor is especially useful when an application is creating its own exception from within a ContentHandler callback, and needs to wrap an existing exception that is not a subclass of SAXException.

Parameters
message String: The error or warning message, or null to use the message from the embedded exception.

locator Locator: The locator object for the error or warning (may be null).

e Exception: Any exception.

See also:

Public methods

getColumnNumber

Added in API level 1
public int getColumnNumber ()

The column number of the end of the text where the exception occurred.

The first column in a line is position 1.

Returns
int An integer representing the column number, or -1 if none is available.

getLineNumber

Added in API level 1
public int getLineNumber ()

The line number of the end of the text where the exception occurred.

The first line is line 1.

Returns
int An integer representing the line number, or -1 if none is available.

getPublicId

Added in API level 1
public String getPublicId ()

Get the public identifier of the entity where the exception occurred.

Returns
String A string containing the public identifier, or null if none is available.

getSystemId

Added in API level 1
public String getSystemId ()

Get the system identifier of the entity where the exception occurred.

If the system identifier is a URL, it will have been resolved fully.

Returns
String A string containing the system identifier, or null if none is available.