Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql

pack-priv final Class DefaultJPQLQueryProblem

extends Object
implements JPQLQueryProblem
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.jpa.jpql.JPQLQueryProblem
Annotations
@SuppressWarnings:nls
Imports
java.util.Arrays, org.eclipse.persistence.jpa.jpql.parser.Expression

The default implementation of JPQLQueryProblem.
Author
Pascal Filion
Since
2.3
Version
2.4

Field Summary

Modifier and TypeField and Description
private int
endIndex

The position where the problem ends, inclusively.

private Expression
expression

The Expression that is either not following the BNF grammar or that has semantic problems.

private String[]
messageArguments

The list of arguments that can be used to format the localized description of the problem.

private String
messageKey

The key used to retrieve the localized message describing the problem.

private int
startIndex

The position where the problem ends.

Constructor Summary

AccessConstructor and Description
pack-priv
DefaultJPQLQueryProblem(Expression
The Expression that is either not following the BNF grammar or that has semantic problems
expression
,
int
The position where the problem was encountered
startIndex
,
int
The position where the problem ends, inclusively
endIndex
,
String
The key used to retrieve the localized message describing the problem
messageKey
,
String...
The list of arguments that can be used to format the localized description of the problem
messageArguments
)

Creates a new DefaultJPQLQueryProblem.

Method Summary

Modifier and TypeMethod and Description
public int
getEndPosition()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getEndPosition.

Returns the position from where the problem ends, inclusively.
public Expression
getExpression()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getExpression.

Returns the parsed tree representing the JPQL query.
public String[]
getMessageArguments()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageArguments.

Returns the arguments associate with the problem's message.
public String
getMessageKey()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageKey.

Returns the resource bundle key used to retrieve the localized message.
public int
getStartPosition()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getStartPosition.

Returns the position from where the problem starts.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

endIndexback to summary
private int endIndex

The position where the problem ends, inclusively.

expressionback to summary
private Expression expression

The Expression that is either not following the BNF grammar or that has semantic problems.

messageArgumentsback to summary
private String[] messageArguments

The list of arguments that can be used to format the localized description of the problem.

messageKeyback to summary
private String messageKey

The key used to retrieve the localized message describing the problem.

startIndexback to summary
private int startIndex

The position where the problem ends.

Constructor Detail

DefaultJPQLQueryProblemback to summary
pack-priv DefaultJPQLQueryProblem(Expression expression, int startIndex, int endIndex, String messageKey, String... messageArguments)

Creates a new DefaultJPQLQueryProblem.

Parameters
expression:Expression

The Expression that is either not following the BNF grammar or that has semantic problems

startIndex:int

The position where the problem was encountered

endIndex:int

The position where the problem ends, inclusively

messageKey:String

The key used to retrieve the localized message describing the problem

messageArguments:String[]

The list of arguments that can be used to format the localized description of the problem

Method Detail

getEndPositionback to summary
public int getEndPosition()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getEndPosition.

Doc from org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getEndPosition.

Returns the position from where the problem ends, inclusively.

Returns:int

The position of the last character that was found as problematic within the JPQL query, inclusively

Annotations
@Override
getExpressionback to summary
public Expression getExpression()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getExpression.

Returns the parsed tree representing the JPQL query.

Returns:Expression

The parsed tree representing the JPQL query

Annotations
@Override
getMessageArgumentsback to summary
public String[] getMessageArguments()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageArguments.

Doc from org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageArguments.

Returns the arguments associate with the problem's message.

Returns:String[]

A non-null list of arguments that can be used to format the localized message

Annotations
@Override
getMessageKeyback to summary
public String getMessageKey()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageKey.

Doc from org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getMessageKey.

Returns the resource bundle key used to retrieve the localized message.

Returns:String

The key used to retrieve the localized message

Annotations
@Override
getStartPositionback to summary
public int getStartPosition()

Implements org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getStartPosition.

Doc from org.eclipse.persistence.jpa.jpql.JPQLQueryProblem.getStartPosition.

Returns the position from where the problem starts.

Returns:int

The position of the first character that was found as problematic within the JPQL query, inclusively

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override