EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.ConstructorExpressionStateObject

Modifier and Type	Field and Description
public static final String	CLASS_NAME_PROPERTY Notifies the class name property has changed.
private String	className The fully qualified class name of the Java object to instantiate.
public static final String	CONSTRUCTOR_ITEMS_LIST Notify the list of `StateObjects` representing the constructor items.
private IType	type The actual type that was resolved based on the class name.

Constructor Summary

Access	Constructor and Description
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, Class<?> The fully qualified name of the Java class to instantiate type) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, Class<?> The Java class to instantiate type, List<? extends StateObject> The list of arguments constructorItems) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, Class<?> The Java class to instantiate type, String The portion of the JPQL query that represents the constructor's arguments jpqlFragment) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The fully qualified name of the Java class to instantiate className) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The fully qualified name of the Java class to instantiate className, List<? extends StateObject> The list of arguments constructorItems) Creates a new `ConstructorExpressionStateObject`.
public	ConstructorExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The fully qualified name of the Java class to instantiate className, String The portion of the JPQL query that represents the constructor's arguments jpqlFragment) Creates a new `ConstructorExpressionStateObject`.

Method Summary

Modifier and Type	Method and Description
public void	accept(StateObjectVisitor The `visitor` to visit this object visitor) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Visits this `StateObject` by the given `visitor`.
public String	Returns: The fully qualified class name or an empty string if it is not defined getClassName() Returns the fully qualified class name that will be used to retrieve the constructor.
public ConstructorExpression	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
public IType	Returns: The actual `IType` getType() Returns the actual `IType` that was resolved or `null` if it could not be resolved.
public boolean	isEquivalent(StateObject The `StateObject` to compare its content to this one stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same.
protected String	listName() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Returns the name that is uniquely identifying the list.
public void	parse(String The JPQL fragment, which represents either a single or multiple arguments jpqlFragment) Parses the given JPQL fragment, which represents the constructor's arguments.
protected IType	Returns: The `IType` with the fully qualified class name resolveType() Resolves the actual `IType` based on the class name.
public void	setClassName(CharSequence The fully qualified class name className) Sets the fully qualified class name that will be used to retrieve the constructor.
public void	setClassName(Class<?> The type used to retrieve its fully qualified class name type) Sets the fully qualified class name that will be used to retrieve the constructor.
protected void	setClassNameInternally(CharSequence The fully qualified class name className) Sets the fully qualified class name that will be used to retrieve the constructor.
public void	setExpression(ConstructorExpression The `parsed object` representing a `NEW` expression 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`.
public void	setType(IType The new `IType` type) Sets the actual `IType` and updates the class name.
protected void	toTextInternal(Appendable The writer used to print out the string representation writer) Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject:: addChildren addItem addItems addListChangeListener areChildrenEquivalent canMoveDown canMoveUp getItem hasItems initialize items itemsSize moveDown moveUp removeItem removeItems removeListChangeListener toStringItems

Field Detail

CLASS_NAME_PROPERTY	back to summary
public static final String CLASS_NAME_PROPERTY Notifies the class name property has changed.

className	back to summary
private String className The fully qualified class name of the Java object to instantiate.

CONSTRUCTOR_ITEMS_LIST	back to summary
public static final String CONSTRUCTOR_ITEMS_LIST Notify the list of `StateObjects` representing the constructor items.

type	back to summary
private IType type The actual type that was resolved based on the class name.

Constructor Detail

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, Class<?> type) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` type:Class<?> The fully qualified name of the Java class to instantiate Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, Class<?> type)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
type:Class<?>: The fully qualified name of the Java class to instantiate

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, Class<?> type, List<? extends StateObject> constructorItems) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` type:Class<?> The Java class to instantiate constructorItems:List<? extends StateObject> The list of arguments Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, Class<?> type, List<? extends StateObject> constructorItems)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
type:Class<?>: The Java class to instantiate
constructorItems:List<? extends StateObject>: The list of arguments

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, Class<?> type, String jpqlFragment) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` type:Class<?> The Java class to instantiate jpqlFragment:String The portion of the JPQL query that represents the constructor's arguments Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, Class<?> type, String jpqlFragment)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
type:Class<?>: The Java class to instantiate
jpqlFragment:String: The portion of the JPQL query that represents the constructor's arguments

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, String className) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` className:String The fully qualified name of the Java class to instantiate Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, String className)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
className:String: The fully qualified name of the Java class to instantiate

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, String className, List<? extends StateObject> constructorItems) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` className:String The fully qualified name of the Java class to instantiate constructorItems:List<? extends StateObject> The list of arguments Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, String className, List<? extends StateObject> constructorItems)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
className:String: The fully qualified name of the Java class to instantiate
constructorItems:List<? extends StateObject>: The list of arguments

Exceptions

NullPointerException:: The given parent cannot be null

ConstructorExpressionStateObject back to summary

ConstructorExpressionStateObject	back to summary
public ConstructorExpressionStateObject(StateObject parent, String className, String jpqlFragment) Creates a new `ConstructorExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` className:String The fully qualified name of the Java class to instantiate jpqlFragment:String The portion of the JPQL query that represents the constructor's arguments Exceptions NullPointerException: The given parent cannot be `null`

public ConstructorExpressionStateObject(StateObject parent, String className, String jpqlFragment)

Creates a new ConstructorExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
className:String: The fully qualified name of the Java class to instantiate
jpqlFragment:String: The portion of the JPQL query that represents the constructor's arguments

Exceptions

NullPointerException:: The given parent cannot be null

Method Detail

accept back to summary

accept	back to summary
public void accept(StateObjectVisitor visitor) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Visits this `StateObject` by the given `visitor`. Parameters visitor:StateObjectVisitor The `visitor` to visit this object Annotations @Override

public void accept(StateObjectVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.

Parameters

visitor:StateObjectVisitor: The visitor to visit this object

Annotations

@Override

getClassName	back to summary
public String getClassName() Returns the fully qualified class name that will be used to retrieve the constructor. Returns:String The fully qualified class name or an empty string if it is not defined

getClassName

back to summary

public String getClassName()

Returns the fully qualified class name that will be used to retrieve the constructor.

Returns:String: The fully qualified class name or an empty string if it is not defined

getExpression back to summary

getExpression	back to summary
public ConstructorExpression getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query. Returns:ConstructorExpression 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) Annotations @Override

public ConstructorExpression getExpression()

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

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

Returns:ConstructorExpression

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)

Annotations

@Override

getType back to summary

getType	back to summary
public IType getType() Returns the actual `IType` that was resolved or `null` if it could not be resolved. Returns:IType The actual `IType`

public IType getType()

Returns the actual IType that was resolved or null if it could not be resolved.

Returns:IType: The actual IType

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same. Parameters stateObject:StateObject The `StateObject` to compare its content to this one Returns:boolean `true` if both object are equivalent; `false` otherwise Annotations @Override

public boolean isEquivalent(StateObject stateObject)

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Parameters

stateObject:StateObject: The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations

@Override

listName	back to summary
protected String listName() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Returns the name that is uniquely identifying the list. Returns:String The unique name identifying the list Annotations @Override

listName

back to summary

protected String listName()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName.

Returns the name that is uniquely identifying the list.

Returns:String

The unique name identifying the list

Annotations

@Override

parse	back to summary
public void parse(String jpqlFragment) Parses the given JPQL fragment, which represents the constructor's arguments. Parameters jpqlFragment:String The JPQL fragment, which represents either a single or multiple arguments

parse

back to summary

public void parse(String jpqlFragment)

Parses the given JPQL fragment, which represents the constructor's arguments.

Parameters

jpqlFragment:String: The JPQL fragment, which represents either a single or multiple arguments

resolveType back to summary

resolveType	back to summary
protected IType resolveType() Resolves the actual `IType` based on the class name. Returns:IType The `IType` with the fully qualified class name

protected IType resolveType()

Resolves the actual IType based on the class name.

Returns:IType: The IType with the fully qualified class name

setClassName	back to summary
public void setClassName(CharSequence className) Sets the fully qualified class name that will be used to retrieve the constructor. Parameters className:CharSequence The fully qualified class name

setClassName

back to summary

public void setClassName(CharSequence className)

Sets the fully qualified class name that will be used to retrieve the constructor.

Parameters

className:CharSequence: The fully qualified class name

setClassName	back to summary
public void setClassName(Class<?> type) Sets the fully qualified class name that will be used to retrieve the constructor. Parameters type:Class<?> The type used to retrieve its fully qualified class name

setClassName

back to summary

public void setClassName(Class<?> type)

Sets the fully qualified class name that will be used to retrieve the constructor.

Parameters

type:Class<?>: The type used to retrieve its fully qualified class name

setClassNameInternally	back to summary
protected void setClassNameInternally(CharSequence className) Sets the fully qualified class name that will be used to retrieve the constructor. Parameters className:CharSequence The fully qualified class name

setClassNameInternally

back to summary

protected void setClassNameInternally(CharSequence className)

Sets the fully qualified class name that will be used to retrieve the constructor.

Parameters

className:CharSequence: The fully qualified class name

setExpression back to summary

setExpression	back to summary
public void setExpression(ConstructorExpression 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:ConstructorExpression The `parsed object` representing a `NEW` expression

public void setExpression(ConstructorExpression 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:ConstructorExpression: The parsed object representing a NEW expression

setType back to summary

setType	back to summary
public void setType(IType type) Sets the actual `IType` and updates the class name. Parameters type:IType The new `IType`

public void setType(IType type)

Sets the actual IType and updates the class name.

Parameters

type:IType: The new IType

toTextInternal back to summary

toTextInternal	back to summary
protected void toTextInternal(Appendable writer) throws IOException Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes. Parameters writer:Appendable The writer used to print out the string representation Annotations @Override Exceptions IOException: This should never happens, it is only required because `Appendable` is used instead of any concrete class

protected void toTextInternal(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Parameters

writer:Appendable: The writer used to print out the string representation

Annotations

@Override

Exceptions

IOException:: This should never happens, it is only required because Appendable is used instead of any concrete class

public Class ConstructorExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail