EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

java.lang.Object
  extended by java.lang.Enum<WordParser.WordType>
      extended by org.eclipse.persistence.jpa.jpql.WordParser.WordType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WordParser.WordType>
Enclosing class:
WordParser

public static enum WordParser.WordType
extends java.lang.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
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
static WordParser.WordType valueOf(java.lang.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 Detail

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 Detail

values

public static WordParser.WordType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (WordParser.WordType c : WordParser.WordType.values())
    System.out.println(c);

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

valueOf

public static WordParser.WordType 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
java.lang.NullPointerException - if the argument is null

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference