Enum AbstractContentAssistVisitor.IdentificationVariableType
java.lang.Object
java.lang.Enum<AbstractContentAssistVisitor.IdentificationVariableType>
org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.IdentificationVariableType
- All Implemented Interfaces:
Serializable
,Comparable<AbstractContentAssistVisitor.IdentificationVariableType>
,java.lang.constant.Constable
- Enclosing class:
AbstractContentAssistVisitor
protected static enum AbstractContentAssistVisitor.IdentificationVariableType
extends Enum<AbstractContentAssistVisitor.IdentificationVariableType>
The various ways of retrieving identification variables from the declaration expression.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionRetrieves all the identification variables declared in the declaration portion of the expression, which is either in the FROM clause of a SELECT query or DELETE query or in the UPDATE query.Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression.Only retrieves the identification variables that have been declared to the left of the expression requested them, both range and collection type variables are collected.Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression but that have been declared to the left of the expression requested them.Simply indicates the identification variables should not be collected. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract boolean
add
(AbstractContentAssistVisitor contentAssist, Declaration declaration, Expression expression) Adds the identification variables defined in the givenDeclaration
.Returns the enum constant of this type with the specified name.values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ALL
Retrieves all the identification variables declared in the declaration portion of the expression, which is either in the FROM clause of a SELECT query or DELETE query or in the UPDATE query. -
COLLECTION
Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression. -
LEFT
Only retrieves the identification variables that have been declared to the left of the expression requested them, both range and collection type variables are collected. -
LEFT_COLLECTION
Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression but that have been declared to the left of the expression requested them. -
NONE
Simply indicates the identification variables should not be collected.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
add
protected abstract boolean add(AbstractContentAssistVisitor contentAssist, Declaration declaration, Expression expression) Adds the identification variables defined in the givenDeclaration
.- Parameters:
contentAssist
- Backpointer to the content assist classdeclaration
- TheDeclaration
in the order they are declared in the declaration clauseexpression
- TheExpression
being visited, which can help to determine when to stop collecting identification variables
-