FileDocCategorySizeDatePackage
SAXParseException.javaAPI DocAndroid 1.5 API8910Wed May 06 22:41:06 BST 2009org.xml.sax

SAXParseException

public class SAXParseException extends SAXException
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 {@link Locator} object. Note that although the application will receive a SAXParseException as the argument to the handlers in the {@link org.xml.sax.ErrorHandler 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 {@link org.xml.sax.SAXException SAXException}, it inherits the ability to wrap another exception.

since
SAX 1.0
author
David Megginson
version
2.0.1 (sax2r2)
see
org.xml.sax.SAXException
see
org.xml.sax.Locator
see
org.xml.sax.ErrorHandler

Fields Summary
private String
publicId
private String
systemId
private int
lineNumber
private int
columnNumber
Constructors Summary
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 {@link org.xml.sax.ContentHandler ContentHandler} callback.

param
message The error or warning message.
param
locator The locator object for the error or warning (may be null).
see
org.xml.sax.Locator

    super(message);
    if (locator != null) {
        init(locator.getPublicId(), locator.getSystemId(),
         locator.getLineNumber(), locator.getColumnNumber());
    } else {
        init(null, null, -1, -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 {@link org.xml.sax.ContentHandler ContentHandler} callback, and needs to wrap an existing exception that is not a subclass of {@link org.xml.sax.SAXException SAXException}.

param
message The error or warning message, or null to use the message from the embedded exception.
param
locator The locator object for the error or warning (may be null).
param
e Any exception.
see
org.xml.sax.Locator

    super(message, e);
    if (locator != null) {
        init(locator.getPublicId(), locator.getSystemId(),
         locator.getLineNumber(), locator.getColumnNumber());
    } else {
        init(null, null, -1, -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 {@link Locator}. For example, if the system identifier is a URL (including relative filename), the caller must resolve it fully before creating the exception.

param
message The error or warning message.
param
publicId The public identifier of the entity that generated the error or warning.
param
systemId The system identifier of the entity that generated the error or warning.
param
lineNumber The line number of the end of the text that caused the error or warning.
param
columnNumber The column number of the end of the text that cause the error or warning.

    super(message);
    init(publicId, systemId, lineNumber, columnNumber);
    
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 {@link org.xml.sax.SAXException SAXException}.

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

param
message The error or warning message, or null to use the message from the embedded exception.
param
publicId The public identifier of the entity that generated the error or warning.
param
systemId The system identifier of the entity that generated the error or warning.
param
lineNumber The line number of the end of the text that caused the error or warning.
param
columnNumber The column number of the end of the text that cause the error or warning.
param
e Another exception to embed in this one.

    super(message, e);
    init(publicId, systemId, lineNumber, columnNumber);
    
Methods Summary
public intgetColumnNumber()
The column number of the end of the text where the exception occurred.

The first column in a line is position 1.

return
An integer representing the column number, or -1 if none is available.
see
org.xml.sax.Locator#getColumnNumber

    return this.columnNumber;
    
public intgetLineNumber()
The line number of the end of the text where the exception occurred.

The first line is line 1.

return
An integer representing the line number, or -1 if none is available.
see
org.xml.sax.Locator#getLineNumber

    return this.lineNumber;
    
public java.lang.StringgetPublicId()
Get the public identifier of the entity where the exception occurred.

return
A string containing the public identifier, or null if none is available.
see
org.xml.sax.Locator#getPublicId

    return this.publicId;
    
public java.lang.StringgetSystemId()
Get the system identifier of the entity where the exception occurred.

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

return
A string containing the system identifier, or null if none is available.
see
org.xml.sax.Locator#getSystemId

    return this.systemId;
    
private voidinit(java.lang.String publicId, java.lang.String systemId, int lineNumber, int columnNumber)
Internal initialization method.

param
publicId The public identifier of the entity which generated the exception, or null.
param
systemId The system identifier of the entity which generated the exception, or null.
param
lineNumber The line number of the error, or -1.
param
columnNumber The column number of the error, or -1.

    this.publicId = publicId;
    this.systemId = systemId;
    this.lineNumber = lineNumber;
    this.columnNumber = columnNumber;