class SAXException

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

org::xml::sax::SAXException Class Reference

#include <SAXException.h>

Inheritance diagram for org::xml::sax::SAXException:

List of all members.

Detailed Description

Encapsulate a general SAX 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 class can contain basic error or warning information from either the XML parser or the application: a parser writer or application writer can subclass it to provide additional functionality. SAX handlers may throw this exception or any exception subclassed from it.

If the application needs to pass through other types of exceptions, it must wrap those exceptions in a SAXException or an exception derived from a SAXException.

If the parser or application needs to include information about a specific location in an XML document, it should use the SAXParseException subclass.

Since:: SAX 1.0

See also:: org::xml::sax::SAXParseException

Public Member Functions

SAXException (IN(RString) s=)

SAXException (IN(RException) exception)

Create a new SAXException wrapping an existing exception.

SAXException (IN(RString) msg, IN(RException) exception)

Create a new SAXException from an existing exception.

virtual RString getMessage ()

Return a detail message for this exception.

RException getException ()

RString toString ()

Private Attributes

RString _message

RException _exception

Constructor & Destructor Documentation

org::xml::sax::SAXException::SAXException ( IN(RString) s = ) [inline]

org::xml::sax::SAXException::SAXException ( IN(RException) exception ) [inline]

Create a new SAXException wrapping an existing exception.
The existing exception will be embedded in the new one, and its message will become the default message for the SAXException.

Parameters:

e The exception to be wrapped in a SAXException.

org::xml::sax::SAXException::SAXException ( IN(RString) msg,

IN(RException) exception

) [inline]

Create a new SAXException from an existing exception.
The existing exception will be embedded in the new one, but the new exception will have its own message.

Parameters:

message The detail message.

e The exception to be wrapped in a SAXException.

Member Function Documentation

RException org::xml::sax::SAXException::getException ( ) [inline]

virtual RString org::xml::sax::SAXException::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 in org::xml::sax::SAXParseException.

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

Reimplemented in org::xml::sax::SAXParseException.

Member Data Documentation

RException org::xml::sax::SAXException::_exception [private]

RString org::xml::sax::SAXException::_message [private]