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

Constructor Summary

Access	Constructor and Description
public	InputParameterStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `InputParameterStateObject`.
public	InputParameterStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The positional or named input parameter parameter) Creates a new `InputParameterStateObject`.

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 InputParameter	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 boolean	Returns: `true` if the parameter type is '?'; `false` if it's ':' isNamed() Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.
public boolean	Returns: `true` if the parameter type is ':'; `false` if it's '?' isPositional() Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.
public void	setExpression(InputParameter The `parsed object` representing an input parameter 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`.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject:: getText hasText isEquivalent setText setTextInternally toTextInternal

Constructor Detail

InputParameterStateObject back to summary

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

public InputParameterStateObject(StateObject parent)

Creates a new InputParameterStateObject.

Parameters

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

Exceptions

NullPointerException:: The given parent cannot be null

InputParameterStateObject back to summary

InputParameterStateObject	back to summary
public InputParameterStateObject(StateObject parent, String parameter) Creates a new `InputParameterStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` parameter:String The positional or named input parameter Exceptions NullPointerException: The given parent cannot be `null`

public InputParameterStateObject(StateObject parent, String parameter)

Creates a new InputParameterStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
parameter:String: The positional or named input parameter

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

getExpression back to summary

getExpression	back to summary
public InputParameter 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:InputParameter 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 InputParameter 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:InputParameter

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

isNamed back to summary

isNamed	back to summary
public boolean isNamed() Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'. Returns:boolean `true` if the parameter type is '?'; `false` if it's ':'

public boolean isNamed()

Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.

Returns:boolean: true if the parameter type is '?'; false if it's ':'

isPositional back to summary

isPositional	back to summary
public boolean isPositional() Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'. Returns:boolean `true` if the parameter type is ':'; `false` if it's '?'

public boolean isPositional()

Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.

Returns:boolean: true if the parameter type is ':'; false if it's '?'

setExpression back to summary

setExpression	back to summary
public void setExpression(InputParameter 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:InputParameter The `parsed object` representing an input parameter

public void setExpression(InputParameter 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:InputParameter: The parsed object representing an input parameter

public Class InputParameterStateObject

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail