ParseException (Apache Commons JXPath 1.4-SNAPSHOT API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - org.apache.commons.jxpath.ri.parser.ParseException

All Implemented Interfaces:

Serializable
```
public class ParseException
extends Exception
```
This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. You can modify this class to customize your error reporting mechanisms so long as you retain the public fields.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Token`	`currentToken` This is the last token that has been consumed successfully.
`protected String`	`eol` The end of line string for this machine.
`int[][]`	`expectedTokenSequences` Each entry in this array is an array of integers.
`protected boolean`	`specialConstructor` This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
`String[]`	`tokenImage` This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

Constructor Summary

Constructors
Constructor and Description
`ParseException()` The following constructors are for use by you for whatever purpose you can think of.
`ParseException(String message)`
`ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal)` This constructor is used by the method "generateParseException" in the generated parser.

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`add_escapes(String str)` Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
`String`	`getMessage()` This method has the standard behavior when this object has been created using the standard constructors.

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - specialConstructor
```
protected boolean specialConstructor
```
    This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
  - currentToken
```
public Token currentToken
```
    This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.
  - expectedTokenSequences
```
public int[][] expectedTokenSequences
```
    Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.
  - tokenImage
```
public String[] tokenImage
```
    This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.
  - eol
```
protected String eol
```
    The end of line string for this machine.
- Constructor Detail
  - ParseException
```
public ParseException(Token currentTokenVal,
              int[][] expectedTokenSequencesVal,
              String[] tokenImageVal)
```
    This constructor is used by the method "generateParseException" in the generated parser. Calling this constructor generates a new object of this type with the fields "currentToken", "expectedTokenSequences", and "tokenImage" set. The boolean flag "specialConstructor" is also set to true to indicate that this constructor was used to create this object. This constructor calls its super class with the empty string to force the "toString" method of parent class "Throwable" to print the error message in the form: ParseException:
  - ParseException
```
public ParseException()
```
    The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated code does not use these constructors.
  - ParseException
```
public ParseException(String message)
```
- Method Detail
  - getMessage
```
public String getMessage()
```
    This method has the standard behavior when this object has been created using the standard constructors. Otherwise, it uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it. If this object has been created due to a parse error, and you do not catch it (it gets thrown from the parser), then this method is called during the printing of the final stack trace, and hence the correct error message gets displayed.
    
    Overrides:
    
    getMessage in class Throwable
  - add_escapes
```
protected String add_escapes(String str)
```
    Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

Class ParseException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

specialConstructor

currentToken

expectedTokenSequences

tokenImage

eol

Constructor Detail

ParseException

ParseException

ParseException

Method Detail

getMessage

add_escapes