com.pcbsys.nirvana.nAdminAPI.nSchedulerParseException Class Reference

This exception is raised whn parsing a Nirvana Realm Scheduler script with syntax errors. More...


Public Member Functions

String getMessage ()
 This method has the standard behavior when this object has been created using the standard constructors.
 nSchedulerParseException (String message)
 nSchedulerParseException ()
 The following constructors are for use by you for whatever purpose you can think of.
 nSchedulerParseException (Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal)
 This constructor is used by the method "generateParseException" in the generated parser.

Data Fields

Token currentToken
 This is the last token that has been consumed successfully.
int[][] expectedTokenSequences
 Each entry in this array is an array of integers.
String[] tokenImage
 This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

Detailed Description

This exception is raised whn parsing a Nirvana Realm Scheduler script with syntax errors.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nSchedulerParseException.nSchedulerParseException ( 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: <result of="" getmessage>="">

Parameters:
currentTokenVal the current token that the exception was generated for
expectedTokenSequencesVal list of expected sequence values
tokenImageVal the token values

com.pcbsys.nirvana.nAdminAPI.nSchedulerParseException.nSchedulerParseException (  ) 

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.

com.pcbsys.nirvana.nAdminAPI.nSchedulerParseException.nSchedulerParseException ( String  message  ) 

Parameters:
message the message corresponding to the exception


Member Function Documentation

String com.pcbsys.nirvana.nAdminAPI.nSchedulerParseException.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.


Field Documentation

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.

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.

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.