org.apache.xpath
Class XPathException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.xml.transform.TransformerException
                    |
                    +--org.apache.xpath.XPathException
Direct Known Subclasses:
XPathProcessorException

public class XPathException
extends TransformerException

This class implements an exception object that all XPath classes will throw in case of an error. This class extends TransformerException, and may hold other exceptions. In the case of nested exceptions, printStackTrace will dump all the traces of the nested exceptions, not just the trace of this object.

See Also:
Serialized Form
Usage:

Constructor Summary
XPathException(java.lang.String message)
          Create an XPathException object that holds an error message.
XPathException(java.lang.String message, java.lang.Exception e)
          Create an XPathException object that holds an error message, and another exception that caused this exception.
XPathException(java.lang.String message, ExpressionNode ex)
          Create an XPathException object that holds an error message.
XPathException(java.lang.String message, Node styleNode, java.lang.Exception e)
          Create an XPathException object that holds an error message, the stylesheet node that the error originated from, and another exception that caused this exception.
XPathException(java.lang.String message, java.lang.Object styleNode)
          Create an XPathException object that holds an error message and the stylesheet node that the error originated from.
 
Method Summary
 java.lang.Throwable getException()
          Return the embedded exception, if any.
 java.lang.String getMessage()
          Find the most contained message.
 java.lang.Object getStylesheetNode()
          Get the stylesheet node from where this error originated.
 Node getStylesheetNode(ExpressionNode ex)
          Get the XSLT ElemVariable that this sub-expression references.
 void printStackTrace(java.io.PrintStream s)
          Print the the trace of methods from where the error originated.
 void printStackTrace(java.io.PrintWriter s)
          Print the the trace of methods from where the error originated.
 void setStylesheetNode(java.lang.Object styleNode)
          Set the stylesheet node from where this error originated.
 
Methods inherited from class javax.xml.transform.TransformerException
getCause, getLocationAsString, getLocator, getMessageAndLocation, initCause, printStackTrace, setLocator
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XPathException

public XPathException(java.lang.String message,
                      ExpressionNode ex)
Create an XPathException object that holds an error message.
Parameters:
message - The error message.

XPathException

public XPathException(java.lang.String message)
Create an XPathException object that holds an error message.
Parameters:
message - The error message.

XPathException

public XPathException(java.lang.String message,
                      java.lang.Object styleNode)
Create an XPathException object that holds an error message and the stylesheet node that the error originated from.
Parameters:
message - The error message.
styleNode - The stylesheet node that the error originated from.

XPathException

public XPathException(java.lang.String message,
                      Node styleNode,
                      java.lang.Exception e)
Create an XPathException object that holds an error message, the stylesheet node that the error originated from, and another exception that caused this exception.
Parameters:
message - The error message.
styleNode - The stylesheet node that the error originated from.
e - The exception that caused this exception.

XPathException

public XPathException(java.lang.String message,
                      java.lang.Exception e)
Create an XPathException object that holds an error message, and another exception that caused this exception.
Parameters:
message - The error message.
e - The exception that caused this exception.
Method Detail

getStylesheetNode

public java.lang.Object getStylesheetNode()
Get the stylesheet node from where this error originated.
Returns:
The stylesheet node from where this error originated, or null.

setStylesheetNode

public void setStylesheetNode(java.lang.Object styleNode)
Set the stylesheet node from where this error originated.
Parameters:
styleNode - The stylesheet node from where this error originated, or null.

getStylesheetNode

public Node getStylesheetNode(ExpressionNode ex)
Get the XSLT ElemVariable that this sub-expression references. In order for this to work, the SourceLocator must be the owning ElemTemplateElement.
Returns:
The dereference to the ElemVariable, or null if not found.

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Print the the trace of methods from where the error originated. This will trace all nested exception objects, as well as this object.
Parameters:
s - The stream where the dump will be sent to.
Overrides:
printStackTrace in class TransformerException

getMessage

public java.lang.String getMessage()
Find the most contained message.
Returns:
The error message of the originating exception.
Overrides:
getMessage in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Print the the trace of methods from where the error originated. This will trace all nested exception objects, as well as this object.
Parameters:
s - The writer where the dump will be sent to.
Overrides:
printStackTrace in class TransformerException

getException

public java.lang.Throwable getException()
Return the embedded exception, if any. Overrides javax.xml.transform.TransformerException.getException().
Returns:
The embedded exception, or null if there is none.
Overrides:
getException in class TransformerException


Copyright 2006 Apache XML Project. All Rights Reserved.