com.puppycrawl.tools.checkstyle.api

Class TokenTypes

public final class TokenTypes extends Object

Contains the constants for all the tokens contained in the Abstract Syntax Tree.

Implementation detail: This class has been introduced to break the circular dependency between packages.

Version: 1.0

Author: Oliver Burn Peter Dobratz

Field Summary
static intABSTRACT
The abstract keyword.
static intANNOTATION
An annotation of a package, type, field, parameter or variable.
static intANNOTATIONS
A collection of annotations on a package or enum constant.
static intANNOTATION_ARRAY_INIT
An annotation array member initialisation.
static intANNOTATION_DEF
An annotation declaration.
static intANNOTATION_FIELD_DEF
An annotation field declaration.
static intANNOTATION_MEMBER_VALUE_PAIR
An initialisation of an annotation member with a value.
static intARRAY_DECLARATOR
An array declaration.
static intARRAY_INIT
An array initialization.
static intASSIGN
The = (assignment) operator.
static intAT
An 'at' symbol - signifying an annotation instance or the prefix to the interface literal signifying the definition of an annotation declaration.
static intBAND
The & (bitwise AND) operator.
static intBAND_ASSIGN
The &= (bitwise AND assignment) operator.
static intBNOT
The ~ (bitwise complement) operator.
static intBOR
The | (bitwise OR) operator.
static intBOR_ASSIGN
The |= (bitwise OR assignment) operator.
static intBSR
The >>> (unsigned shift right) operator.
static intBSR_ASSIGN
The >>>= (unsigned right shift assignment) operator.
static intBXOR
The ^ (bitwise exclusive OR) operator.
static intBXOR_ASSIGN
The ^= (bitwise exclusive OR assignment) operator.
static intCASE_GROUP
A group of case clauses.
static intCHAR_LITERAL
A character literal.
static intCLASS_DEF
A class declaration.
static intCOLON
The : (colon) operator.
static intCOMMA
The , (comma) operator.
static intCTOR_CALL
A constructor call.
static intCTOR_DEF
A constructor declaration.
static intDEC
The -- (prefix decrement) operator.
static intDIV
The / (division) operator.
static intDIV_ASSIGN
The /= (division assignment) operator.
static intDOT
The . (dot) operator.
static intDO_WHILE
Literal while in do-while loop.
static intELIST
An expression list.
static intELLIPSIS
A triple dot for variable-length parameters.
static intEMPTY_STAT
The empty statement.
static intENUM
The enum keyword.
static intENUM_CONSTANT_DEF
An enum constant declaration.
static intENUM_DEF
An enum declaration.
static intEOF
The end of file token.
static intEQUAL
The == (equal) operator.
static intEXPR
An expression.
static intEXTENDS_CLAUSE
An extends clause.
static intFINAL
The final keyword.
static intFOR_CONDITION
A for loop condition.
static intFOR_EACH_CLAUSE
A for-each clause.
static intFOR_INIT
A for loop initializer.
static intFOR_ITERATOR
A for loop iterator.
static intGE
The >= (greater than or equal) operator.
static intGENERIC_END
'>' symbol signifying the end of type arguments or type parameters.
static intGENERIC_START
'<' symbol signifying the start of type arguments or type parameters.
static intGT
The > (greater than) operator.
static intIDENT
An identifier.
static intIMPLEMENTS_CLAUSE
An implements clause.
static intIMPORT
An import declaration.
static intINC
The ++ (prefix increment) operator.
static intINDEX_OP
The array index operator.
static intINSTANCE_INIT
An instance initializer.
static intINTERFACE_DEF
An interface declaration.
static intLABELED_STAT
A labeled statement.
static intLAND
The && (conditional AND) operator.
static intLCURLY
A left (curly) brace ({).
static intLE
The <= (less than or equal) operator.
static intLITERAL_ASSERT
The assert keyword.
static intLITERAL_BOOLEAN
The boolean keyword.
static intLITERAL_BREAK
The break keyword.
static intLITERAL_BYTE
The byte keyword.
static intLITERAL_CASE
The case keyword.
static intLITERAL_CATCH
The catch keyword.
static intLITERAL_CHAR
The char keyword.
static intLITERAL_CLASS
The class keyword.
static intLITERAL_CONTINUE
The continue keyword.
static intLITERAL_DEFAULT
The default keyword.
static intLITERAL_DO
The do keyword.
static intLITERAL_DOUBLE
The double keyword.
static intLITERAL_ELSE
The else keyword.
static intLITERAL_FALSE
The false keyword.
static intLITERAL_FINALLY
The finally keyword.
static intLITERAL_FLOAT
The float keyword.
static intLITERAL_FOR
The for keyword.
static intLITERAL_IF
The if keyword.
static intLITERAL_INSTANCEOF
The instanceof operator.
static intLITERAL_INT
The int keyword.
static intLITERAL_INTERFACE
The interface keyword.
static intLITERAL_LONG
The long keyword.
static intLITERAL_NATIVE
The native keyword.
static intLITERAL_NEW
The new keyword.
static intLITERAL_NULL
The null keyword.
static intLITERAL_PRIVATE
The private keyword.
static intLITERAL_PROTECTED
The protected keyword.
static intLITERAL_PUBLIC
The public keyword.
static intLITERAL_RETURN
The return keyword.
static intLITERAL_SHORT
The short keyword.
static intLITERAL_STATIC
The static keyword.
static intLITERAL_SUPER
The super keyword.
static intLITERAL_SWITCH
The switch keyword.
static intLITERAL_SYNCHRONIZED
The synchronized keyword.
static intLITERAL_THIS
The this keyword.
static intLITERAL_THROW
The throw keyword.
static intLITERAL_THROWS
The throws keyword.
static intLITERAL_TRANSIENT
The transient keyword.
static intLITERAL_TRUE
The true keyword.
static intLITERAL_TRY
The try keyword.
static intLITERAL_VOID
The void keyword.
static intLITERAL_VOLATILE
The volatile keyword.
static intLITERAL_WHILE
The while keyword.
static intLNOT
The ! (logical complement) operator.
static intLOR
The || (conditional OR) operator.
static intLPAREN
A left parenthesis (().
static intLT
The < (less than) operator.
static intMETHOD_CALL
A method call.
static intMETHOD_DEF
A method declaration.
static intMINUS
The - (subtraction) operator.
static intMINUS_ASSIGN
The -= (subtraction assignment) operator.
static intMOD
The % (remainder) operator.
static intMODIFIERS
Modifiers for type, method, and field declarations.
static intMOD_ASSIGN
The %= (remainder assignment) operator.
static intNOT_EQUAL
The != (not equal) operator.
static intNUM_DOUBLE
A double precision floating point literal.
static intNUM_FLOAT
A single precision floating point literal.
static intNUM_INT
An integer literal.
static intNUM_LONG
A long integer literal.
static intOBJBLOCK
An object block.
static intPACKAGE_DEF
The package declaration.
static intPARAMETERS
A list of parameters to a method or constructor.
static intPARAMETER_DEF
A parameter declaration.
static intPLUS
The + (addition) operator.
static intPLUS_ASSIGN
The += (addition assignment) operator.
static intPOST_DEC
The -- (postfix decrement) operator.
static intPOST_INC
The ++ (postfix increment) operator.
static intQUESTION
The ? (conditional) operator.
static intRBRACK
The ] symbol.
static intRCURLY
A right (curly) brace (}).
static intRPAREN
A right parenthesis ()).
static intSEMI
The statement terminator (;).
static intSL
The << (shift left) operator.
static intSLIST
A list of statements.
static intSL_ASSIGN
The <<= (left shift assignment) operator.
static intSR
The >> (signed shift right) operator.
static intSR_ASSIGN
The >>= (signed right shift assignment) operator.
static intSTAR
The * (multiplication or wildcard) operator.
static intSTAR_ASSIGN
The *= (multiplication assignment) operator.
static intSTATIC_IMPORT
A static import declaration.
static intSTATIC_INIT
A static initialization block.
static intSTRICTFP
The strictfp keyword.
static intSTRING_LITERAL
A string literal.
static intSUPER_CTOR_CALL
A super constructor call.
static intTYPE
A type.
static intTYPECAST
A type-cast.
static intTYPE_ARGUMENT
A type arguments to a type reference or a method/ctor invocation.
static intTYPE_ARGUMENTS
A list of type arguments to a type reference or a method/ctor invocation.
static intTYPE_EXTENSION_AND
'&' symbol when used in a generic upper or lower bounds constrain e.g.
static intTYPE_LOWER_BOUNDS
A lower bounds on a wildcard type argument.
static intTYPE_PARAMETER
A type parameter to a class, interface or method definition.
static intTYPE_PARAMETERS
A list of type parameters to a class, interface or method definition.
static intTYPE_UPPER_BOUNDS
An upper bounds on a wildcard type argument or type parameter.
static intUNARY_MINUS
The + (unary plus) operator.
static intUNARY_PLUS
The - (unary minus) operator.
static intVARIABLE_DEF
A field or local variable declaration.
static intWILDCARD_TYPE
The type that refers to all types.
Method Summary
static StringgetShortDescription(String aName)
Returns the short description of a token for a given name.
static intgetTokenId(String aName)
Returns the ID of a token for a given name.
static StringgetTokenName(int aID)
Returns the name of a token for a given ID.

Field Detail

ABSTRACT

public static final int ABSTRACT
The abstract keyword.

See Also: MODIFIERS

ANNOTATION

public static final int ANNOTATION
An annotation of a package, type, field, parameter or variable. An annotation may occur anywhere modifiers occur (it is a type of modifier) and may also occur prior to a package definition. The notable children are: The annotation name and either a single default annotation value or a sequence of name value pairs. Annotation values may also be annotations themselves.

For example:

     @MyAnnotation(someField1 = "Hello",
                    someField2 = @SomeOtherAnnotation)
 

parses as:

 +--ANNOTATION
     |
     +--AT (@)
     +--IDENT (MyAnnotation)
     +--LPAREN (()
     +--ANNOTATION_MEMBER_VALUE_PAIR
         |
         +--IDENT (someField1)
         +--ASSIGN (=)
         +--ANNOTATION
             |
             +--AT (@)
             +--IDENT (SomeOtherAnnotation)
     +--ANNOTATION_MEMBER_VALUE_PAIR
         |
         +--IDENT (someField2)
         +--ASSIGN (=)
         +--STRING_LITERAL ("Hello")
     +--RPAREN ())
 

See Also: JSR201 MODIFIERS IDENT ANNOTATION_MEMBER_VALUE_PAIR

ANNOTATIONS

public static final int ANNOTATIONS
A collection of annotations on a package or enum constant. A collections of annotations will only occur on these nodes as all other nodes that may be qualified with an annotation can be qualified with any other modifier and hence these annotations would be contained in a {@link #MODIFIERS} node.

For example:

     @MyAnnotation package blah;
 

parses as:

 +--PACKAGE_DEF (package)
     |
     +--ANNOTATIONS
         |
         +--ANNOTATION
             |
             +--AT (@)
             +--IDENT (MyAnnotation)
     +--IDENT (blah)
     +--SEMI (;)
 

See Also: JSR201 ANNOTATION AT IDENT

ANNOTATION_ARRAY_INIT

public static final int ANNOTATION_ARRAY_INIT
An annotation array member initialisation. Initializers can not be nested. Am initializer may be present as a default to a annotation member, as the single default value to an annotation (e.g. @Annotation({1,2})) or as the value of an annotation member value pair.

For example:

     { 1, 2 }
 

parses as:

 +--ANNOTATION_ARRAY_INIT ({)
     |
     +--NUM_INT (1)
     +--COMMA (,)
     +--NUM_INT (2)
     +--RCURLY (})
 

See Also: JSR201 ANNOTATION IDENT ANNOTATION_MEMBER_VALUE_PAIR

ANNOTATION_DEF

public static final int ANNOTATION_DEF
An annotation declaration. The notable children are the name of the annotation type, annotation field declarations and (constant) fields.

For example:

 public @interface MyAnnotation
 {
     int someValue();
 }
 

parses as:

 +--ANNOTATION_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--AT (@)
     +--LITERAL_INTERFACE (interface)
     +--IDENT (MyAnnotation)
     +--OBJBLOCK
         |
         +--LCURLY ({)
         +--ANNOTATION_FIELD_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--LITERAL_INT (int)
             +--IDENT (someValue)
             +--LPAREN (()
             +--RPAREN ())
             +--SEMI (;)
         +--RCURLY (})
 

See Also: JSR201 MODIFIERS LITERAL_INTERFACE IDENT OBJBLOCK ANNOTATION_FIELD_DEF

ANNOTATION_FIELD_DEF

public static final int ANNOTATION_FIELD_DEF
An annotation field declaration. The notable children are modifiers, field type, field name and an optional default value (a conditional compile-time constant expression). Default values may also by annotations.

For example:

     String someField() default "Hello world";
 

parses as:

 +--ANNOTATION_FIELD_DEF
     |
     +--MODIFIERS
     +--TYPE
         |
         +--IDENT (String)
     +--IDENT (someField)
     +--LPAREN (()
     +--RPAREN ())
     +--LITERAL_DEFAULT (default)
     +--STRING_LITERAL ("Hello world")
     +--SEMI (;)
 

See Also: JSR201 MODIFIERS TYPE LITERAL_DEFAULT

ANNOTATION_MEMBER_VALUE_PAIR

public static final int ANNOTATION_MEMBER_VALUE_PAIR
An initialisation of an annotation member with a value. Its children are the name of the member, the assignment literal and the (compile-time constant conditional expression) value.

See Also: JSR201 ANNOTATION IDENT

ARRAY_DECLARATOR

public static final int ARRAY_DECLARATOR
An array declaration.

If the array declaration represents a type, then the type of the array elements is the first child. Multidimensional arrays may be regarded as arrays of arrays. In other words, the first child of the array declaration is another array declaration.

For example:

   int[] x;
 

parses as:

 +--VARIABLE_DEF
     |
     +--MODIFIERS
     +--TYPE
         |
         +--ARRAY_DECLARATOR ([)
             |
             +--LITERAL_INT (int)
     +--IDENT (x)
 +--SEMI (;)
 

The array declaration may also represent an inline array definition. In this case, the first child will be either an expression specifying the length of the array or an array initialization block.

See Also: Java Language Specification Chapter 10 TYPE ARRAY_INIT

ARRAY_INIT

public static final int ARRAY_INIT
An array initialization. This may occur as part of an array declaration or inline with new.

For example:

   int[] y =
     {
       1,
       2,
     };
 

parses as:

 +--VARIABLE_DEF
     |
     +--MODIFIERS
     +--TYPE
         |
         +--ARRAY_DECLARATOR ([)
             |
             +--LITERAL_INT (int)
     +--IDENT (y)
     +--ASSIGN (=)
         |
         +--ARRAY_INIT ({)
             |
             +--EXPR
                 |
                 +--NUM_INT (1)
             +--COMMA (,)
             +--EXPR
                 |
                 +--NUM_INT (2)
             +--COMMA (,)
             +--RCURLY (})
 +--SEMI (;)
 

Also consider:

   int[] z = new int[]
     {
       1,
       2,
     };
 

which parses as:

 +--VARIABLE_DEF
     |
     +--MODIFIERS
     +--TYPE
         |
         +--ARRAY_DECLARATOR ([)
             |
             +--LITERAL_INT (int)
     +--IDENT (z)
     +--ASSIGN (=)
         |
         +--EXPR
             |
             +--LITERAL_NEW (new)
                 |
                 +--LITERAL_INT (int)
                 +--ARRAY_DECLARATOR ([)
                 +--ARRAY_INIT ({)
                     |
                     +--EXPR
                         |
                         +--NUM_INT (1)
                     +--COMMA (,)
                     +--EXPR
                         |
                         +--NUM_INT (2)
                     +--COMMA (,)
                     +--RCURLY (})
 

See Also: ARRAY_DECLARATOR TYPE LITERAL_NEW COMMA

ASSIGN

public static final int ASSIGN
The = (assignment) operator.

See Also: Java Language Specification, §15.26.1 EXPR

AT

public static final int AT
An 'at' symbol - signifying an annotation instance or the prefix to the interface literal signifying the definition of an annotation declaration.

See Also: JSR201

BAND

public static final int BAND
The & (bitwise AND) operator.

See Also: Java Language Specification, §15.22.1 EXPR

BAND_ASSIGN

public static final int BAND_ASSIGN
The &= (bitwise AND assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

BNOT

public static final int BNOT
The ~ (bitwise complement) operator.

See Also: Java Language Specification, §15.15.5 EXPR

BOR

public static final int BOR
The | (bitwise OR) operator.

See Also: Java Language Specification, §15.22.1 EXPR

BOR_ASSIGN

public static final int BOR_ASSIGN
The |= (bitwise OR assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

BSR

public static final int BSR
The >>> (unsigned shift right) operator.

See Also: Java Language Specification, §15.19 EXPR

BSR_ASSIGN

public static final int BSR_ASSIGN
The >>>= (unsigned right shift assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

BXOR

public static final int BXOR
The ^ (bitwise exclusive OR) operator.

See Also: Java Language Specification, §15.22.1 EXPR

BXOR_ASSIGN

public static final int BXOR_ASSIGN
The ^= (bitwise exclusive OR assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

CASE_GROUP

public static final int CASE_GROUP
A group of case clauses. Case clauses with no associated statements are grouped together into a case group. The last child is a statement list containing the statements to execute upon a match.

For example:

 case 0:
 case 1:
 case 2:
   x = 3;
   break;
 

parses as:

 +--CASE_GROUP
     |
     +--LITERAL_CASE (case)
         |
         +--EXPR
             |
             +--NUM_INT (0)
     +--LITERAL_CASE (case)
         |
         +--EXPR
             |
             +--NUM_INT (1)
     +--LITERAL_CASE (case)
         |
         +--EXPR
             |
             +--NUM_INT (2)
     +--SLIST
         |
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--IDENT (x)
                 +--NUM_INT (3)
         +--SEMI (;)
         +--LITERAL_BREAK (break)
             |
             +--SEMI (;)
 

See Also: LITERAL_CASE LITERAL_DEFAULT LITERAL_SWITCH

CHAR_LITERAL

public static final int CHAR_LITERAL
A character literal. This is a (possibly escaped) character enclosed in single quotes.

See Also: Java Language Specification, §3.10.4 EXPR

CLASS_DEF

public static final int CLASS_DEF
A class declaration.

For example:

 public class MyClass
   implements Serializable
 {
 }
 

parses as:

 +--CLASS_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--LITERAL_CLASS (class)
     +--IDENT (MyClass)
     +--EXTENDS_CLAUSE
     +--IMPLEMENTS_CLAUSE
         |
         +--IDENT (Serializable)
     +--OBJBLOCK
         |
         +--LCURLY ({)
         +--RCURLY (})
 

See Also: Java Language Specification, Chapter 8 MODIFIERS IDENT EXTENDS_CLAUSE IMPLEMENTS_CLAUSE OBJBLOCK LITERAL_NEW

COLON

public static final int COLON
The : (colon) operator. This will appear as part of the conditional operator (? :).

See Also: QUESTION LABELED_STAT CASE_GROUP

COMMA

public static final int COMMA
The , (comma) operator.

See Also: ARRAY_INIT FOR_INIT FOR_ITERATOR LITERAL_THROWS IMPLEMENTS_CLAUSE

CTOR_CALL

public static final int CTOR_CALL
A constructor call.

For example:

 this(1);
 

parses as:

 +--CTOR_CALL (this)
     |
     +--LPAREN (()
     +--ELIST
         |
         +--EXPR
             |
             +--NUM_INT (1)
     +--RPAREN ())
     +--SEMI (;)
 

See Also: ELIST RPAREN SEMI SUPER_CTOR_CALL

CTOR_DEF

public static final int CTOR_DEF
A constructor declaration.

For example:

 public SpecialEntry(int value, String text)
 {
   this.value = value;
   this.text = text;
 }
 

parses as:

 +--CTOR_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--IDENT (SpecialEntry)
     +--LPAREN (()
     +--PARAMETERS
         |
         +--PARAMETER_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--LITERAL_INT (int)
             +--IDENT (value)
         +--COMMA (,)
         +--PARAMETER_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--IDENT (String)
             +--IDENT (text)
     +--RPAREN ())
     +--SLIST ({)
         |
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--DOT (.)
                     |
                     +--LITERAL_THIS (this)
                     +--IDENT (value)
                 +--IDENT (value)
         +--SEMI (;)
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--DOT (.)
                     |
                     +--LITERAL_THIS (this)
                     +--IDENT (text)
                 +--IDENT (text)
         +--SEMI (;)
         +--RCURLY (})
 

See Also: OBJBLOCK CLASS_DEF

DEC

public static final int DEC
The -- (prefix decrement) operator.

See Also: Java Language Specification, §15.15.2 EXPR POST_DEC

DIV

public static final int DIV
The / (division) operator.

See Also: Java Language Specification, §15.17.2 EXPR

DIV_ASSIGN

public static final int DIV_ASSIGN
The /= (division assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

DOT

public static final int DOT
The . (dot) operator.

See Also:

DO_WHILE

public static final int DO_WHILE
Literal while in do-while loop.

See Also: LITERAL_DO

ELIST

public static final int ELIST
An expression list. The children are a comma separated list of expressions.

See Also: LITERAL_NEW FOR_INIT FOR_ITERATOR EXPR METHOD_CALL CTOR_CALL SUPER_CTOR_CALL

ELLIPSIS

public static final int ELLIPSIS
A triple dot for variable-length parameters. This token only ever occurs in a parameter declaration immediately after the type of the parameter.

See Also: JSR201

EMPTY_STAT

public static final int EMPTY_STAT
The empty statement. This goes in place of an SLIST for a for or while loop body.

See Also: Java Language Specification, §14.6 LITERAL_FOR LITERAL_WHILE

ENUM

public static final int ENUM
The enum keyword. This element appears as part of an enum declaration.

ENUM_CONSTANT_DEF

public static final int ENUM_CONSTANT_DEF
An enum constant declaration. Its notable children are annotations, arguments and object block akin to an annonymous inner class' body.

For example:

 SOME_CONSTANT(1)
 {
     public void someMethodOverridenFromMainBody()
     {
     }
 }
 

parses as:

 +--ENUM_CONSTANT_DEF
     |
     +--ANNOTATIONS
     +--IDENT (SOME_CONSTANT)
     +--LPAREN (()
     +--ELIST
         |
         +--EXPR
             |
             +--NUM_INT (1)
     +--RPAREN ())
     +--OBJBLOCK
         |
         +--LCURLY ({)
         |
         +--METHOD_DEF
             |
             +--MODIFIERS
                 |
                 +--LITERAL_PUBLIC (public)
             +--TYPE
                 |
                 +--LITERAL_void (void)
             +--IDENT (someMethodOverridenFromMainBody)
             +--LPAREN (()
             +--PARAMETERS
             +--RPAREN ())
             +--SLIST ({)
                 |
                 +--RCURLY (})
         +--RCURLY (})
 

See Also: JSR201 ANNOTATIONS MODIFIERS IDENT ELIST OBJBLOCK

ENUM_DEF

public static final int ENUM_DEF
An enum declaration. Its notable children are enum constant declarations followed by any construct that may be expected in a class body.

For example:

 public enum MyEnum
   implements Serializable
 {
     FIRST_CONSTANT,
     SECOND_CONSTANT;

     public void someMethod()
     {
     }
 }
 

parses as:

 +--ENUM_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--ENUM (enum)
     +--IDENT (MyEnum)
     +--EXTENDS_CLAUSE
     +--IMPLEMENTS_CLAUSE
         |
         +--IDENT (Serializable)
     +--OBJBLOCK
         |
         +--LCURLY ({)
         +--ENUM_CONSTANT_DEF
             |
             +--IDENT (FIRST_CONSTANT)
         +--COMMA (,)
         +--ENUM_CONSTANT_DEF
             |
             +--IDENT (SECOND_CONSTANT)
         +--SEMI (;)
         +--METHOD_DEF
             |
             +--MODIFIERS
                 |
                 +--LITERAL_PUBLIC (public)
             +--TYPE
                 |
                 +--LITERAL_void (void)
             +--IDENT (someMethod)
             +--LPAREN (()
             +--PARAMETERS
             +--RPAREN ())
             +--SLIST ({)
                 |
                 +--RCURLY (})
         +--RCURLY (})
 

See Also: JSR201 MODIFIERS ENUM IDENT EXTENDS_CLAUSE IMPLEMENTS_CLAUSE OBJBLOCK LITERAL_NEW ENUM_CONSTANT_DEF

EOF

public static final int EOF
The end of file token. This is the root node for the source file. It's children are an optional package definition, zero or more import statements, and one or more class or interface definitions.

See Also: PACKAGE_DEF IMPORT CLASS_DEF INTERFACE_DEF

EQUAL

public static final int EQUAL
The == (equal) operator.

See Also: EXPR

EXPR

public static final int EXPR
An expression. Operators with lower precedence appear at a higher level in the tree than operators with higher precedence. Parentheses are siblings to the operator they enclose.

For example:

 x = 4 + 3 * 5 + (30 + 26) / 4 + 5 % 4 + (1<<3);
 

parses as:

 +--EXPR
     |
     +--ASSIGN (=)
         |
         +--IDENT (x)
         +--PLUS (+)
             |
             +--PLUS (+)
                 |
                 +--PLUS (+)
                     |
                     +--PLUS (+)
                         |
                         +--NUM_INT (4)
                         +--STAR (*)
                             |
                             +--NUM_INT (3)
                             +--NUM_INT (5)
                     +--DIV (/)
                         |
                         +--LPAREN (()
                         +--PLUS (+)
                             |
                             +--NUM_INT (30)
                             +--NUM_INT (26)
                         +--RPAREN ())
                         +--NUM_INT (4)
                 +--MOD (%)
                     |
                     +--NUM_INT (5)
                     +--NUM_INT (4)
             +--LPAREN (()
             +--SL (<<)
                 |
                 +--NUM_INT (1)
                 +--NUM_INT (3)
             +--RPAREN ())
 +--SEMI (;)
 

See Also: ELIST ASSIGN LPAREN RPAREN

EXTENDS_CLAUSE

public static final int EXTENDS_CLAUSE
An extends clause. This appear as part of class and interface definitions. This element appears even if the extends keyword is not explicitly used. The child is an optional identifier.

For example:

 

parses as:

 +--EXTENDS_CLAUSE
     |
     +--DOT (.)
         |
         +--DOT (.)
             |
             +--IDENT (java)
             +--IDENT (util)
         +--IDENT (LinkedList)
 

See Also: IDENT DOT CLASS_DEF INTERFACE_DEF

FINAL

public static final int FINAL
The final keyword.

See Also: MODIFIERS

FOR_CONDITION

public static final int FOR_CONDITION
A for loop condition. This is a child of LITERAL_FOR. The child of this element is an optional expression.

See Also: EXPR LITERAL_FOR

FOR_EACH_CLAUSE

public static final int FOR_EACH_CLAUSE
A for-each clause. This is a child of LITERAL_FOR. The children of this element may be a parameter definition, the colon literal and an expression.

See Also: VARIABLE_DEF ELIST LITERAL_FOR

FOR_INIT

public static final int FOR_INIT
A for loop initializer. This is a child of LITERAL_FOR. The children of this element may be a comma separated list of variable declarations, an expression list, or empty.

See Also: VARIABLE_DEF ELIST LITERAL_FOR

FOR_ITERATOR

public static final int FOR_ITERATOR
A for loop iterator. This is a child of LITERAL_FOR. The child of this element is an optional expression list.

See Also: ELIST LITERAL_FOR

GE

public static final int GE
The >= (greater than or equal) operator.

See Also: EXPR

GENERIC_END

public static final int GENERIC_END
'>' symbol signifying the end of type arguments or type parameters.

GENERIC_START

public static final int GENERIC_START
'<' symbol signifying the start of type arguments or type parameters.

GT

public static final int GT
The > (greater than) operator.

See Also: EXPR

IDENT

public static final int IDENT
An identifier. These can be names of types, subpackages, fields, methods, parameters, and local variables.

IMPLEMENTS_CLAUSE

public static final int IMPLEMENTS_CLAUSE
An implements clause. This always appears in a class or enum declaration, even if there are no implemented interfaces. The children are a comma separated list of zero or more identifiers.

For example:

 implements Serializable, Comparable
 

parses as:

 +--IMPLEMENTS_CLAUSE
     |
     +--IDENT (Serializable)
     +--COMMA (,)
     +--IDENT (Comparable)
 

See Also: IDENT DOT COMMA CLASS_DEF ENUM_DEF

IMPORT

public static final int IMPORT
An import declaration. Import declarations are option, but must appear after the package declaration and before the first type declaration.

For example:

   import java.io.IOException;
 

parses as:

 +--IMPORT (import)
     |
     +--DOT (.)
         |
         +--DOT (.)
             |
             +--IDENT (java)
             +--IDENT (io)
         +--IDENT (IOException)
     +--SEMI (;)
 

See Also: Java Language Specification §7.5 DOT IDENT STAR SEMI

INC

public static final int INC
The ++ (prefix increment) operator.

See Also: Java Language Specification, §15.15.1 EXPR POST_INC

INDEX_OP

public static final int INDEX_OP
The array index operator.

For example:

 ar[2] = 5;
 

parses as:

 +--EXPR
     |
     +--ASSIGN (=)
         |
         +--INDEX_OP ([)
             |
             +--IDENT (ar)
             +--EXPR
                 |
                 +--NUM_INT (2)
         +--NUM_INT (5)
 +--SEMI (;)
 

See Also: EXPR

INSTANCE_INIT

public static final int INSTANCE_INIT
An instance initializer. Zero or more instance initializers may appear in class and enum definitions. This token will be a child of the object block of the declaring type.

See Also: Java Language Specification§8.6 SLIST OBJBLOCK

INTERFACE_DEF

public static final int INTERFACE_DEF
An interface declaration.

For example:

   public interface MyInterface
   {
   }

 

parses as:

 +--INTERFACE_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--LITERAL_INTERFACE (interface)
     +--IDENT (MyInterface)
     +--EXTENDS_CLAUSE
     +--OBJBLOCK
         |
         +--LCURLY ({)
         +--RCURLY (})
 

See Also: Java Language Specification, Chapter 9 MODIFIERS IDENT EXTENDS_CLAUSE OBJBLOCK

LABELED_STAT

public static final int LABELED_STAT
A labeled statement.

For example:

 outside: ;
 

parses as:

 +--LABELED_STAT (:)
     |
     +--IDENT (outside)
     +--EMPTY_STAT (;)
 

See Also: Java Language Specification, §14.7 SLIST

LAND

public static final int LAND
The && (conditional AND) operator.

See Also: Java Language Specification, §15.23 EXPR

LCURLY

public static final int LCURLY
A left (curly) brace ({).

See Also: OBJBLOCK ARRAY_INIT SLIST

LE

public static final int LE
The <= (less than or equal) operator.

See Also: EXPR

LITERAL_ASSERT

public static final int LITERAL_ASSERT
The assert keyword. This is only for Java 1.4 and later.

For example:

 assert(x==4);
 

parses as:

 +--LITERAL_ASSERT (assert)
     |
     +--EXPR
         |
         +--LPAREN (()
         +--EQUAL (==)
             |
             +--IDENT (x)
             +--NUM_INT (4)
         +--RPAREN ())
     +--SEMI (;)
 

LITERAL_BOOLEAN

public static final int LITERAL_BOOLEAN
The boolean keyword.

See Also: TYPE

LITERAL_BREAK

public static final int LITERAL_BREAK
The break keyword. The first child is an optional identifier and the last child is a semicolon.

See Also: IDENT SEMI SLIST

LITERAL_BYTE

public static final int LITERAL_BYTE
The byte keyword.

See Also: TYPE

LITERAL_CASE

public static final int LITERAL_CASE
The case keyword. The first child is a constant expression that evaluates to a integer.

See Also: CASE_GROUP EXPR

LITERAL_CATCH

public static final int LITERAL_CATCH
The catch keyword.

See Also: LPAREN PARAMETER_DEF RPAREN SLIST LITERAL_TRY

LITERAL_CHAR

public static final int LITERAL_CHAR
The char keyword.

See Also: TYPE

LITERAL_CLASS

public static final int LITERAL_CLASS
The class keyword. This element appears both as part of a class declaration, and inline to reference a class object.

For example:

 int.class
 

parses as:

 +--EXPR
     |
     +--DOT (.)
         |
         +--LITERAL_INT (int)
         +--LITERAL_CLASS (class)
 

See Also: DOT IDENT CLASS_DEF

LITERAL_CONTINUE

public static final int LITERAL_CONTINUE
The continue keyword. The first child is an optional identifier and the last child is a semicolon.

See Also: IDENT SEMI SLIST

LITERAL_DEFAULT

public static final int LITERAL_DEFAULT
The default keyword. This element has no children.

See Also: CASE_GROUP

LITERAL_DO

public static final int LITERAL_DO
The do keyword. Note the the while token does not appear as part of the do-while construct.

For example:

 do
 {
   x = rand.nextInt(10);
 }
 while(x < 5);
 

parses as:

 +--LITERAL_DO (do)
     |
     +--SLIST ({)
         |
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--IDENT (x)
                 +--METHOD_CALL (()
                     |
                     +--DOT (.)
                         |
                         +--IDENT (rand)
                         +--IDENT (nextInt)
                     +--ELIST
                         |
                         +--EXPR
                             |
                             +--NUM_INT (10)
                     +--RPAREN ())
         +--SEMI (;)
         +--RCURLY (})
     +--LPAREN (()
     +--EXPR
         |
         +--LT (<)
             |
             +--IDENT (x)
             +--NUM_INT (5)
     +--RPAREN ())
     +--SEMI (;)
 

See Also: SLIST EXPR EMPTY_STAT LPAREN RPAREN SEMI

LITERAL_DOUBLE

public static final int LITERAL_DOUBLE
The double keyword.

See Also: TYPE

LITERAL_ELSE

public static final int LITERAL_ELSE
The else keyword. This appears as a child of an if statement.

See Also: SLIST EXPR EMPTY_STAT LITERAL_IF

LITERAL_FALSE

public static final int LITERAL_FALSE
The false keyword.

See Also: Java Language Specification, §3.10.3 EXPR LITERAL_TRUE

LITERAL_FINALLY

public static final int LITERAL_FINALLY
The finally keyword.

See Also: SLIST LITERAL_TRY

LITERAL_FLOAT

public static final int LITERAL_FLOAT
The float keyword.

See Also: TYPE

LITERAL_FOR

public static final int LITERAL_FOR
The for keyword. The children are (, an initializer, a condition, an iterator, a ) and either a statement list, a single expression, or an empty statement.

For example:

 for(int i = 0, n = myArray.length; i < n; i++)
 {
 }
 

parses as:

 +--LITERAL_FOR (for)
     |
     +--LPAREN (()
     +--FOR_INIT
         |
         +--VARIABLE_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--LITERAL_INT (int)
             +--IDENT (i)
             +--ASSIGN (=)
                 |
                 +--EXPR
                     |
                     +--NUM_INT (0)
         +--COMMA (,)
         +--VARIABLE_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--LITERAL_INT (int)
             +--IDENT (n)
             +--ASSIGN (=)
                 |
                 +--EXPR
                     |
                     +--DOT (.)
                         |
                         +--IDENT (myArray)
                         +--IDENT (length)
     +--SEMI (;)
     +--FOR_CONDITION
         |
         +--EXPR
             |
             +--LT (<)
                 |
                 +--IDENT (i)
                 +--IDENT (n)
     +--SEMI (;)
     +--FOR_ITERATOR
         |
         +--ELIST
             |
             +--EXPR
                 |
                 +--POST_INC (++)
                     |
                     +--IDENT (i)
     +--RPAREN ())
     +--SLIST ({)
         |
         +--RCURLY (})
 

See Also: LPAREN FOR_INIT SEMI FOR_CONDITION FOR_ITERATOR RPAREN SLIST EMPTY_STAT EXPR

LITERAL_IF

public static final int LITERAL_IF
The if keyword.

For example:

 if(optimistic)
 {
   message = "half full";
 }
 else
 {
   message = "half empty";
 }
 

parses as:

 +--LITERAL_IF (if)
     |
     +--LPAREN (()
     +--EXPR
         |
         +--IDENT (optimistic)
     +--RPAREN ())
     +--SLIST ({)
         |
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--IDENT (message)
                 +--STRING_LITERAL ("half full")
         +--SEMI (;)
         +--RCURLY (})
     +--LITERAL_ELSE (else)
         |
         +--SLIST ({)
             |
             +--EXPR
                 |
                 +--ASSIGN (=)
                     |
                     +--IDENT (message)
                     +--STRING_LITERAL ("half empty")
             +--SEMI (;)
             +--RCURLY (})
 

See Also: LPAREN EXPR RPAREN SLIST EMPTY_STAT LITERAL_ELSE

LITERAL_INSTANCEOF

public static final int LITERAL_INSTANCEOF
The instanceof operator. The first child is an object reference or something that evaluates to an object reference. The second child is a reference type.

See Also: Java Language Specification, §15.20.2 EXPR METHOD_CALL IDENT DOT TYPE

LITERAL_INT

public static final int LITERAL_INT
The int keyword.

See Also: TYPE

LITERAL_INTERFACE

public static final int LITERAL_INTERFACE
The interface keyword. This token appears in interface definition.

See Also: INTERFACE_DEF

LITERAL_LONG

public static final int LITERAL_LONG
The long keyword.

See Also: TYPE

LITERAL_NATIVE

public static final int LITERAL_NATIVE
The native keyword.

See Also: MODIFIERS

LITERAL_NEW

public static final int LITERAL_NEW
The new keyword. This element is used to define new instances of objects, new arrays, and new anonymous inner classes.

For example:

 new ArrayList(50)
 

parses as:

 +--LITERAL_NEW (new)
     |
     +--IDENT (ArrayList)
     +--LPAREN (()
     +--ELIST
         |
         +--EXPR
             |
             +--NUM_INT (50)
     +--RPAREN ())
 

For example:

 new float[]
   {
     3.0f,
     4.0f
   };
 

parses as:

 +--LITERAL_NEW (new)
     |
     +--LITERAL_FLOAT (float)
     +--ARRAY_DECLARATOR ([)
     +--ARRAY_INIT ({)
         |
         +--EXPR
             |
             +--NUM_FLOAT (3.0f)
         +--COMMA (,)
         +--EXPR
             |
             +--NUM_FLOAT (4.0f)
         +--RCURLY (})
 

For example:

 new FilenameFilter()
 {
   public boolean accept(File dir, String name)
   {
     return name.endsWith(".java");
   }
 }
 

parses as:

 +--LITERAL_NEW (new)
     |
     +--IDENT (FilenameFilter)
     +--LPAREN (()
     +--ELIST
     +--RPAREN ())
     +--OBJBLOCK
         |
         +--LCURLY ({)
         +--METHOD_DEF
             |
             +--MODIFIERS
                 |
                 +--LITERAL_PUBLIC (public)
             +--TYPE
                 |
                 +--LITERAL_BOOLEAN (boolean)
             +--IDENT (accept)
             +--PARAMETERS
                 |
                 +--PARAMETER_DEF
                     |
                     +--MODIFIERS
                     +--TYPE
                         |
                         +--IDENT (File)
                     +--IDENT (dir)
                 +--COMMA (,)
                 +--PARAMETER_DEF
                     |
                     +--MODIFIERS
                     +--TYPE
                         |
                         +--IDENT (String)
                     +--IDENT (name)
             +--SLIST ({)
                 |
                 +--LITERAL_RETURN (return)
                     |
                     +--EXPR
                         |
                         +--METHOD_CALL (()
                             |
                             +--DOT (.)
                                 |
                                 +--IDENT (name)
                                 +--IDENT (endsWith)
                             +--ELIST
                                 |
                                 +--EXPR
                                     |
                                     +--STRING_LITERAL (".java")
                             +--RPAREN ())
                     +--SEMI (;)
                 +--RCURLY (})
         +--RCURLY (})
 

See Also: IDENT DOT LPAREN ELIST RPAREN OBJBLOCK ARRAY_INIT

LITERAL_NULL

public static final int LITERAL_NULL
The null keyword.

See Also: Java Language Specification, §3.10.7 EXPR

LITERAL_PRIVATE

public static final int LITERAL_PRIVATE
The private keyword.

See Also: MODIFIERS

LITERAL_PROTECTED

public static final int LITERAL_PROTECTED
The protected keyword.

See Also: MODIFIERS

LITERAL_PUBLIC

public static final int LITERAL_PUBLIC
The public keyword.

See Also: MODIFIERS

LITERAL_RETURN

public static final int LITERAL_RETURN
The return keyword. The first child is an optional expression for the return value. The last child is a semi colon.

See Also: EXPR SEMI SLIST

LITERAL_SHORT

public static final int LITERAL_SHORT
The short keyword.

See Also: TYPE

LITERAL_STATIC

public static final int LITERAL_STATIC
The static keyword.

See Also: MODIFIERS

LITERAL_SUPER

public static final int LITERAL_SUPER
The super keyword.

See Also: EXPR SUPER_CTOR_CALL

LITERAL_SWITCH

public static final int LITERAL_SWITCH
The switch keyword.

For example:

 switch(type)
 {
   case 0:
     background = Color.blue;
     break;
   case 1:
     background = Color.red;
     break;
   default:
     background = Color.green;
     break;
 }
 

parses as:

 +--LITERAL_SWITCH (switch)
     |
     +--LPAREN (()
     +--EXPR
         |
         +--IDENT (type)
     +--RPAREN ())
     +--LCURLY ({)
     +--CASE_GROUP
         |
         +--LITERAL_CASE (case)
             |
             +--EXPR
                 |
                 +--NUM_INT (0)
         +--SLIST
             |
             +--EXPR
                 |
                 +--ASSIGN (=)
                     |
                     +--IDENT (background)
                     +--DOT (.)
                         |
                         +--IDENT (Color)
                         +--IDENT (blue)
             +--SEMI (;)
             +--LITERAL_BREAK (break)
                 |
                 +--SEMI (;)
     +--CASE_GROUP
         |
         +--LITERAL_CASE (case)
             |
             +--EXPR
                 |
                 +--NUM_INT (1)
         +--SLIST
             |
             +--EXPR
                 |
                 +--ASSIGN (=)
                     |
                     +--IDENT (background)
                     +--DOT (.)
                         |
                         +--IDENT (Color)
                         +--IDENT (red)
             +--SEMI (;)
             +--LITERAL_BREAK (break)
                 |
                 +--SEMI (;)
     +--CASE_GROUP
         |
         +--LITERAL_DEFAULT (default)
         +--SLIST
             |
             +--EXPR
                 |
                 +--ASSIGN (=)
                     |
                     +--IDENT (background)
                     +--DOT (.)
                         |
                         +--IDENT (Color)
                         +--IDENT (green)
             +--SEMI (;)
             +--LITERAL_BREAK (break)
                 |
                 +--SEMI (;)
     +--RCURLY (})
 

See Also: Java Language Specification, §14.10 LPAREN EXPR RPAREN LCURLY CASE_GROUP RCURLY SLIST

LITERAL_SYNCHRONIZED

public static final int LITERAL_SYNCHRONIZED
The synchronized keyword. This may be used as a modifier of a method or in the definition of a synchronized block.

For example:

 synchronized(this)
 {
   x++;
 }
 

parses as:

 +--LITERAL_SYNCHRONIZED (synchronized)
     |
     +--LPAREN (()
     +--EXPR
         |
         +--LITERAL_THIS (this)
     +--RPAREN ())
     +--SLIST ({)
         |
         +--EXPR
             |
             +--POST_INC (++)
                 |
                 +--IDENT (x)
         +--SEMI (;)
         +--RCURLY (})
 +--RCURLY (})
 

See Also: MODIFIERS LPAREN EXPR RPAREN SLIST RCURLY

LITERAL_THIS

public static final int LITERAL_THIS
The this keyword.

See Also: EXPR CTOR_CALL

LITERAL_THROW

public static final int LITERAL_THROW
The throw keyword. The first child is an expression that evaluates to a Throwable instance.

See Also: Java Language Specification, §14.17 SLIST EXPR

LITERAL_THROWS

public static final int LITERAL_THROWS
The throws keyword. The children are a number of one or more identifiers separated by commas.

See Also: Java Language Specification, §8.4.4 IDENT DOT COMMA METHOD_DEF CTOR_DEF

LITERAL_TRANSIENT

public static final int LITERAL_TRANSIENT
The transient keyword.

See Also: MODIFIERS

LITERAL_TRUE

public static final int LITERAL_TRUE
The true keyword.

See Also: Java Language Specification, §3.10.3 EXPR LITERAL_FALSE

LITERAL_TRY

public static final int LITERAL_TRY
The try keyword. The children are a statement list, zero or more catch blocks and then an optional finally block.

For example:

 try
 {
   FileReader in = new FileReader("abc.txt");
 }
 catch(IOException ioe)
 {
 }
 finally
 {
 }
 

parses as:

 +--LITERAL_TRY (try)
     |
     +--SLIST ({)
         |
         +--VARIABLE_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--IDENT (FileReader)
             +--IDENT (in)
             +--ASSIGN (=)
                 |
                 +--EXPR
                     |
                     +--LITERAL_NEW (new)
                         |
                         +--IDENT (FileReader)
                         +--LPAREN (()
                         +--ELIST
                             |
                             +--EXPR
                                 |
                                 +--STRING_LITERAL ("abc.txt")
                         +--RPAREN ())
         +--SEMI (;)
         +--RCURLY (})
     +--LITERAL_CATCH (catch)
         |
         +--LPAREN (()
         +--PARAMETER_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--IDENT (IOException)
             +--IDENT (ioe)
         +--RPAREN ())
         +--SLIST ({)
             |
             +--RCURLY (})
     +--LITERAL_FINALLY (finally)
         |
         +--SLIST ({)
             |
             +--RCURLY (})
 +--RCURLY (})
 

See Also: Java Language Specification, §14.19 SLIST LITERAL_CATCH LITERAL_FINALLY

LITERAL_VOID

public static final int LITERAL_VOID
The void keyword.

See Also: TYPE

LITERAL_VOLATILE

public static final int LITERAL_VOLATILE
The volatile keyword.

See Also: MODIFIERS

LITERAL_WHILE

public static final int LITERAL_WHILE
The while keyword.

For example:

 while(line != null)
 {
   process(line);
   line = in.readLine();
 }
 

parses as:

 +--LITERAL_WHILE (while)
     |
     +--LPAREN (()
     +--EXPR
         |
         +--NOT_EQUAL (!=)
             |
             +--IDENT (line)
             +--LITERAL_NULL (null)
     +--RPAREN ())
     +--SLIST ({)
         |
         +--EXPR
             |
             +--METHOD_CALL (()
                 |
                 +--IDENT (process)
                 +--ELIST
                     |
                     +--EXPR
                         |
                         +--IDENT (line)
                 +--RPAREN ())
         +--SEMI (;)
         +--EXPR
             |
             +--ASSIGN (=)
                 |
                 +--IDENT (line)
                 +--METHOD_CALL (()
                     |
                     +--DOT (.)
                         |
                         +--IDENT (in)
                         +--IDENT (readLine)
                     +--ELIST
                     +--RPAREN ())
         +--SEMI (;)
         +--RCURLY (})
 

LNOT

public static final int LNOT
The ! (logical complement) operator.

See Also: Java Language Specification, §15.15.6 EXPR

LOR

public static final int LOR
The || (conditional OR) operator.

See Also: Java Language Specification, §15.24 EXPR

LPAREN

public static final int LPAREN
A left parenthesis (().

See Also: LITERAL_FOR LITERAL_NEW EXPR LITERAL_SWITCH LITERAL_CATCH

LT

public static final int LT
The < (less than) operator.

See Also: EXPR

METHOD_CALL

public static final int METHOD_CALL
A method call. A method call may have type arguments however these are attached to the appropriate node in the qualified method name.

For example:

 Math.random()
 

parses as:

 +--METHOD_CALL (()
     |
     +--DOT (.)
         |
         +--IDENT (Math)
         +--IDENT (random)
     +--ELIST
     +--RPAREN ())
 

See Also: IDENT TYPE_ARGUMENTS DOT ELIST RPAREN

METHOD_DEF

public static final int METHOD_DEF
A method declaration. The children are modifiers, type parameters, return type, method name, parameter list, an optional throws list, and statement list. The statement list is omitted if the method declaration appears in an interface declaration. Method declarations may appear inside object blocks of class declarations, interface declarations, enum declarations, enum constant declarations or anonymous inner-class declarations.

For example:

  public static int square(int x)
  {
    return x*x;
  }
 

parses as:

 +--METHOD_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
         +--LITERAL_STATIC (static)
     +--TYPE
         |
         +--LITERAL_INT (int)
     +--IDENT (square)
     +--PARAMETERS
         |
         +--PARAMETER_DEF
             |
             +--MODIFIERS
             +--TYPE
                 |
                 +--LITERAL_INT (int)
             +--IDENT (x)
     +--SLIST ({)
         |
         +--LITERAL_RETURN (return)
             |
             +--EXPR
                 |
                 +--STAR (*)
                     |
                     +--IDENT (x)
                     +--IDENT (x)
             +--SEMI (;)
         +--RCURLY (})
 

See Also: MODIFIERS TYPE_PARAMETERS TYPE IDENT PARAMETERS LITERAL_THROWS SLIST OBJBLOCK

MINUS

public static final int MINUS
The - (subtraction) operator.

See Also: Java Language Specification, §15.18 EXPR

MINUS_ASSIGN

public static final int MINUS_ASSIGN
The -= (subtraction assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

MOD

public static final int MOD
The % (remainder) operator.

See Also: Java Language Specification, §15.17.3 EXPR

MODIFIERS

public static final int MODIFIERS
Modifiers for type, method, and field declarations. The modifiers element is always present even though it may have no children.

See Also: Java Language Specification, Chapter 8 LITERAL_PUBLIC LITERAL_PROTECTED LITERAL_PRIVATE ABSTRACT LITERAL_STATIC FINAL LITERAL_TRANSIENT LITERAL_VOLATILE LITERAL_SYNCHRONIZED LITERAL_NATIVE STRICTFP ANNOTATION

MOD_ASSIGN

public static final int MOD_ASSIGN
The %= (remainder assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

NOT_EQUAL

public static final int NOT_EQUAL
The != (not equal) operator.

See Also: EXPR

NUM_DOUBLE

public static final int NUM_DOUBLE
A double precision floating point literal. This is a floating point number with an optional D or d suffix.

See Also: Java Language Specification, §3.10.2 EXPR NUM_FLOAT

NUM_FLOAT

public static final int NUM_FLOAT
A single precision floating point literal. This is a floating point number with an F or f suffix.

See Also: Java Language Specification, §3.10.2 EXPR NUM_DOUBLE

NUM_INT

public static final int NUM_INT
An integer literal. These may be specified in decimal, hexadecimal, or octal form.

See Also: Java Language Specification, §3.10.1 EXPR NUM_LONG

NUM_LONG

public static final int NUM_LONG
A long integer literal. These are almost the same as integer literals, but they have an L or l (ell) suffix.

See Also: Java Language Specification, §3.10.1 EXPR NUM_INT

OBJBLOCK

public static final int OBJBLOCK
An object block. These are children of class, interface, enum, annotation and enum constant declarations. Also, object blocks are children of the new keyword when defining anonymous inner types.

See Also: LCURLY INSTANCE_INIT STATIC_INIT CLASS_DEF CTOR_DEF METHOD_DEF VARIABLE_DEF RCURLY INTERFACE_DEF LITERAL_NEW ENUM_DEF ENUM_CONSTANT_DEF ANNOTATION_DEF

PACKAGE_DEF

public static final int PACKAGE_DEF
The package declaration. This is optional, but if it is included, then there is only one package declaration per source file and it must be the first non-comment in the file. A package declaration may be annotated in which case the annotations comes before the rest of the declaration (and are the first children).

For example:

   package com.puppycrawl.tools.checkstyle.api;
 

parses as:

 +--PACKAGE_DEF (package)
     |
     +--ANNOTATIONS
     +--DOT (.)
         |
         +--DOT (.)
             |
             +--DOT (.)
                 |
                 +--DOT (.)
                     |
                     +--IDENT (com)
                     +--IDENT (puppycrawl)
                 +--IDENT (tools)
             +--IDENT (checkstyle)
         +--IDENT (api)
     +--SEMI (;)
 

See Also: Java Language Specification §7.4 DOT IDENT SEMI ANNOTATIONS

PARAMETERS

public static final int PARAMETERS
A list of parameters to a method or constructor. The children are zero or more parameter declarations separated by commas.

For example

 int start, int end
 

parses as:

 +--PARAMETERS
     |
     +--PARAMETER_DEF
         |
         +--MODIFIERS
         +--TYPE
             |
             +--LITERAL_INT (int)
         +--IDENT (start)
     +--COMMA (,)
     +--PARAMETER_DEF
         |
         +--MODIFIERS
         +--TYPE
             |
             +--LITERAL_INT (int)
         +--IDENT (end)
 

See Also: PARAMETER_DEF COMMA METHOD_DEF CTOR_DEF

PARAMETER_DEF

public static final int PARAMETER_DEF
A parameter declaration. The last parameter in a list of parameters may be variable length (indicated by the ELLIPSIS child node immediately after the TYPE child).

See Also: MODIFIERS TYPE IDENT PARAMETERS ELLIPSIS

PLUS

public static final int PLUS
The + (addition) operator.

See Also: Java Language Specification, §15.18 EXPR

PLUS_ASSIGN

public static final int PLUS_ASSIGN
The += (addition assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

POST_DEC

public static final int POST_DEC
The -- (postfix decrement) operator.

See Also: Java Language Specification, §15.14.2 EXPR DEC

POST_INC

public static final int POST_INC
The ++ (postfix increment) operator.

See Also: Java Language Specification, §15.14.1 EXPR INC

QUESTION

public static final int QUESTION
The ? (conditional) operator. Technically, the colon is also part of this operator, but it appears as a separate token.

For example:

 (quantity == 1) ? "": "s"
 

parses as:

 +--QUESTION (?)
     |
     +--LPAREN (()
     +--EQUAL (==)
         |
         +--IDENT (quantity)
         +--NUM_INT (1)
     +--RPAREN ())
     +--STRING_LITERAL ("")
     +--COLON (:)
     +--STRING_LITERAL ("s")
 

See Also: Java Language Specification, §15.25 EXPR COLON

RBRACK

public static final int RBRACK
The ] symbol.

See Also: INDEX_OP ARRAY_DECLARATOR

RCURLY

public static final int RCURLY
A right (curly) brace (}).

See Also: OBJBLOCK ARRAY_INIT SLIST

RPAREN

public static final int RPAREN
A right parenthesis ()).

See Also: LITERAL_FOR LITERAL_NEW METHOD_CALL TYPECAST EXPR LITERAL_SWITCH LITERAL_CATCH

SEMI

public static final int SEMI
The statement terminator (;). Depending on the context, this make occur as a sibling, a child, or not at all.

See Also: PACKAGE_DEF IMPORT SLIST ARRAY_INIT LITERAL_FOR

SL

public static final int SL
The << (shift left) operator.

See Also: Java Language Specification, §15.19 EXPR

SLIST

public static final int SLIST
A list of statements.

See Also: RCURLY EXPR LABELED_STAT LITERAL_THROWS LITERAL_RETURN SEMI METHOD_DEF CTOR_DEF LITERAL_FOR LITERAL_WHILE LITERAL_IF LITERAL_ELSE CASE_GROUP

SL_ASSIGN

public static final int SL_ASSIGN
The <<= (left shift assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

SR

public static final int SR
The >> (signed shift right) operator.

See Also: Java Language Specification, §15.19 EXPR

SR_ASSIGN

public static final int SR_ASSIGN
The >>= (signed right shift assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

STAR

public static final int STAR
The * (multiplication or wildcard) operator.

See Also: Java Language Specification, §7.5.2 Java Language Specification, §15.17.1 EXPR IMPORT

STAR_ASSIGN

public static final int STAR_ASSIGN
The *= (multiplication assignment) operator.

See Also: Java Language Specification, §15.26.2 EXPR

STATIC_IMPORT

public static final int STATIC_IMPORT
A static import declaration. Static import declarations are optional, but must appear after the package declaration and before the type declaration.

For example:

   import static java.io.IOException;
 

parses as:

 +--STATIC_IMPORT (import)
     |
     +--LITERAL_STATIC
     +--DOT (.)
         |
         +--DOT (.)
             |
             +--IDENT (java)
             +--IDENT (io)
         +--IDENT (IOException)
     +--SEMI (;)
 

See Also: JSR201 LITERAL_STATIC DOT IDENT STAR SEMI

STATIC_INIT

public static final int STATIC_INIT
A static initialization block. Zero or more static initializers may be children of the object block of a class or enum declaration (interfaces cannot have static initializers). The first and only child is a statement list.

See Also: Java Language Specification, §8.7 SLIST OBJBLOCK

STRICTFP

public static final int STRICTFP
The strictfp keyword.

See Also: MODIFIERS

STRING_LITERAL

public static final int STRING_LITERAL
A string literal. This is a sequence of (possibly escaped) characters enclosed in double quotes.

See Also: Java Language Specification, §3.10.5 EXPR

SUPER_CTOR_CALL

public static final int SUPER_CTOR_CALL
A super constructor call.

See Also: ELIST RPAREN SEMI CTOR_CALL

TYPE

public static final int TYPE
A type. This is either a return type of a method or a type of a variable or field. The first child of this element is the actual type. This may be a primitive type, an identifier, a dot which is the root of a fully qualified type, or an array of any of these. The second child may be type arguments to the type.

See Also: VARIABLE_DEF METHOD_DEF PARAMETER_DEF IDENT DOT LITERAL_VOID LITERAL_BOOLEAN LITERAL_BYTE LITERAL_CHAR LITERAL_SHORT LITERAL_INT LITERAL_FLOAT LITERAL_LONG LITERAL_DOUBLE ARRAY_DECLARATOR TYPE_ARGUMENTS

TYPECAST

public static final int TYPECAST
A type-cast.

For example:

 (String)it.next()
 

parses as:

 +--TYPECAST (()
     |
     +--TYPE
         |
         +--IDENT (String)
     +--RPAREN ())
     +--METHOD_CALL (()
         |
         +--DOT (.)
             |
             +--IDENT (it)
             +--IDENT (next)
         +--ELIST
         +--RPAREN ())
 

See Also: Java Language Specification, §15.16 EXPR TYPE TYPE_ARGUMENTS RPAREN

TYPE_ARGUMENT

public static final int TYPE_ARGUMENT
A type arguments to a type reference or a method/ctor invocation. Children are either: type name or wildcard type with possible type upper or lower bounds.

For example:

     ? super List
 

parses as:

 +--TYPE_ARGUMENT
     |
     +--WILDCARD_TYPE (?)
     +--TYPE_LOWER_BOUNDS
         |
         +--IDENT (List)
 

See Also: JSR14 WILDCARD_TYPE TYPE_UPPER_BOUNDS TYPE_LOWER_BOUNDS

TYPE_ARGUMENTS

public static final int TYPE_ARGUMENTS
A list of type arguments to a type reference or a method/ctor invocation. Children are GENERIC_START, at least one TYPE_ARGUMENT, zero or more of a COMMAs followed by a single TYPE_ARGUMENT, and a final GENERIC_END.

For example:

     public Collection a;
 

parses as:

 +--VARIABLE_DEF
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--TYPE
         |
         +--IDENT (Collection)
             |
             +--TYPE_ARGUMENTS
                 |
                 +--GENERIC_START (<)
                 +--TYPE_ARGUMENT
                     |
                     +--WILDCARD_TYPE (?)
                 +--GENERIC_END (>)
     +--IDENT (a)
     +--SEMI (;)
 

See Also: GENERIC_START GENERIC_END TYPE_ARGUMENT COMMA

TYPE_EXTENSION_AND

public static final int TYPE_EXTENSION_AND
'&' symbol when used in a generic upper or lower bounds constrain e.g. Comparable.

TYPE_LOWER_BOUNDS

public static final int TYPE_LOWER_BOUNDS
A lower bounds on a wildcard type argument. This node has one child - the type that is being used for the bounding.

See Also: JSR14 TYPE_ARGUMENT WILDCARD_TYPE

TYPE_PARAMETER

public static final int TYPE_PARAMETER
A type parameter to a class, interface or method definition. Children are the type name and an optional TYPE_UPPER_BOUNDS.

For example:

     A extends Collection
 

parses as:

 +--TYPE_PARAMETER
     |
     +--IDENT (A)
     +--TYPE_UPPER_BOUNDS
         |
         +--IDENT (Collection)
 

See Also: JSR14 IDENT WILDCARD_TYPE TYPE_UPPER_BOUNDS

TYPE_PARAMETERS

public static final int TYPE_PARAMETERS
A list of type parameters to a class, interface or method definition. Children are LT, at least one TYPE_PARAMETER, zero or more of: a COMMAs followed by a single TYPE_PARAMETER and a final GT.

For example:

     public class Blah<A, B>
     {
     }
 

parses as:

 +--CLASS_DEF ({)
     |
     +--MODIFIERS
         |
         +--LITERAL_PUBLIC (public)
     +--LITERAL_CLASS (class)
     +--IDENT (Blah)
     +--TYPE_PARAMETERS
         |
         +--GENERIC_START (<)
         +--TYPE_PARAMETER
             |
             +--IDENT (A)
         +--COMMA (,)
         +--TYPE_PARAMETER
             |
             +--IDENT (B)
         +--GENERIC_END (>)
     +--OBJBLOCK
         |
         +--LCURLY ({)
     +--NUM_INT (1)
     +--COMMA (,)
     +--NUM_INT (2)
     +--RCURLY (})
 

See Also: JSR14 GENERIC_START GENERIC_END TYPE_PARAMETER COMMA

TYPE_UPPER_BOUNDS

public static final int TYPE_UPPER_BOUNDS
An upper bounds on a wildcard type argument or type parameter. This node has one child - the type that is being used for the bounding.

See Also: JSR14 TYPE_PARAMETER TYPE_ARGUMENT WILDCARD_TYPE

UNARY_MINUS

public static final int UNARY_MINUS
The + (unary plus) operator.

See Also: Java Language Specification, §15.15.3 EXPR

UNARY_PLUS

public static final int UNARY_PLUS
The - (unary minus) operator.

See Also: Java Language Specification, §15.15.4 EXPR

VARIABLE_DEF

public static final int VARIABLE_DEF
A field or local variable declaration. The children are modifiers, type, the identifier name, and an optional assignment statement.

See Also: MODIFIERS TYPE IDENT ASSIGN

WILDCARD_TYPE

public static final int WILDCARD_TYPE
The type that refers to all types. This node has no children.

See Also: JSR14 TYPE_ARGUMENT TYPE_UPPER_BOUNDS TYPE_LOWER_BOUNDS

Method Detail

getShortDescription

public static String getShortDescription(String aName)
Returns the short description of a token for a given name.

Parameters: aName the name of the token ID to get

Returns: a short description

getTokenId

public static int getTokenId(String aName)
Returns the ID of a token for a given name.

Parameters: aName the name of the token ID to get

Returns: a token ID

getTokenName

public static String getTokenName(int aID)
Returns the name of a token for a given ID.

Parameters: aID the ID of the token name to get

Returns: a token name