Top Description Fields Constructors Methods
bsh

public Class ParseException

extends EvalError
Class Inheritance

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.

Field Summary

Modifier and TypeField and Description
public Token
currentToken

This is the last token that has been consumed successfully.

protected String
eol

The end of line string for this machine.

public int[][]
expectedTokenSequences

Each entry in this array is an array of integers.

pack-priv String
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).

public String[]
tokenImage

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

Inherited from bsh.EvalError:
callstackmessagenode

Constructor Summary

AccessConstructor and Description
public
ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal)

This constructor is used by the method "generateParseException" in the generated parser.

public
ParseException()

The following constructors are for use by you for whatever purpose you can think of.

public

Method Summary

Modifier and TypeMethod 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.

public int
public String
public String
public String
getMessage()

Overrides bsh.EvalError.getMessage.

Returns the detail message string of this throwable.
public String
getMessage(boolean debug)

This method has the standard behavior when this object has been created using the standard constructors.

public void
setErrorSourceFile(String file)

Used to add source file info to exception

public String
toString()

Overrides bsh.EvalError.toString.

Print the error with line number and stack trace.
Inherited from bsh.EvalError:
getNodegetScriptStackTraceprependMessagereThrowsetMessagesetNode

Field Detail

currentTokenback to summary
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.

eolback to summary
protected String eol

The end of line string for this machine.

expectedTokenSequencesback to summary
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.

sourceFileback to summary
pack-priv String sourceFile
specialConstructorback to summary
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).

tokenImageback to summary
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.

Constructor Detail

ParseExceptionback to summary
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:

ParseExceptionback to summary
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.

ParseExceptionback to summary
public ParseException(String message)

Method Detail

add_escapesback to summary
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.

getErrorLineNumberback to summary
public int getErrorLineNumber()

Overrides bsh.EvalError.getErrorLineNumber.

getErrorSourceFileback to summary
public String getErrorSourceFile()

Overrides bsh.EvalError.getErrorSourceFile.

getErrorTextback to summary
public String getErrorText()

Overrides bsh.EvalError.getErrorText.

getMessageback to summary
public String getMessage()

Overrides bsh.EvalError.getMessage.

Doc from java.lang.Throwable.getMessage.

Returns the detail message string of this throwable.

Returns:String

the detail message string of this Throwable instance (which may be null).

getMessageback to summary
public String getMessage(boolean debug)

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.

setErrorSourceFileback to summary
public void setErrorSourceFile(String file)

Used to add source file info to exception

toStringback to summary
public String toString()

Overrides bsh.EvalError.toString.

Doc from bsh.EvalError.toString.

Print the error with line number and stack trace.

Returns:String

Doc from java.lang.Throwable.toString.

a string representation of this throwable.