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

A string literal is enclosed in single quotes. For example: 'literal'. A string literal that includes a single quote is represented by two single quotes. For example: 'literal''s'. String literals in queries, like Java String literals, use unicode character encoding. Approximate literals support the use Java floating point literal syntax as well as SQL approximate numeric literal syntax. Enum literals support the use of Java enum literal syntax. The enum class name must be specified. Appropriate suffixes may be used to indicate the specific type of a numeric literal in accordance with the Java Language Specification. The boolean literals are TRUE and FALSE. Although predefined reserved literals appear in upper case, they are case insensitive.

Field Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject:: TEXT_PROPERTY

Constructor Summary

Access	Constructor and Description
public	StringLiteralStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `StringLiteralStateObject`.
public	StringLiteralStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The string literal literal) Creates a new `StringLiteralStateObject`.

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 StringLiteral	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 String	Returns: The unquoted text getUnquotedText() Returns the string literal without the single quotes.
public boolean	Returns: `true` if the literal is ended by a single quote; `false` otherwise hasCloseQuote() Determines whether the closing quote was present or not.
public void	setExpression(StringLiteral The `parsed object` representing a string literal 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

StringLiteralStateObject back to summary

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

public StringLiteralStateObject(StateObject parent)

Creates a new StringLiteralStateObject.

Parameters

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

Exceptions

NullPointerException:: The given parent cannot be null

StringLiteralStateObject back to summary

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

public StringLiteralStateObject(StateObject parent, String literal)

Creates a new StringLiteralStateObject.

Parameters

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

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 StringLiteral 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:StringLiteral 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 StringLiteral 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:StringLiteral

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

getUnquotedText	back to summary
public String getUnquotedText() Returns the string literal without the single quotes. Returns:String The unquoted text

getUnquotedText

back to summary

public String getUnquotedText()

Returns the string literal without the single quotes.

Returns:String: The unquoted text

hasCloseQuote back to summary

hasCloseQuote	back to summary
public boolean hasCloseQuote() Determines whether the closing quote was present or not. Returns:boolean `true` if the literal is ended by a single quote; `false` otherwise

public boolean hasCloseQuote()

Determines whether the closing quote was present or not.

Returns:boolean: true if the literal is ended by a single quote; false otherwise

setExpression back to summary

setExpression	back to summary
public void setExpression(StringLiteral 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:StringLiteral The `parsed object` representing a string literal

public void setExpression(StringLiteral 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:StringLiteral: The parsed object representing a string literal

public Class StringLiteralStateObject

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail