Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.tools.model.query

Class EnumTypeStateObject

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.EnumTypeStateObject

All Implemented Interfaces:

StateObject

public class EnumTypeStateObject
extends SimpleStateObject

This StateObject wraps the name of an Enum constant.

Since:

2.4

Version:

2.4

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject

TEXT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
EnumTypeStateObject(StateObject parent)	Creates a new EnumTypeStateObject.
EnumTypeStateObject(StateObject parent, Enum<? extends Enum<?>> enumConstant)	Creates a new EnumTypeStateObject.
EnumTypeStateObject(StateObject parent, String enumConstant)	Creates a new EnumTypeStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
AbstractPathExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
void	setExpression(AbstractPathExpression expression)	Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject

getText, hasText, isEquivalent, setText, setTextInternally, toTextInternal

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

acceptUnknownVisitor, acceptUnknownVisitor, addChildren, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, initialize, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText

Methods inherited from class java.lang.Object

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

Constructor Details

EnumTypeStateObject

public EnumTypeStateObject(StateObject parent)

Creates a new EnumTypeStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

NullPointerException - The given parent cannot be null

EnumTypeStateObject

public EnumTypeStateObject(StateObject parent,
 Enum<? extends Enum<?>> enumConstant)

Creates a new EnumTypeStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

enumConstant - The fully qualified name of the Enum type following by the constant

Throws:

NullPointerException - The given parent cannot be null

EnumTypeStateObject

public EnumTypeStateObject(StateObject parent,
 String enumConstant)

Creates a new EnumTypeStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

enumConstant - The fully qualified name of the Enum constant

Throws:

NullPointerException - The given parent cannot be null

Method Details

accept

public void accept(StateObjectVisitor visitor)

Description copied from interface: StateObject

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public AbstractPathExpression getExpression()

Description copied from interface: StateObject

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Specified by:

getExpression in interface StateObject

Overrides:

getExpression in class AbstractStateObject

Returns:

The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

setExpression

public void setExpression(AbstractPathExpression expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters:

expression - The parsed object representing the enum type