Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.parser

Class DefaultJPQLGrammar

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.DefaultJPQLGrammar

All Implemented Interfaces:

JPQLGrammar

public final class DefaultJPQLGrammar
extends Object
implements JPQLGrammar

This JPQL grammar provides support for parsing JPQL queries defined in the latest Jakarta Persistence functional specification.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:

• DefaultJPQLGrammar
• DefaultEclipseLinkJPQLGrammar

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_NAME	The generic persistence provider name: JPA.

Method Summary

Modifier and Type	Method	Description
ExpressionRegistry	getExpressionRegistry()	Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.
JPAVersion	getJPAVersion()	Returns the JPAVersion of the Java Persistence supported by this grammar.
String	getProvider()	Returns the persistence provider name.
String	getProviderVersion()	Returns the version of the persistence provider.
static JPQLGrammar	instance()	Returns the singleton instance of this class.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

PROVIDER_NAME

public static final String PROVIDER_NAME

The generic persistence provider name: JPA.

See Also:

• Constant Field Values

Method Details

instance

public static JPQLGrammar instance()

Returns the singleton instance of this class.

Returns:

The singleton instance of this DefaultJPQLGrammar

getExpressionRegistry

public ExpressionRegistry getExpressionRegistry()

Description copied from interface: JPQLGrammar

Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.

Specified by:

getExpressionRegistry in interface JPQLGrammar

Returns:

The registry containing the information related to the JPQL grammar

getJPAVersion

public JPAVersion getJPAVersion()

Description copied from interface: JPQLGrammar

Returns the JPAVersion of the Java Persistence supported by this grammar.

Specified by:

getJPAVersion in interface JPQLGrammar

Returns:

The JPA version supported by this grammar

getProvider

public String getProvider()

Description copied from interface: JPQLGrammar

Returns the persistence provider name.

Specified by:

getProvider in interface JPQLGrammar

Returns:

The name of the persistence provider, null should never be returned

getProviderVersion

public String getProviderVersion()

Description copied from interface: JPQLGrammar

Returns the version of the persistence provider.

Specified by:

getProviderVersion in interface JPQLGrammar

Returns:

The version of the persistence provider, if one is extending the default JPQL grammar defined in the Java Persistence specification, otherwise returns an empty string

toString

public String toString()

Overrides:

toString in class Object