Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » queryParser » [javadoc | source]
org.apache.lucene.queryParser
public class: ParseException [javadoc | source]
java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         org.apache.lucene.queryParser.ParseException

All Implemented Interfaces:
    Serializable

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
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  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. 
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. 
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. 
protected  String eol    The end of line string for this machine. 
Fields inherited from java.lang.Exception:
serialVersionUID
Constructor:
 public ParseException() 
 public ParseException(String message) 
    Constructor with message.
 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:
Method from org.apache.lucene.queryParser.ParseException Summary:
add_escapes,   getMessage
Methods from java.lang.Throwable:
fillInStackTrace,   getCause,   getLocalizedMessage,   getMessage,   getStackTrace,   initCause,   printStackTrace,   printStackTrace,   printStackTrace,   setStackTrace,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.queryParser.ParseException Detail:
 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 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.