2005/5/9

org::xml::sax::SAXParseException Class Reference

Inheritance diagram for org::xml::sax::SAXParseException:

Detailed Description

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.

Since:

SAX 1.0

See also:

org::xml::sax::SAXException

org::xml::sax::Locator

org::xml::sax::ErrorHandler

Public Member Functions
	SAXParseException (IN(RString) s, IN(RLocator) locator)
	Create a new SAXParseException from a message and a Locator.
	SAXParseException (IN(RString) s, IN(RLocator) locator, IN(RException) exception)
	Wrap an existing exception in a SAXParseException.
	SAXParseException (IN(RString) msg, IN(RString) publicId, IN(RString) systemId, int lineno, int colno, IN(RException) ex=Nil)
	Create a new SAXParseException with an embedded exception.
virtual RLocator	locator ()
RString	getPublicId ()
RString	getSystemId ()
int	getLineNumber ()
int	getColumnNumber ()
RString	getMessage ()
	Return a detail message for this exception.
RString	toString ()
Private Attributes
RLocator	_locator
RString	_publicId
RString	_systemId
int	_lineNo
int	_columnNo

Constructor & Destructor Documentation

org::xml::sax::SAXParseException::SAXParseException (  IN(RString)  s, IN(RLocator)  locator )  [inline]

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: org::xml::sax::Locator

org::xml::sax::SAXParseException::SAXParseException (  IN(RString)  s, IN(RLocator)  locator, IN(RException)  exception )  [inline]

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: org::xml::sax::Locator

org::xml::sax::SAXParseException::SAXParseException (  IN(RString)  msg, IN(RString)  publicId, IN(RString)  systemId, int  lineno, int  colno, IN(RException)  ex = Nil )  [inline]

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

Member Function Documentation

int org::xml::sax::SAXParseException::getColumnNumber (   )  [inline]

int org::xml::sax::SAXParseException::getLineNumber (   )  [inline]

RString org::xml::sax::SAXParseException::getMessage (   )  [inline, virtual]

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. Reimplemented from org::xml::sax::SAXException.

RString org::xml::sax::SAXParseException::getPublicId (   )  [inline]

RString org::xml::sax::SAXParseException::getSystemId (   )  [inline]

virtual RLocator org::xml::sax::SAXParseException::locator (   )  [inline, virtual]

RString org::xml::sax::SAXParseException::toString (   )  [inline]

Reimplemented from org::xml::sax::SAXException.

Member Data Documentation

int org::xml::sax::SAXParseException::_columnNo [private]

int org::xml::sax::SAXParseException::_lineNo [private]

RLocator org::xml::sax::SAXParseException::_locator [private]

RString org::xml::sax::SAXParseException::_publicId [private]

RString org::xml::sax::SAXParseException::_systemId [private]