Modifier and Type	Class and Description
public static enum	TrimExpression.Specification The possible ways to trim the string.

Modifier and Type	Field and Description
private String	fromIdentifier The actual FROM identifier found in the string representation of the JPQL query.
private boolean	hasFrom Determines whether the identifier FROM was part of the query.
private boolean	hasSpaceAfterFrom Determines whether a space was parsed after the identifier FROM.
private boolean	hasSpaceAfterSpecification Determines whether a space was parsed after the trim specification.
private boolean	hasSpaceAfterTrimCharacter Determines whether a space was parsed after the trim character.
private TrimExpression.Specification	specification The specification specifies how to trim the string.
private String	specificationIdentifier The actual trim specification identifier found in the string representation of the JPQL query.
private AbstractExpression	trimCharacter The character used for trimming the string.

Access	Constructor and Description
public	TrimExpression(AbstractExpression The parent of this expression parent) Creates a new `TrimExpression`.

Method Summary

Modifier and Type	Method and Description
public void	accept(ExpressionVisitor The `ExpressionVisitor` to visit this object visitor) Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept. Visits this `Expression` by the given `visitor`.
public void	acceptChildren(ExpressionVisitor The `visitor` to visit the children of this object. visitor) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.acceptChildren. Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. Visits the children of this `Expression`.
protected void	addOrderedEncapsulatedExpressionTo(List<Expression> The list used to store the string representation of the encapsulated `Expression` children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.addOrderedEncapsulatedExpressionTo. Adds the `Expressions` representing the encapsulated `Expression`.
public String	Returns: The FROM identifier that was actually parsed, or an empty string if it was not parsed getActualFromIdentifier() Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used.
public String	Returns: The specification identifier that was actually parsed, or an empty string if it was not parsed getActualSpecificationIdentifier() Returns the actual specification identifier found in the string representation of the JPQL query, which has the actual case that was used.
public String	getEncapsulatedExpressionQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId. Returns the BNF used to parse the encapsulated expression.
public JPQLQueryBNF	getQueryBNF() Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Returns the BNF of this `Expression`.
public TrimExpression.Specification	Returns: One of the available choices for trimming the string getSpecification() Returns the specification which specifies how to trim the string.
public Expression	Returns: The character, if one was parsed, that will be used to trim the string. If the character was not specified, then '\0' is the character getTrimCharacter() Returns the character used for trimming the string.
public boolean	hasEncapsulatedExpression() Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.hasEncapsulatedExpression. Determines whether something was parsed after the left parenthesis.
public boolean	Returns: `true` if the identifier FROM was parsed; `false` otherwise hasFrom() Determines whether the identifier FROM was part of the query.
public boolean	Returns: `true` if there was a whitespace after FROM; `false` otherwise hasSpaceAfterFrom() Determines whether a whitespace was found after FROM.
public boolean	Returns: `true` if there was a whitespace after the trim specification; `false` otherwise hasSpaceAfterSpecification() Determines whether a whitespace was found after the way the string is trimmed.
public boolean	Returns: `true` if there was a whitespace after the trim character; `false` otherwise hasSpaceAfterTrimCharacter() Determines whether a whitespace was found after the character used to trim the string.
public boolean	Returns: `true` if the query contained the way the trim needs to be trimmed; `false` otherwise hasSpecification() Determines whether the way the trim is trimmed was parsed.
public boolean	Returns: `true` if the character used for trimming was specified; `false` otherwise hasTrimCharacter() Determines whether the character used to trim the string was specified.
protected void	parseEncapsulatedExpression(WordParser The text to parse based on the current position of the cursor wordParser, int The number of whitespace characters that were parsed after '(' whitespaceCount, boolean Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries tolerant) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.parseEncapsulatedExpression. Parses the encapsulated expression by starting at the current position, which is part of the given `WordParser`.
private TrimExpression.Specification	parseTrimSpecification(WordParser wordParser)
protected void	toParsedTextEncapsulatedExpression(StringBuilder The buffer used to append the encapsulated `Expression`'s string representation writer, boolean Determines whether 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 actual) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.toParsedTextEncapsulatedExpression. Generates a string representation of the encapsulated `Expression`.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression:: addChildrenTo findQueryBNF getExpression hasExpression removeEncapsulatedExpression setExpression

Field Detail

fromIdentifier	back to summary
private String fromIdentifier The actual FROM identifier found in the string representation of the JPQL query.

hasFrom	back to summary
private boolean hasFrom Determines whether the identifier FROM was part of the query.

hasSpaceAfterFrom	back to summary
private boolean hasSpaceAfterFrom Determines whether a space was parsed after the identifier FROM.

hasSpaceAfterSpecification	back to summary
private boolean hasSpaceAfterSpecification Determines whether a space was parsed after the trim specification.

hasSpaceAfterTrimCharacter	back to summary
private boolean hasSpaceAfterTrimCharacter Determines whether a space was parsed after the trim character.

specification	back to summary
private TrimExpression.Specification specification The specification specifies how to trim the string.

specificationIdentifier	back to summary
private String specificationIdentifier The actual trim specification identifier found in the string representation of the JPQL query.

trimCharacter	back to summary
private AbstractExpression trimCharacter The character used for trimming the string.

Constructor Detail

TrimExpression back to summary

TrimExpression	back to summary
public TrimExpression(AbstractExpression parent) Creates a new `TrimExpression`. Parameters parent:AbstractExpression The parent of this expression

public TrimExpression(AbstractExpression parent)

Creates a new TrimExpression.

Parameters

parent:AbstractExpression: The parent of this expression

Method Detail

accept back to summary

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

public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters

visitor:ExpressionVisitor: The ExpressionVisitor to visit this object

Annotations

@Override

acceptChildren back to summary

acceptChildren	back to summary
public void acceptChildren(ExpressionVisitor visitor) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.acceptChildren. Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. Visits the children of this `Expression`. This method can be used to optimize traversing the children since a new list is not created every time `children()` is called. This does not traverse the `Expression` sub-hierarchy, use a subclass of `AbstractTraverseChildrenVisitor` in order to traverse the entire sub-hierarchy. Parameters visitor:ExpressionVisitor The `visitor` to visit the children of this object. Annotations @Override

public void acceptChildren(ExpressionVisitor visitor)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.acceptChildren.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time children() is called.

This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters

visitor:ExpressionVisitor: The visitor to visit the children of this object.

Annotations

@Override

addOrderedEncapsulatedExpressionTo back to summary

addOrderedEncapsulatedExpressionTo	back to summary
protected void addOrderedEncapsulatedExpressionTo(List<Expression> children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.addOrderedEncapsulatedExpressionTo. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.addOrderedEncapsulatedExpressionTo. Adds the `Expressions` representing the encapsulated `Expression`. Parameters children:List<Expression> The list used to store the string representation of the encapsulated `Expression` Annotations @Override

protected void addOrderedEncapsulatedExpressionTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.addOrderedEncapsulatedExpressionTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.addOrderedEncapsulatedExpressionTo.

Adds the Expressions representing the encapsulated Expression.

Parameters

children:List<Expression>: The list used to store the string representation of the encapsulated Expression

Annotations

@Override

getActualFromIdentifier	back to summary
public String getActualFromIdentifier() Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The FROM identifier that was actually parsed, or an empty string if it was not parsed

getActualFromIdentifier

back to summary

public String getActualFromIdentifier()

Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String: The FROM identifier that was actually parsed, or an empty string if it was not parsed

getActualSpecificationIdentifier	back to summary
public String getActualSpecificationIdentifier() Returns the actual specification identifier found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The specification identifier that was actually parsed, or an empty string if it was not parsed

getActualSpecificationIdentifier

back to summary

public String getActualSpecificationIdentifier()

Returns the actual specification identifier found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String: The specification identifier that was actually parsed, or an empty string if it was not parsed

getEncapsulatedExpressionQueryBNFId	back to summary
public String getEncapsulatedExpressionQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId. Returns the BNF used to parse the encapsulated expression. Returns:String The BNF used to parse the encapsulated expression Annotations @Override

getEncapsulatedExpressionQueryBNFId

back to summary

public String getEncapsulatedExpressionQueryBNFId()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId.

Returns the BNF used to parse the encapsulated expression.

Returns:String

The BNF used to parse the encapsulated expression

Annotations

@Override

getQueryBNF back to summary

getQueryBNF	back to summary
public JPQLQueryBNF getQueryBNF() Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Returns the BNF of this `Expression`. Returns:JPQLQueryBNF The `JPQLQueryBNF`, which represents the grammar of this `Expression` Annotations @Override

public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations

@Override

getSpecification	back to summary
public TrimExpression.Specification getSpecification() Returns the specification which specifies how to trim the string. Returns:TrimExpression.Specification One of the available choices for trimming the string

getSpecification

back to summary

public TrimExpression.Specification getSpecification()

Returns the specification which specifies how to trim the string.

Returns:TrimExpression.Specification: One of the available choices for trimming the string

getTrimCharacter	back to summary
public Expression getTrimCharacter() Returns the character used for trimming the string. Returns:Expression The character, if one was parsed, that will be used to trim the string. If the character was not specified, then '\0' is the character

getTrimCharacter

back to summary

public Expression getTrimCharacter()

Returns the character used for trimming the string.

Returns:Expression: The character, if one was parsed, that will be used to trim the string. If the character was not specified, then '\0' is the character

hasEncapsulatedExpression back to summary

hasEncapsulatedExpression	back to summary
public boolean hasEncapsulatedExpression() Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.hasEncapsulatedExpression. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.hasEncapsulatedExpression. Determines whether something was parsed after the left parenthesis. Returns:boolean `true` if something was parsed; `false` otherwise Annotations @Override

public boolean hasEncapsulatedExpression()

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.hasEncapsulatedExpression.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.hasEncapsulatedExpression.

Determines whether something was parsed after the left parenthesis.

Returns:boolean

true if something was parsed; false otherwise

Annotations

@Override

hasFrom back to summary

hasFrom	back to summary
public boolean hasFrom() Determines whether the identifier FROM was part of the query. Returns:boolean `true` if the identifier FROM was parsed; `false` otherwise

public boolean hasFrom()

Determines whether the identifier FROM was part of the query.

Returns:boolean: true if the identifier FROM was parsed; false otherwise

hasSpaceAfterFrom back to summary

hasSpaceAfterFrom	back to summary
public boolean hasSpaceAfterFrom() Determines whether a whitespace was found after FROM. Returns:boolean `true` if there was a whitespace after FROM; `false` otherwise

public boolean hasSpaceAfterFrom()

Determines whether a whitespace was found after FROM.

Returns:boolean: true if there was a whitespace after FROM; false otherwise

hasSpaceAfterSpecification back to summary

hasSpaceAfterSpecification	back to summary
public boolean hasSpaceAfterSpecification() Determines whether a whitespace was found after the way the string is trimmed. Returns:boolean `true` if there was a whitespace after the trim specification; `false` otherwise

public boolean hasSpaceAfterSpecification()

Determines whether a whitespace was found after the way the string is trimmed.

Returns:boolean: true if there was a whitespace after the trim specification; false otherwise

hasSpaceAfterTrimCharacter back to summary

hasSpaceAfterTrimCharacter	back to summary
public boolean hasSpaceAfterTrimCharacter() Determines whether a whitespace was found after the character used to trim the string. Returns:boolean `true` if there was a whitespace after the trim character; `false` otherwise

public boolean hasSpaceAfterTrimCharacter()

Determines whether a whitespace was found after the character used to trim the string.

Returns:boolean: true if there was a whitespace after the trim character; false otherwise

hasSpecification back to summary

hasSpecification	back to summary
public boolean hasSpecification() Determines whether the way the trim is trimmed was parsed. Returns:boolean `true` if the query contained the way the trim needs to be trimmed; `false` otherwise

public boolean hasSpecification()

Determines whether the way the trim is trimmed was parsed.

Returns:boolean: true if the query contained the way the trim needs to be trimmed; false otherwise

hasTrimCharacter back to summary

hasTrimCharacter	back to summary
public boolean hasTrimCharacter() Determines whether the character used to trim the string was specified. Returns:boolean `true` if the character used for trimming was specified; `false` otherwise

public boolean hasTrimCharacter()

Determines whether the character used to trim the string was specified.

Returns:boolean: true if the character used for trimming was specified; false otherwise

parseEncapsulatedExpression back to summary

parseEncapsulatedExpression	back to summary
protected void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.parseEncapsulatedExpression. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.parseEncapsulatedExpression. Parses the encapsulated expression by starting at the current position, which is part of the given `WordParser`. Parameters wordParser:WordParser The text to parse based on the current position of the cursor whitespaceCount:int The number of whitespace characters that were parsed after '(' tolerant:boolean Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries Annotations @Override

protected void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.parseEncapsulatedExpression.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.parseEncapsulatedExpression.

Parses the encapsulated expression by starting at the current position, which is part of the given WordParser.

Parameters

wordParser:WordParser: The text to parse based on the current position of the cursor
whitespaceCount:int: The number of whitespace characters that were parsed after '('
tolerant:boolean: Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Annotations

@Override

parseTrimSpecification	back to summary
private TrimExpression.Specification parseTrimSpecification(WordParser wordParser)

toParsedTextEncapsulatedExpression back to summary

toParsedTextEncapsulatedExpression	back to summary
protected void toParsedTextEncapsulatedExpression(StringBuilder writer, boolean actual) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.toParsedTextEncapsulatedExpression. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.toParsedTextEncapsulatedExpression. Generates a string representation of the encapsulated `Expression`. Parameters writer:StringBuilder The buffer used to append the encapsulated `Expression`'s string representation actual:boolean Determines whether 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 Annotations @Override

protected void toParsedTextEncapsulatedExpression(StringBuilder writer, boolean actual)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.toParsedTextEncapsulatedExpression.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression.toParsedTextEncapsulatedExpression.

Generates a string representation of the encapsulated Expression.

Parameters

writer:StringBuilder: The buffer used to append the encapsulated Expression's string representation
actual:boolean: Determines whether 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

Annotations

@Override

org.eclipse.persistence.jpa.jpql.parser back to summary

public final Enum TrimExpression.Specification

Class Inheritance

extends Enum<TrimExpression.Specification>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.jpa.jpql.parser.TrimExpression.Specification

The possible ways to trim the string.

Field Summary

Modifier and Type	Field and Description
public static final TrimExpression.Specification	BOTH The leading and trailing parts of the string will be trimmed.
public static final TrimExpression.Specification	DEFAULT Used when the trim specification is not specified, by default it means the leading and trailing parts of the string will be trimmed.
public static final TrimExpression.Specification	LEADING Only the leading part of the string will be trimmed.
public static final TrimExpression.Specification	TRAILING Only the trailing part of the string will be trimmed.
private String	value The actual constant associated with the constant.

Constructor Summary

Access	Constructor and Description
private	Specification(String value)

Method Summary

Modifier and Type	Method and Description
public String	Returns: The identifier associated with the constant or an empty string for `DEFAULT` getValue() Returns the actual identifier associated with the constant.
public static TrimExpression.Specification	valueOf(String name)
public static TrimExpression.Specification[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOTH	back to summary
public static final TrimExpression.Specification BOTH The leading and trailing parts of the string will be trimmed.

DEFAULT	back to summary
public static final TrimExpression.Specification DEFAULT Used when the trim specification is not specified, by default it means the leading and trailing parts of the string will be trimmed.

LEADING	back to summary
public static final TrimExpression.Specification LEADING Only the leading part of the string will be trimmed.

TRAILING	back to summary
public static final TrimExpression.Specification TRAILING Only the trailing part of the string will be trimmed.

value	back to summary
private String value The actual constant associated with the constant.

Constructor Detail

Specification	back to summary
private Specification(String value)

Method Detail

getValue back to summary

getValue	back to summary
public String getValue() Returns the actual identifier associated with the constant. Returns:String The identifier associated with the constant or an empty string for `DEFAULT`

public String getValue()

Returns the actual identifier associated with the constant.

Returns:String: The identifier associated with the constant or an empty string for DEFAULT

valueOf	back to summary
public static TrimExpression.Specification valueOf(String name)

values	back to summary
public static TrimExpression.Specification[] values()

public final Class TrimExpression

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TrimExpression.Specification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail