org.xml.sax: public class: SAXParseException

org.xml.sax
public class: SAXParseException [javadoc | source]

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

All Implemented Interfaces:
Serializable

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.

Also see:

org.xml.sax.SAXException

org.xml.sax.Locator

org.xml.sax.ErrorHandler

since: SAX - 1.0

author: David - Megginson

version: 2.0.1 - (sax2r2)

Field Summary
static final long	serialVersionUID

Fields inherited from org.xml.sax.SAXException:
serialVersionUID

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public SAXParseException(String message, Locator locator) { super(message); if (locator != null) { init(locator.getPublicId(), locator.getSystemId(), locator.getLineNumber(), locator.getColumnNumber()); } else { init(null, null, -1, -1); } } 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` - The error or warning message. `locator` - The locator object for the error or warning (may be null). Also see: org.xml.sax.Locator
public SAXParseException(String message, Locator locator, Exception e) { super(message, e); if (locator != null) { init(locator.getPublicId(), locator.getSystemId(), locator.getLineNumber(), locator.getColumnNumber()); } else { init(null, null, -1, -1); } } 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` - The error or warning message, or null to use the message from the embedded exception. `locator` - The locator object for the error or warning (may be null). `e` - Any exception. Also see: org.xml.sax.Locator
public SAXParseException(String message, String publicId, String systemId, int lineNumber, int columnNumber) { super(message); init(publicId, systemId, lineNumber, 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` - The error or warning message. `publicId` - The public identifier of the entity that generated the error or warning. `systemId` - The system identifier of the entity that generated the error or warning. `lineNumber` - The line number of the end of the text that caused the error or warning. `columnNumber` - The column number of the end of the text that cause the error or warning.
public SAXParseException(String message, String publicId, String systemId, int lineNumber, int columnNumber, Exception e) { super(message, e); init(publicId, systemId, lineNumber, columnNumber); } 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` - The error or warning message, or null to use the message from the embedded exception. `publicId` - The public identifier of the entity that generated the error or warning. `systemId` - The system identifier of the entity that generated the error or warning. `lineNumber` - The line number of the end of the text that caused the error or warning. `columnNumber` - The column number of the end of the text that cause the error or warning. `e` - Another exception to embed in this one.

 public SAXParseException(String message,
    Locator locator) {
	super(message);
	if (locator != null) {
	    init(locator.getPublicId(), locator.getSystemId(),
		 locator.getLineNumber(), locator.getColumnNumber());
	} else {
	    init(null, null, -1, -1);
	}
}

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

Parameters:

message - The error or warning message.

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

Also see:

org.xml.sax.Locator

 public SAXParseException(String message,
    Locator locator,
    Exception e) {
	super(message, e);
	if (locator != null) {
	    init(locator.getPublicId(), locator.getSystemId(),
		 locator.getLineNumber(), locator.getColumnNumber());
	} else {
	    init(null, null, -1, -1);
	}
}

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 - The error or warning message, or null to use the message from the embedded exception.

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

e - Any exception.

Also see:

org.xml.sax.Locator

 public SAXParseException(String message,
    String publicId,
    String systemId,
    int lineNumber,
    int columnNumber) {
	super(message);
	init(publicId, systemId, lineNumber, columnNumber);
}

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 - The error or warning message.

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

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

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

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

 public SAXParseException(String message,
    String publicId,
    String systemId,
    int lineNumber,
    int columnNumber,
    Exception e) {
	super(message, e);
	init(publicId, systemId, lineNumber, columnNumber);
}

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 - The error or warning message, or null to use the message from the embedded exception.

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

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

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

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

e - Another exception to embed in this one.

Method from org.xml.sax.SAXParseException Summary:
getColumnNumber, getLineNumber, getPublicId, getSystemId

Methods from org.xml.sax.SAXException:
getException, getMessage, toString

Methods from java.lang.Throwable:
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.xml.sax.SAXParseException Detail:
public int getColumnNumber() { return this.columnNumber; } The column number of the end of the text where the exception occurred. The first column in a line is position 1.
public int getLineNumber() { return this.lineNumber; } The line number of the end of the text where the exception occurred. The first line is line 1.
public String getPublicId() { return this.publicId; } Get the public identifier of the entity where the exception occurred.
public String getSystemId() { return this.systemId; } Get the system identifier of the entity where the exception occurred. If the system identifier is a URL, it will have been resolved fully.

Method from org.xml.sax.SAXParseException Detail:

 public int getColumnNumber() {
	return this.columnNumber;
}

The first column in a line is position 1.

 public int getLineNumber() {
	return this.lineNumber;
}

The first line is line 1.

 public String getPublicId() {
	return this.publicId;
}

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

 public String getSystemId() {
	return this.systemId;
}

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