net.sf.tomp.xml.include
Class XIncludeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          net.sf.tomp.xml.include.XIncludeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CircularIncludeException, UnavailableResourceException

public class XIncludeException

extends java.lang.Exception

XIncludeException is the generic superclass for all checked exceptions that may be thrown as a result of a violation of XInclude's rules.

Version:

1.0d9, July 4, 2002

Author:

Elliotte Rusty Harold

See Also:

Serialized Form

Constructor Summary

XIncludeException()
Constructs an XIncludeException with null as its error detail message.

XIncludeException(java.lang.String message)
Constructs an XIncludeException with the specified detail message.

Method Summary

java.lang.Throwable	getRootCause() When an IOException,MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException.
void	setRootCause(java.lang.Throwable nestedException) When an IOException,MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XIncludeException

public XIncludeException()

Constructs an XIncludeException with null as its error detail message.

XIncludeException

public XIncludeException(java.lang.String message)

Constructs an XIncludeException with the specified detail message. The error message string message can later be retrieved by the Throwable.getMessage() method of class java.lang.Throwable.

Parameters:

message - the detail message.

Method Detail

setRootCause

public void setRootCause(java.lang.Throwable nestedException)

When an IOException,MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException. This method allows you to store the original exception.

Parameters:

nestedException - the underlying exception which caused the XIncludeException to be thrown

getRootCause

public java.lang.Throwable getRootCause()

When an IOException,MalformedURLException or other generic exception is thrown while processing an XML document for XIncludes, it is customarily replaced by some form of XIncludeException. This method allows you to retrieve the original exception. It returns null if no such exception caused this XIncludeException.

Returns:

Throwable the underlying exception which caused the XIncludeException to be thrown