com.cburch.editor.scanners
Enum JavaTokenType

java.lang.Object
  java.lang.Enum<JavaTokenType>
      com.cburch.editor.scanners.JavaTokenType

All Implemented Interfaces:

TokenType, java.io.Serializable, java.lang.Comparable<JavaTokenType>

public enum JavaTokenType
extends java.lang.Enum<JavaTokenType>
implements TokenType

Defines the different categories of tokens that might be encountered in Java source code. You can find additional documentation for all of these from the Java Language Specification.

Version:

0.1 2005-05-31

Author:

Carl Burch

Enum Constant Summary

ABSTRACT
The abstract keyword.

ADD_ASSIGN
The '+=' operator.

AMPERSAND
The '&' operator.

AND_ASSIGN
The '&=' operator.

ASSERT
The assert keyword, introduced in Java 1.4.

ASSIGN
The '=' operator.

BOOLEAN
The boolean keyword.

BOOLEAN_LITERAL
A boolean value.

BREAK
The break keyword.

BYTE
The byte keyword.

CARET
The '^' operator.

CASE
The case keyword.

CATCH
The catch keyword.

CHAR
The char keyword.

CHARACTER_LITERAL
A char value.

CLASS
The class keyword.

COLON
The ':' operator, in the ternary ?: operation.

COMMA
The ',' separator.

COMMENT_END_OF_LINE
A single-line comment beginning with "//".

COMMENT_TRADITIONAL
A ``traditional'' comment beginning with "/*".

CONST
The const keyword.

CONTINUE
The continue keyword.

DECREMENT
The '--' operator.

DEFAULT
The default keyword.

DIVIDE_ASSIGN
The '/=' operator.

DO
The do keyword.

DOUBLE
The double keyword.

DOUBLE_LITERAL
A double value.

ELSE
The else keyword.

ENUM
The enum keyword, introduced with Java 1.5.

ERROR
A sequence of invalid characters.

EXCLAMATION
The '!' operator.

EXTENDS
The extends keyword.

FINAL
The final keyword.

FINALLY
The finally keyword.

FLOAT
The float keyword.

FLOAT_LITERAL
A float value.

FOR
The for keyword.

GOTO
The goto keyword.

IDENTIFIER
An identifier.

IF
The if keyword.

IMPLEMENTS
The implements keyword.

IMPORT
The import keyword.

INCREMENT
The '++' operator.

INSTANCEOF
The instanceof keyword.

INT
The int keyword.

INTEGER_LITERAL
An int value.

INTERFACE
The interface keyword.

IS_EQUAL
The '==' operator.

IS_GREATER_EQUAL
The '>=' operator.

IS_LESS_EQUAL
The '<=' operator.

IS_NOT_EQUAL
The '!=' operator.

JAVADOC
A Javadoc comment.

LANGLE
The '<' operator.

LBRACE
The '{' separator.

LBRACKET
The '[' separator.

LOGICAL_AND
The '&&' operator.

LOGICAL_OR
The '||' operator.

LONG
The long keyword.

LONG_LITERAL
A long value.

LPAREN
The '(' separator.

MINUS
The '-' operator.

MOD_ASSIGN
The '%=' operator.

MULTIPLY_ASSIGN
The '*=' operator.

NATIVE
The native keyword.

NEW
The new keyword.

NULL
The null reserved word.

OR_ASSIGN
The '|=' operator.

PACKAGE
The package keyword.

PERCENT
The '%' operator.

PERIOD
The '.' separator.

PLUS
The '+' operator.

PRIVATE
The private keyword.

PROTECTED
The protected keyword.

PUBLIC
The public keyword.

QUESTION
The '?' operator, appearing in the ?: operation.

RANGLE
The '>' operator.

RBRACE
The '}' separator.

RBRACKET
The ']' separator.

RETURN
The return keyword.

RPAREN
The ')' separator.

SEMICOLON
The ';' separator.

SHIFT_LEFT
The '<<' operator.

SHIFT_LEFT_ASSIGN
The '<<=' operator.

SHIFT_RIGHT
The '>>' operator.

SHIFT_RIGHT_ASSIGN
The '>>=' operator.

SHIFT_RIGHT_LOGICAL
The '>>>' operator.

SHIFT_RIGHT_LOGICAL_ASSIGN
The '>>>=' operator.

SHORT
The short keyword.

SLASH
The '/' operator.

STAR
The '*' operator.

STATIC
The static keyword.

STRICTFP
The strictfp keyword.

STRING_LITERAL
A String value.

SUBTRACT_ASSIGN
The '-=' operator.

SUPER
The super keyword.

SWITCH
The switch keyword.

SYNCHRONIZED
The synchronized keyword.

THIS
The this keyword.

THROW
The throw keyword.

THROWS
The throws keyword.

TILDE
The '~' operator.

TRANSIENT
The transient keyword.

TRY
The try keyword.

VERTICAL_BAR
The '|' operator.

VOID
The void keyword.

VOLATILE
The volatile keyword.

WHILE
The while keyword.

XOR_ASSIGN
The '^=' operator.

Method Summary

static JavaTokenType	forKeyword(java.lang.String text) Returns the token type corresponding to this word-like string, which should be either an identifier, a keyword, or reserved word.
javax.swing.text.AttributeSet	getAttributeSet() Return the style in which tokens of this type should be drawn.
java.lang.String	getDescriptor() Returns a terse description of what sort of token this corresponds to.
static JavaTokenType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JavaTokenType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABSTRACT

public static final JavaTokenType ABSTRACT

The abstract keyword.

ASSERT

public static final JavaTokenType ASSERT

The assert keyword, introduced in Java 1.4.

BOOLEAN

public static final JavaTokenType BOOLEAN

The boolean keyword.

BREAK

public static final JavaTokenType BREAK

The break keyword.

BYTE

public static final JavaTokenType BYTE

The byte keyword.

CASE

public static final JavaTokenType CASE

The case keyword.

CATCH

public static final JavaTokenType CATCH

The catch keyword.

CHAR

public static final JavaTokenType CHAR

The char keyword.

CLASS

public static final JavaTokenType CLASS

The class keyword.

CONST

public static final JavaTokenType CONST

The const keyword.

CONTINUE

public static final JavaTokenType CONTINUE

The continue keyword.

DEFAULT

public static final JavaTokenType DEFAULT

The default keyword.

DO

public static final JavaTokenType DO

The do keyword.

DOUBLE

public static final JavaTokenType DOUBLE

The double keyword.

ELSE

public static final JavaTokenType ELSE

The else keyword.

ENUM

public static final JavaTokenType ENUM

The enum keyword, introduced with Java 1.5.

EXTENDS

public static final JavaTokenType EXTENDS

The extends keyword.

FINAL

public static final JavaTokenType FINAL

The final keyword.

FINALLY

public static final JavaTokenType FINALLY

The finally keyword.

FLOAT

public static final JavaTokenType FLOAT

The float keyword.

FOR

public static final JavaTokenType FOR

The for keyword.

GOTO

public static final JavaTokenType GOTO

The goto keyword.

IF

public static final JavaTokenType IF

The if keyword.

IMPLEMENTS

public static final JavaTokenType IMPLEMENTS

The implements keyword.

IMPORT

public static final JavaTokenType IMPORT

The import keyword.

INSTANCEOF

public static final JavaTokenType INSTANCEOF

The instanceof keyword.

INT

public static final JavaTokenType INT

The int keyword.

INTERFACE

public static final JavaTokenType INTERFACE

The interface keyword.

LONG

public static final JavaTokenType LONG

The long keyword.

NATIVE

public static final JavaTokenType NATIVE

The native keyword.

NEW

public static final JavaTokenType NEW

The new keyword.

