org.jaxen
Class XPathSyntaxException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.jaxen.saxpath.SAXPathException
              org.jaxen.JaxenException
                  org.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:

XPath, Serialized Form

Field Summary

private int	position The position of the error.
private java.lang.String	xpath The textual xpath expression.

Fields inherited from class org.jaxen.JaxenException

Fields inherited from class org.jaxen.saxpath.SAXPathException

Fields inherited from class java.lang.Exception

Fields inherited from class java.lang.Throwable

Constructor Summary

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

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 occured.
java.lang.String	getXPath() Retrieve the expression containing the error.

Methods inherited from class org.jaxen.JaxenException

getRootCause

Methods inherited from class org.jaxen.saxpath.SAXPathException

getCause, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

xpath

private java.lang.String xpath

The textual xpath expression.

position

private int position

The position of the error.

Constructor Detail

XPathSyntaxException

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

Construct.

Parameters:

xpath - The erroneous xpath.

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 occured.

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.