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

public final Class DefaultJPQLGrammar

extends Object
implements JPQLGrammar
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar
Annotations
@SuppressWarnings:nls
Imports
org.eclipse.persistence.jpa.jpql.ExpressionTools, .JPAVersion
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.

Author
Pascal Filion
See Also
DefaultJPQLGrammar, DefaultEclipseLinkJPQLGrammar

Field Summary

Modifier and TypeField and Description
public static final String
PROVIDER_NAME

The generic persistence provider name: JPA.

Constructor Summary

AccessConstructor and Description
private
DefaultJPQLGrammar()

Creates a new DefaultJPQLGrammar.

Method Summary

Modifier and TypeMethod and Description
public ExpressionRegistry
getExpressionRegistry()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getExpressionRegistry.

Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.
public JPAVersion
getJPAVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

Returns the JPAVersion of the Java Persistence supported by this grammar.
public String
getProvider()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Returns the persistence provider name.
public String
getProviderVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Returns the version of the persistence provider.
public static JPQLGrammar

Returns:

The singleton instance of this DefaultJPQLGrammar
instance()

Returns the singleton instance of this class.

public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

PROVIDER_NAMEback to summary
public static final String PROVIDER_NAME

The generic persistence provider name: JPA.

Constructor Detail

DefaultJPQLGrammarback to summary
private DefaultJPQLGrammar()

Creates a new DefaultJPQLGrammar.

Method Detail

getExpressionRegistryback to summary
public ExpressionRegistry getExpressionRegistry()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getExpressionRegistry.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getExpressionRegistry.

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

Returns:ExpressionRegistry

The registry containing the information related to the JPQL grammar

Annotations
@Override
getJPAVersionback to summary
public JPAVersion getJPAVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

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

Returns:JPAVersion

The JPA version supported by this grammar

Annotations
@Override
getProviderback to summary
public String getProvider()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Returns the persistence provider name.

Returns:String

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

Annotations
@Override
getProviderVersionback to summary
public String getProviderVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Returns the version of the persistence provider.

Returns:String

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

Annotations
@Override
instanceback to summary
public static JPQLGrammar instance()

Returns the singleton instance of this class.

Returns:JPQLGrammar

The singleton instance of this DefaultJPQLGrammar

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