org.objectweb.jonas_ejb.deployment.ejbql.ParseException Class Reference

Collaboration diagram for org.objectweb.jonas_ejb.deployment.ejbql.ParseException:

[legend]List of all members.

Public Member Functions
	ParseException (Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal)
	ParseException ()
String	getMessage (String query)
Public Attributes
Token	currentToken
int[][]	expectedTokenSequences
String[]	tokenImage
Protected Member Functions
String	add_escapes (String str)
Protected Attributes
boolean	specialConstructor
String	eol = System.getProperty("line.separator", "\n")

---

Detailed Description

Initialy generated by JJTree, this class was modified to get specific error reporting

Author:

Christophe Ney, Consultant cney@batisseurs.com

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 16 of file ParseException.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas_ejb.deployment.ejbql.ParseException.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: <result of="" getmessage=""> Definition at line 30 of file ParseException.java. References org.objectweb.jonas_ejb.deployment.ejbql.ParseException.currentToken, org.objectweb.jonas_ejb.deployment.ejbql.ParseException.expectedTokenSequences, org.objectweb.jonas_ejb.deployment.ejbql.ParseException.specialConstructor, and org.objectweb.jonas_ejb.deployment.ejbql.ParseException.tokenImage.

org.objectweb.jonas_ejb.deployment.ejbql.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 52 of file ParseException.java. References org.objectweb.jonas_ejb.deployment.ejbql.ParseException.specialConstructor.

---

Member Function Documentation

String org.objectweb.jonas_ejb.deployment.ejbql.ParseException.add_escapes (  String  str  )  [protected]

Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal. Definition at line 159 of file ParseException.java. References org.objectweb.jonas_ejb.deployment.ejbql.Token.toString(). Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage (  String  query  )

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 100 of file ParseException.java. References org.objectweb.jonas_ejb.deployment.ejbql.ParseException.add_escapes(), org.objectweb.jonas_ejb.deployment.ejbql.Token.beginColumn, org.objectweb.jonas_ejb.deployment.ejbql.Token.beginLine, org.objectweb.jonas_ejb.deployment.ejbql.ParseException.currentToken, org.objectweb.jonas_ejb.deployment.ejbql.ParseException.eol, org.objectweb.jonas_ejb.deployment.ejbql.ParseException.expectedTokenSequences, org.objectweb.jonas_ejb.deployment.ejbql.Token.image, org.objectweb.jonas_ejb.deployment.ejbql.Token.kind, org.objectweb.jonas_ejb.deployment.ejbql.Token.next, and org.objectweb.jonas_ejb.deployment.ejbql.ParseException.tokenImage.

Here is the call graph for this function:

---

Member Data Documentation

Token org.objectweb.jonas_ejb.deployment.ejbql.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 74 of file ParseException.java. Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage(), and org.objectweb.jonas_ejb.deployment.ejbql.ParseException.ParseException().

String org.objectweb.jonas_ejb.deployment.ejbql.ParseException.eol = System.getProperty("line.separator", "\n") [protected]

The end of line string for this machine. Definition at line 152 of file ParseException.java. Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage().

int [][] org.objectweb.jonas_ejb.deployment.ejbql.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 81 of file ParseException.java. Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage(), and org.objectweb.jonas_ejb.deployment.ejbql.ParseException.ParseException().

boolean org.objectweb.jonas_ejb.deployment.ejbql.ParseException.specialConstructor [protected]

This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below). Definition at line 67 of file ParseException.java. Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.ParseException().

String [] org.objectweb.jonas_ejb.deployment.ejbql.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 88 of file ParseException.java. Referenced by org.objectweb.jonas_ejb.deployment.ejbql.ParseException.getMessage(), and org.objectweb.jonas_ejb.deployment.ejbql.ParseException.ParseException().

---

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

• src/org/objectweb/jonas_ejb/deployment/ejbql/ParseException.java

---