org.jaxen
Class XPathSyntaxException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.jaxen.saxpath.SAXPathException
              extended byorg.jaxen.JaxenException
                  extended byorg.jaxen.XPathSyntaxException
All Implemented Interfaces:
java.io.Serializable

public class XPathSyntaxException
extends JaxenException

Indicates an error during parsing of an XPath expression.

Author:
bob mcwhirter, James Strachan
See Also:
Serialized Form

Field Summary
private  int position
          The position of the error
private static long serialVersionUID
           
private  java.lang.String xpath
          The textual XPath expression
 
Fields inherited from class org.jaxen.JaxenException
javaVersion
 
Fields inherited from class org.jaxen.saxpath.SAXPathException
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
XPathSyntaxException(java.lang.String xpath, int position, java.lang.String message)
          Constructor
XPathSyntaxException(XPathSyntaxException e)
          Create a new XPathSyntaxException wrapping an existing org.jaxen.saxpath.XPathSyntaxException.
 
Method Summary
 java.lang.String getMultilineMessage()
          Retrieve the friendly multi-line error message.
 int getPosition()
          Retrieve the position of the error.
 java.lang.String getPositionMarker()
          Retrieve a string useful for denoting where the error occurred.
 java.lang.String getXPath()
          Retrieve the expression containing the error.
 
Methods inherited from class org.jaxen.saxpath.SAXPathException
getCause, initCause, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

xpath

private java.lang.String xpath
The textual XPath expression


position

private int position
The position of the error

Constructor Detail

XPathSyntaxException

public XPathSyntaxException(XPathSyntaxException e)
Create a new XPathSyntaxException wrapping an existing org.jaxen.saxpath.XPathSyntaxException.

Parameters:
e - the exception that caused this exception

XPathSyntaxException

public XPathSyntaxException(java.lang.String xpath,
                            int position,
                            java.lang.String message)
Constructor

Parameters:
xpath - the erroneous XPath expression
position - the position of the error
message - the error message
Method Detail

getPosition

public int getPosition()
Retrieve the position of the error.

Returns:
the position of the error

getXPath

public java.lang.String getXPath()
Retrieve the expression containing the error.

Returns:
the erroneous expression

getPositionMarker

public java.lang.String getPositionMarker()
Retrieve a string useful for denoting where the error occurred.

This is a string composed of whitespace and a marker at the position (see getPosition()) of the error. This is useful for creating friendly multi-line error displays.

Returns:
the error position marker

getMultilineMessage

public java.lang.String getMultilineMessage()
Retrieve the friendly multi-line error message.

This returns a multi-line string that contains the original erroneous XPath expression with a marker underneath indicating exactly where the error occurred.

Returns:
the multi-line error message