org.xml.sax: public class: SAXException

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

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

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
SAXParseException, SAXNotRecognizedException, SAXNotSupportedException

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.

Also see:

org.xml.sax.SAXParseException

since: SAX - 1.0

author: David - Megginson

version: 2.0.1 - (sax2r2)

Field Summary
static final long	serialVersionUID

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public SAXException() { super(); this.exception = null; } Create a new SAXException.
public SAXException(String message) { super(message); this.exception = null; } Create a new SAXException. Parameters: `message` - The error or warning message.
public SAXException(Exception e) { super(); this.exception = e; } 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.
public SAXException(String message, Exception e) { super(message); this.exception = e; } 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.

 public SAXException() {
	super();
	this.exception = null;
}

Create a new SAXException.

 public SAXException(String message) {
	super(message);
	this.exception = null;
}

Create a new SAXException.

Parameters:

message - The error or warning message.

 public SAXException(Exception e) {
	super();
	this.exception = e;
}

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.

 public SAXException(String message,
    Exception e) {
	super(message);
	this.exception = e;
}

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.

Method from org.xml.sax.SAXException Summary:
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.SAXException Detail:
public Exception getException() { return exception; } Return the embedded exception, if any.
public String getMessage() { String message = super.getMessage(); if (message == null && exception != null) { return exception.getMessage(); } else { return message; } } 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.
public String toString() { if (exception != null) { return exception.toString(); } else { return super.toString(); } } Override toString to pick up any embedded exception.

Method from org.xml.sax.SAXException Detail:

 public Exception getException() {
	return exception;
}

Return the embedded exception, if any.

 public String getMessage() {
	String message = super.getMessage();
	if (message == null && exception != null) {
	    return exception.getMessage();
	} else {
	    return message;
	}
}

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.

 public String toString() {
	if (exception != null) {
	    return exception.toString();
	} else {
	    return super.toString();
	}
}

Override toString to pick up any embedded exception.