org.eclipse.persistence.jpa.internal.jpql.parser

Class StringExpression

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

Direct Known Subclasses:

AbstractExpression

public abstract class StringExpression
extends java.lang.Object

A StringExpression is used when retrieving the deepest Expression in the JPQL parsed tree. An Expression should wrap its entire content with StringExpressions, i.e. whitespace, commas, dots, etc. Expression parts are already an instance of StringExpressions so they don't need to be encapsulated.

Note: This is not an interface because some methods should not become public on AbstractExpression, they are used internally.

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Constructor Summary

Constructors

Constructor and Description
StringExpression()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.util.ListIterator<StringExpression>	orderedChildren() Creates a list representing this expression and its children.
abstract java.lang.String	toActualText() Generates a string representation of this StringExpression, which needs to include any characters that are considered virtual, i.e.
abstract java.lang.String	toParsedText() Returns a string representation of this StringExpression and its children.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringExpression

public StringExpression()

Method Detail

orderedChildren

public abstract java.util.ListIterator<StringExpression> orderedChildren()

Creates a list representing this expression and its children. In order to add every piece of the expression, #addChildrenTo(Collection) is called.

Returns:

The StringExpressions representing this Expression

toActualText

public abstract java.lang.String toActualText()

Generates a string representation of this StringExpression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.

Returns:

The string representation of this StringExpression

toParsedText

public abstract java.lang.String toParsedText()

Returns a string representation of this StringExpression and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned where Expression#toText() would return "SELECT e".

Returns:

The string representation of this StringExpression