PACKAGE

public static final JavaTokenType PACKAGE

The package keyword.

PRIVATE

public static final JavaTokenType PRIVATE

The private keyword.

PROTECTED

public static final JavaTokenType PROTECTED

The protected keyword.

PUBLIC

public static final JavaTokenType PUBLIC

The public keyword.

RETURN

public static final JavaTokenType RETURN

The return keyword.

SHORT

public static final JavaTokenType SHORT

The short keyword.

STATIC

public static final JavaTokenType STATIC

The static keyword.

STRICTFP

public static final JavaTokenType STRICTFP

The strictfp keyword.

SUPER

public static final JavaTokenType SUPER

The super keyword.

SWITCH

public static final JavaTokenType SWITCH

The switch keyword.

SYNCHRONIZED

public static final JavaTokenType SYNCHRONIZED

The synchronized keyword.

THIS

public static final JavaTokenType THIS

The this keyword.

THROW

public static final JavaTokenType THROW

The throw keyword.

THROWS

public static final JavaTokenType THROWS

The throws keyword.

TRANSIENT

public static final JavaTokenType TRANSIENT

The transient keyword.

TRY

public static final JavaTokenType TRY

The try keyword.

VOID

public static final JavaTokenType VOID

The void keyword.

VOLATILE

public static final JavaTokenType VOLATILE

The volatile keyword.

WHILE

public static final JavaTokenType WHILE

The while keyword.

NULL

public static final JavaTokenType NULL

The null reserved word.

LBRACE

public static final JavaTokenType LBRACE

The '{' separator.

RBRACE

public static final JavaTokenType RBRACE

The '}' separator.

LBRACKET

public static final JavaTokenType LBRACKET

The '[' separator.

RBRACKET

public static final JavaTokenType RBRACKET

The ']' separator.

LPAREN

public static final JavaTokenType LPAREN

The '(' separator.

RPAREN

public static final JavaTokenType RPAREN

The ')' separator.

SEMICOLON

public static final JavaTokenType SEMICOLON

The ';' separator.

COMMA

public static final JavaTokenType COMMA

The ',' separator.

PERIOD

public static final JavaTokenType PERIOD

The '.' separator.

LANGLE

public static final JavaTokenType LANGLE

The '<' operator.

RANGLE

public static final JavaTokenType RANGLE

The '>' operator.

COLON

public static final JavaTokenType COLON

The ':' operator, in the ternary ?: operation.

ASSIGN

public static final JavaTokenType ASSIGN

The '=' operator.

PLUS

public static final JavaTokenType PLUS

The '+' operator.

MINUS

public static final JavaTokenType MINUS

The '-' operator.

STAR

public static final JavaTokenType STAR

The '*' operator.

SLASH

public static final JavaTokenType SLASH

The '/' operator.

PERCENT

public static final JavaTokenType PERCENT

The '%' operator.

VERTICAL_BAR

public static final JavaTokenType VERTICAL_BAR

The '|' operator.

AMPERSAND

public static final JavaTokenType AMPERSAND

The '&' operator.

CARET

public static final JavaTokenType CARET

The '^' operator.

TILDE

public static final JavaTokenType TILDE

The '~' operator.

EXCLAMATION

public static final JavaTokenType EXCLAMATION

The '!' operator.

QUESTION

public static final JavaTokenType QUESTION

The '?' operator, appearing in the ?: operation.

IS_EQUAL

public static final JavaTokenType IS_EQUAL

The '==' operator.

IS_LESS_EQUAL

public static final JavaTokenType IS_LESS_EQUAL

The '<=' operator.

IS_GREATER_EQUAL

public static final JavaTokenType IS_GREATER_EQUAL

The '>=' operator.

IS_NOT_EQUAL

public static final JavaTokenType IS_NOT_EQUAL

The '!=' operator.

INCREMENT

public static final JavaTokenType INCREMENT

The '++' operator.

DECREMENT

