Overview | Package | Class | Use | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.xml.sax
Class SAXParseException

    java.lang.Object
      |
      +--java.lang.Throwable
            |
            +--java.lang.Exception
                  |
                  +--org.xml.sax.SAXException
                        |
                        +--org.xml.sax.SAXParseException

All Implemented Interfaces:
  java.io.Serializable

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 will include information for locating the error in the original XML document. 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.

Since:
  SAX 1.0
Version:
  2.0r2pre3
Author:
  David Megginson
See Also:
  `SAXException`, `Locator`, `ErrorHandler`, Serialized Form

Constructor Summary
`SAXParseException(java.lang.String message, Locator locator)` Create a new SAXParseException from a message and a Locator.
`SAXParseException(java.lang.String message, Locator locator, java.lang.Exception e)` Wrap an existing exception in a SAXParseException.
`SAXParseException(java.lang.String message, java.lang.String publicId, java.lang.String systemId, int lineNumber, int columnNumber)` Create a new SAXParseException.
`SAXParseException(java.lang.String message, java.lang.String publicId, java.lang.String systemId, int lineNumber, int columnNumber, java.lang.Exception e)` Create a new SAXParseException with an embedded exception.

Method Summary
`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.
`java.lang.String` | `getPublicId()` Get the public identifier of the entity where the exception occurred.
`java.lang.String` | `getSystemId()` Get the system identifier of the entity where the exception occurred.

Methods inherited from class org.xml.sax.SAXException
`getException, getMessage, toString`

Methods inherited from class java.lang.Throwable
`fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### SAXParseException

    public SAXParseException(java.lang.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` - The error or warning message.
    `locator` - The locator object for the error or warning (may be null).
  See Also:
    `Locator`

### SAXParseException

    public SAXParseException(java.lang.String message,
                             Locator locator,
                             java.lang.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` - 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.
  See Also:
    `Locator`

### SAXParseException

    public SAXParseException(java.lang.String message,
                             java.lang.String publicId,
                             java.lang.String systemId,
                             int lineNumber,
                             int columnNumber)

  Create a new SAXParseException.

  This constructor is most useful for parser writers.

  If the system identifier is a URL, the parser must resolve it fully before creating the exception.

  Parameters:
    `message` - The error or warning message.
    `publicId` - The public identifer of the entity that generated the error or warning.
    `systemId` - The system identifer 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.

### SAXParseException

    public SAXParseException(java.lang.String message,
                             java.lang.String publicId,
                             java.lang.String systemId,
                             int lineNumber,
                             int columnNumber,
                             java.lang.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`.

  If the system identifier is a URL, the parser 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 identifer of the entity that generated the error or warning.
    `systemId` - The system identifer 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 Detail

### getPublicId

    public java.lang.String getPublicId()

  Get the public identifier of the entity where the exception occurred.
  Returns:
    A string containing the public identifier, or null if none is available.
  See Also:
    `Locator.getPublicId()`

### getSystemId

    public java.lang.String getSystemId()

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

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

  Returns:
    A string containing the system identifier, or null if none is available.
  See Also:
    `Locator.getSystemId()`

### getLineNumber

    public int getLineNumber()

  The line number of the end of the text where the exception occurred.
  Returns:
    An integer representing the line number, or -1 if none is available.
  See Also:
    `Locator.getLineNumber()`

### getColumnNumber

    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:
    An integer representing the column number, or -1 if none is available.
  See Also:
    `Locator.getColumnNumber()`

Overview | Package | Class | Use | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2001-11-20.