Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Public Attributes | Properties | List of all members
Lucene.Net.QueryParsers.ParseException Class Reference

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

Inherits Exception.

Public Member Functions

 ParseException (Token currentTokenVal, int[][] expectedTokenSequencesVal, System.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>
 
 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 (System.String message)
 Constructor with message.
 
 ParseException (System.String message, System.Exception ex)
 Constructor with message.
 

Public Attributes

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

Properties

override System.String Message [get]
 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.
 

Detailed Description

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.

Definition at line 36 of file ParseException.cs.

Constructor & Destructor Documentation

Lucene.Net.QueryParsers.ParseException.ParseException ( Token  currentTokenVal,
int  expectedTokenSequencesVal[][],
System.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>

Definition at line 117 of file ParseException.cs.

Lucene.Net.QueryParsers.ParseException.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.

Definition at line 134 of file ParseException.cs.

Lucene.Net.QueryParsers.ParseException.ParseException ( System.String  message)

Constructor with message.

Definition at line 140 of file ParseException.cs.

Lucene.Net.QueryParsers.ParseException.ParseException ( System.String  message,
System.Exception  ex 
)

Constructor with message.

Definition at line 146 of file ParseException.cs.

Member Data Documentation

Token Lucene.Net.QueryParsers.ParseException.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.

Definition at line 161 of file ParseException.cs.

int [][] Lucene.Net.QueryParsers.ParseException.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.

Definition at line 167 of file ParseException.cs.

System.String [] Lucene.Net.QueryParsers.ParseException.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.

Definition at line 173 of file ParseException.cs.

Property Documentation

override System.String Lucene.Net.QueryParsers.ParseException.Message
get

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.

Definition at line 48 of file ParseException.cs.


The documentation for this class was generated from the following file: