EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql.model.query
Class EntityTypeLiteralStateObject

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.SimpleStateObject
          extended by org.eclipse.persistence.jpa.jpql.model.query.EntityTypeLiteralStateObject
All Implemented Interfaces:
StateObject

public class EntityTypeLiteralStateObject
extends SimpleStateObject

This StateObject wraps the name of an entity type.

Version:
2.4
See Also:
EntityTypeLiteral
Author:
Pascal Filion
Since:
2.4

Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.model.query.SimpleStateObject
TEXT_PROPERTY
 
Constructor Summary
EntityTypeLiteralStateObject(StateObject parent)
          Creates a new EntityTypeLiteralStateObject.
EntityTypeLiteralStateObject(StateObject parent, java.lang.String entityTypeName)
          Creates a new EntityTypeLiteralStateObject.
 
Method Summary
 void accept(StateObjectVisitor visitor)
          Visits this StateObject by the given visitor.
protected  void addProblems(java.util.List<Problem> problems)
          Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.
 EntityTypeLiteral getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
 void setExpression(EntityTypeLiteral 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.model.query.SimpleStateObject
getText, hasText, isEquivalent, setText, setTextInternally, toTextInternal
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
acceptUnknownVisitor, acceptUnknownVisitor, addChildren, 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

EntityTypeLiteralStateObject

public EntityTypeLiteralStateObject(StateObject parent)
Creates a new EntityTypeLiteralStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
Throws:
java.lang.NullPointerException - The given parent cannot be null

EntityTypeLiteralStateObject

public EntityTypeLiteralStateObject(StateObject parent,
                                    java.lang.String entityTypeName)
Creates a new EntityTypeLiteralStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
entityTypeName - The name of the entity
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

addProblems

protected void addProblems(java.util.List<Problem> problems)
Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.

Overrides:
addProblems in class AbstractStateObject
Parameters:
problems - The list to which the problems are added

getExpression

public EntityTypeLiteral 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(EntityTypeLiteral 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 an entity type literal

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference