Package org.springframework.data.jpa.provider

Enum Class PersistenceProvider

java.lang.Object

java.lang.Enum<PersistenceProvider>

org.springframework.data.jpa.provider.PersistenceProvider

All Implemented Interfaces:

Serializable, Comparable<PersistenceProvider>, Constable, ProxyIdAccessor, QueryComment, QueryExtractor

public enum PersistenceProvider
extends Enum<PersistenceProvider>
implements QueryExtractor, ProxyIdAccessor, QueryComment

Enumeration representing persistence providers to be used.

Author:

Oliver Gierke, Thomas Darimont, Mark Paluch, Jens Schauder, Greg Turnquist, Yuriy Tsarkov

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ECLIPSELINK	EclipseLink persistence provider.
GENERIC_JPA	Unknown special provider.
HIBERNATE	Hibernate persistence provider.

Method Summary

Modifier and Type	Method	Description
boolean	canExtractQuery()	Returns whether the extractor is able to extract the original query string from a given Query.
CloseableIterator<Object>	executeQueryWithResultStream(jakarta.persistence.Query jpaQuery)
static PersistenceProvider	fromEntityManager(jakarta.persistence.EntityManager em)	Determines the PersistenceProvider from the given EntityManager.
static PersistenceProvider	fromMetamodel(jakarta.persistence.metamodel.Metamodel metamodel)	Determines the PersistenceProvider from the given Metamodel.
String	getCountQueryPlaceholder()	Returns the placeholder to be used for simple count queries.
<T> Set<jakarta.persistence.metamodel.SingularAttribute<? super T,?>>	getIdClassAttributes(jakarta.persistence.metamodel.IdentifiableType<T> type)
JpaParametersParameterAccessor	getParameterAccessor(JpaParameters parameters, Object[] values, jakarta.persistence.EntityManager em)
static Object	unwrapTypedParameterValue(Object value)	Because Hibernate's TypedParameterValue is only used to wrap a null, swap it out with an empty string for query creation.
static PersistenceProvider	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PersistenceProvider[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.jpa.provider.ProxyIdAccessor

getIdentifierFrom, shouldUseAccessorFor

Methods inherited from interface org.springframework.data.jpa.provider.QueryComment

getCommentHintKey, getCommentHintValue

Methods inherited from interface org.springframework.data.jpa.provider.QueryExtractor

extractQueryString

Enum Constant Details

HIBERNATE

public static final PersistenceProvider HIBERNATE

Hibernate persistence provider.

Since Hibernate 4.3 the location of the HibernateEntityManager moved to the org.hibernate.jpa package. In order to support both locations we interpret both classnames as a Hibernate PersistenceProvider.

See Also:

• DATAJPA-444

ECLIPSELINK

public static final PersistenceProvider ECLIPSELINK

EclipseLink persistence provider.

GENERIC_JPA

public static final PersistenceProvider GENERIC_JPA

Unknown special provider. Use standard JPA.

Method Details

values

public static PersistenceProvider[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PersistenceProvider valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromEntityManager

public static PersistenceProvider fromEntityManager(jakarta.persistence.EntityManager em)

Determines the PersistenceProvider from the given EntityManager. If no special one can be determined GENERIC_JPA will be returned.

Parameters:

em - must not be null.

Returns:

will never be null.

fromMetamodel

public static PersistenceProvider fromMetamodel(jakarta.persistence.metamodel.Metamodel metamodel)

Determines the PersistenceProvider from the given Metamodel. If no special one can be determined GENERIC_JPA will be returned.

Parameters:

metamodel - must not be null.

Returns:

will never be null.

getParameterAccessor

public JpaParametersParameterAccessor getParameterAccessor(JpaParameters parameters,
 Object[] values,
 jakarta.persistence.EntityManager em)

getCountQueryPlaceholder

public String getCountQueryPlaceholder()

Returns the placeholder to be used for simple count queries. Default implementation returns x.

Returns:

a placeholder for count queries. Guaranteed to be not null.

canExtractQuery

public boolean canExtractQuery()

Description copied from interface: QueryExtractor

Returns whether the extractor is able to extract the original query string from a given Query.

Specified by:

canExtractQuery in interface QueryExtractor

Returns:

getIdClassAttributes

public <T>
Set<jakarta.persistence.metamodel.SingularAttribute<? super T,?>> getIdClassAttributes(jakarta.persistence.metamodel.IdentifiableType<T> type)

Parameters:

type - the entity type.

Returns:

the set of identifier attributes used in a @IdClass for type. Empty when type does not use @IdClass.

Since:

2.5.6

unwrapTypedParameterValue

public static Object unwrapTypedParameterValue(Object value)

Because Hibernate's TypedParameterValue is only used to wrap a null, swap it out with an empty string for query creation.

Parameters:

value -

Returns:

the original value or null.

Since:

3.0

executeQueryWithResultStream

public CloseableIterator<Object> executeQueryWithResultStream(jakarta.persistence.Query jpaQuery)