Package org.eclipse.persistence.jpa.jpql

Enum WordParser.WordType

java.lang.Object

java.lang.Enum<WordParser.WordType>

org.eclipse.persistence.jpa.jpql.WordParser.WordType

All Implemented Interfaces:

Serializable, Comparable<WordParser.WordType>

Enclosing class:

WordParser

public static enum WordParser.WordType
extends Enum<WordParser.WordType>

This enumeration determines the type of word that was scanned. It will be set by WordParser.word(), WordParser.wordEndPosition(), WordParser.wordEndPosition(int).

Enum Constant Summary

Enum Constants

Enum Constant	Description
INPUT_PARAMETER	The word being scanned is an input parameter, it starts with either ':' or '?'.
NUMERIC_LITERAL	The word being scanned is a numeric literal (decimal or hexadecimal number).
STRING_LITERAL	The word being scanned is a string literal, it starts with either ''' or '"'.
UNDEFINED	No word was scanned, this is usually set when the cursor is at the end of the text.
WORD	The word being scanned anything else other than an input parameter, numeric literal or string literal.

Method Summary

Modifier and Type	Method	Description
static WordParser.WordType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WordParser.WordType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INPUT_PARAMETER

public static final WordParser.WordType INPUT_PARAMETER

The word being scanned is an input parameter, it starts with either ':' or '?'.

NUMERIC_LITERAL

public static final WordParser.WordType NUMERIC_LITERAL

The word being scanned is a numeric literal (decimal or hexadecimal number).

STRING_LITERAL

public static final WordParser.WordType STRING_LITERAL

The word being scanned is a string literal, it starts with either ''' or '"'.

UNDEFINED

public static final WordParser.WordType UNDEFINED

No word was scanned, this is usually set when the cursor is at the end of the text.

WORD

public static final WordParser.WordType WORD

The word being scanned anything else other than an input parameter, numeric literal or string literal.

Method Details

values

public static WordParser.WordType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

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

valueOf

public static WordParser.WordType valueOf(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:

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

NullPointerException - if the argument is null