public static final JavaTokenType DECREMENT

The '--' operator.

SHIFT_LEFT

public static final JavaTokenType SHIFT_LEFT

The '<<' operator.

SHIFT_RIGHT

public static final JavaTokenType SHIFT_RIGHT

The '>>' operator.

SHIFT_RIGHT_LOGICAL

public static final JavaTokenType SHIFT_RIGHT_LOGICAL

The '>>>' operator.

LOGICAL_AND

public static final JavaTokenType LOGICAL_AND

The '&&' operator.

LOGICAL_OR

public static final JavaTokenType LOGICAL_OR

The '||' operator.

ADD_ASSIGN

public static final JavaTokenType ADD_ASSIGN

The '+=' operator.

SUBTRACT_ASSIGN

public static final JavaTokenType SUBTRACT_ASSIGN

The '-=' operator.

MULTIPLY_ASSIGN

public static final JavaTokenType MULTIPLY_ASSIGN

The '*=' operator.

DIVIDE_ASSIGN

public static final JavaTokenType DIVIDE_ASSIGN

The '/=' operator.

MOD_ASSIGN

public static final JavaTokenType MOD_ASSIGN

The '%=' operator.

AND_ASSIGN

public static final JavaTokenType AND_ASSIGN

The '&=' operator.

OR_ASSIGN

public static final JavaTokenType OR_ASSIGN

The '|=' operator.

XOR_ASSIGN

public static final JavaTokenType XOR_ASSIGN

The '^=' operator.

SHIFT_LEFT_ASSIGN

public static final JavaTokenType SHIFT_LEFT_ASSIGN

The '<<=' operator.

SHIFT_RIGHT_ASSIGN

public static final JavaTokenType SHIFT_RIGHT_ASSIGN

The '>>=' operator.

SHIFT_RIGHT_LOGICAL_ASSIGN

public static final JavaTokenType SHIFT_RIGHT_LOGICAL_ASSIGN

The '>>>=' operator.

STRING_LITERAL

public static final JavaTokenType STRING_LITERAL

A String value.

CHARACTER_LITERAL

public static final JavaTokenType CHARACTER_LITERAL

A char value.

BOOLEAN_LITERAL

public static final JavaTokenType BOOLEAN_LITERAL

A boolean value.

INTEGER_LITERAL

public static final JavaTokenType INTEGER_LITERAL

An int value.

LONG_LITERAL

public static final JavaTokenType LONG_LITERAL

A long value.

FLOAT_LITERAL

public static final JavaTokenType FLOAT_LITERAL

A float value.

DOUBLE_LITERAL

public static final JavaTokenType DOUBLE_LITERAL

A double value.

IDENTIFIER

public static final JavaTokenType IDENTIFIER

An identifier.

JAVADOC

public static final JavaTokenType JAVADOC

A Javadoc comment.

COMMENT_TRADITIONAL

public static final JavaTokenType COMMENT_TRADITIONAL

A ``traditional'' comment beginning with "/*".

COMMENT_END_OF_LINE

public static final JavaTokenType COMMENT_END_OF_LINE

A single-line comment beginning with "//".

ERROR

public static final JavaTokenType ERROR

A sequence of invalid characters.

Method Detail

values

public static final JavaTokenType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(JavaTokenType c : JavaTokenType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static JavaTokenType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getDescriptor

public java.lang.String getDescriptor()

Returns a terse description of what sort of token this corresponds to.

Returns:

the terse description.

getAttributeSet

public javax.swing.text.AttributeSet getAttributeSet()

Return the style in which tokens of this type should be drawn.

Specified by:

getAttributeSet in interface TokenType

Returns:

the style for tokens of this type.

forKeyword

public static JavaTokenType forKeyword(java.lang.String text)

Returns the token type corresponding to this word-like string, which should be either an identifier, a keyword, or reserved word.

Parameters:

text - the word to look up.

Returns:

the corresponding token type.