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

Class KeywordExpressionStateObject

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.KeywordExpressionStateObject

All Implemented Interfaces:

StateObject

public class KeywordExpressionStateObject
extends SimpleStateObject

The expression representing some keywords: TRUE, FALSE or NULL.

Version:

2.4

See Also:

KeywordExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

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

TEXT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
KeywordExpressionStateObject(StateObject parent) Creates a new KeywordExpressionStateObject.
KeywordExpressionStateObject(StateObject parent, java.lang.String text) Creates a new KeywordExpressionStateObject.

Method Summary

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
KeywordExpression	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
void	setExpression(KeywordExpression 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.
void	setText(java.lang.String text) Sets the text held by this state object.
protected void	validateIdentifier(java.lang.String text)

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

getText, hasText, isEquivalent, 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 Detail

KeywordExpressionStateObject

public KeywordExpressionStateObject(StateObject parent)

Creates a new KeywordExpressionStateObject.

Parameters:

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

Throws:

java.lang.NullPointerException - The given parent cannot be null

KeywordExpressionStateObject

public KeywordExpressionStateObject(StateObject parent,
                                    java.lang.String text)

Creates a new KeywordExpressionStateObject.

Parameters:

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

text - Either TRUE, FALSE or NULL

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public KeywordExpression getExpression()

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(KeywordExpression 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 one of the three possible keyword: TRUE, FALSE or NULL

setText

public void setText(java.lang.String text)

Sets the text held by this state object.

Overrides:

setText in class SimpleStateObject

Parameters:

text - This model's text value

validateIdentifier

protected void validateIdentifier(java.lang.String text)