Package org.hibernate.type.spi

Class TypeConfiguration

java.lang.Object

org.hibernate.type.spi.TypeConfiguration

All Implemented Interfaces:

Serializable, SessionFactoryObserver

@Incubating
public class TypeConfiguration
extends Object
implements SessionFactoryObserver, Serializable

Each instance defines a set of types available in a given persistence unit, and isolates them from other configurations.

Note that each instance of Type is inherently "scoped" to a TypeConfiguration. We always obtain a reference to a Type via the TypeConfiguration associated with the current persistence unit.

On the other hand, a Type does not inherently have access to its parent TypeConfiguration since extensions may contribute instances of Type, via TypeContributions, for example, and the instantiation of such instances occurs outside the control of Hibernate.

In particular, a custom TypeContributor may contribute types to a TypeConfiguration.

If a Type requires access to the parent TypeConfiguration, it should implement TypeConfigurationAware.

Since:

5.3

See Also:

• TypeContributor
• TypeContributions
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TypeConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addBasicTypeRegistrationContributions(List<BasicTypeRegistration> contributions)
<J> MutabilityPlan<J>	createMutabilityPlan(Class<? extends MutabilityPlan<?>> planClass)
Class<?>	entityClassForEntityName(String entityName)	Workaround for an issue faced in EntityType.getReturnedClass().
<J> BasicType<J>	getBasicTypeForGenericJavaType(Class<? super J> javaType, Type... typeArguments)
<J> BasicType<J>	getBasicTypeForJavaType(Class<J> javaType)
<J> BasicType<J>	getBasicTypeForJavaType(Type javaType)
BasicTypeRegistry	getBasicTypeRegistry()
JdbcTypeIndicators	getCurrentBaseSqlTypeIndicators()
DdlTypeRegistry	getDdlTypeRegistry()
JavaTypeRegistry	getJavaTypeRegistry()
Map<Integer,Set<String>>	getJdbcToHibernateTypeContributionMap()
JdbcTypeRegistry	getJdbcTypeRegistry()
JpaCompliance	getJpaCompliance()	Deprecated, for removal: This API element is subject to removal in a future version. No longer used
final FormatMapper	getJsonFormatMapper()
MetadataBuildingContext	getMetadataBuildingContext()	Deprecated. This operation is not very typesafe, and we're migrating away from its use
ServiceRegistry	getServiceRegistry()	Deprecated. This simply isn't a very sensible place to hang the ServiceRegistry
SessionFactoryImplementor	getSessionFactory()	Deprecated. This operation is not very typesafe, and we're migrating away from its use
protected static IntervalType	getSqlIntervalType(int jdbcTypeCode)
static IntervalType	getSqlIntervalType(JdbcMappingContainer jdbcMappings)
static IntervalType	getSqlIntervalType(JdbcType descriptor)
protected static TemporalType	getSqlTemporalType(int jdbcTypeCode)
static TemporalType	getSqlTemporalType(JdbcMapping jdbcMapping)
static TemporalType	getSqlTemporalType(JdbcMappingContainer jdbcMappings)
static TemporalType	getSqlTemporalType(MappingModelExpressible<?> type)
TemporalType	getSqlTemporalType(SqmExpressible<?> type)
static TemporalType	getSqlTemporalType(JdbcType descriptor)
String	getUuid()
final FormatMapper	getXmlFormatMapper()
static boolean	isDuration(SqmExpressible<?> type)
static boolean	isJdbcTemporalType(SqmExpressible<?> type)
SqmExpressible<?>	resolveArithmeticType(SqmExpressible<?> firstType, SqmExpressible<?> secondType)	Determine the result type of an arithmetic operation as defined by the rules in section 6.5.8.1.
SqmExpressible<?>	resolveArithmeticType(SqmExpressible<?> firstType, SqmExpressible<?> secondType, BinaryArithmeticOperator operator)
BasicType<?>	resolveCastTargetType(String name)	Understands the following target type names for the cast() function: String Character Byte, Short, Integer, Long Float, Double Time, Date, Timestamp LocalDate, LocalTime, LocalDateTime BigInteger BigDecimal Binary Boolean (fragile, not aware of encoding to character via CharBooleanConverter)
SqmBindableType<?>	resolveTupleType(List<? extends SqmTypedNode<?>> typedNodes)
void	scope(MetadataBuildingContext metadataBuildingContext)	Scope this TypeConfiguration to the given MetadataBuildingContext.
void	scope(SessionFactoryImplementor sessionFactory)	Scope this TypeConfiguration to the given SessionFactory.
void	sessionFactoryClosed(SessionFactory factory)	Callback to indicate that the given factory has been closed.
void	sessionFactoryCreated(SessionFactory factory)	Callback to indicate that the given factory has been created and is now ready for use.
<J> BasicType<J>	standardBasicTypeForJavaType(Class<J> javaType)
<J> BasicType<J>	standardBasicTypeForJavaType(Class<J> javaType, Function<JavaType<J>,BasicType<J>> creator)
BasicType<?>	standardBasicTypeForJavaType(Type javaType)
<J> BasicType<J>	standardBasicTypeForJavaType(Type javaType, Function<JavaType<J>,BasicType<J>> creator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.SessionFactoryObserver

sessionFactoryClosing

Constructor Details

TypeConfiguration

public TypeConfiguration()

Method Details

getUuid

public String getUuid()

getBasicTypeRegistry

public BasicTypeRegistry getBasicTypeRegistry()

getJavaTypeRegistry

public JavaTypeRegistry getJavaTypeRegistry()

getJdbcTypeRegistry

public JdbcTypeRegistry getJdbcTypeRegistry()

getDdlTypeRegistry

public DdlTypeRegistry getDdlTypeRegistry()

getCurrentBaseSqlTypeIndicators

public JdbcTypeIndicators getCurrentBaseSqlTypeIndicators()

getJdbcToHibernateTypeContributionMap

public Map<Integer,Set<String>> getJdbcToHibernateTypeContributionMap()

getMetadataBuildingContext

@Deprecated(since="6.2")
public MetadataBuildingContext getMetadataBuildingContext()

Deprecated.

This operation is not very typesafe, and we're migrating away from its use

Obtain the MetadataBuildingContext currently scoping this TypeConfiguration.

Returns:

The MetadataBuildingContext

API Note:

Throws an exception if the TypeConfiguration is no longer scoped to the MetadataBuildingContext. See TypeConfiguration.Scope for more details regarding the stages a TypeConfiguration passes through.

scope

public void scope(MetadataBuildingContext metadataBuildingContext)

Scope this TypeConfiguration to the given MetadataBuildingContext.

Parameters:

metadataBuildingContext - a MetadataBuildingContext

Implementation Note:

The given factory is not yet fully-initialized!

scope

public void scope(SessionFactoryImplementor sessionFactory)

Scope this TypeConfiguration to the given SessionFactory.

Parameters:

sessionFactory - a SessionFactory that is in a very fragile state

Implementation Note:

The given factory is not yet fully-initialized!

getSessionFactory

@Deprecated(since="6.2")
public SessionFactoryImplementor getSessionFactory()

Deprecated.

This operation is not very typesafe, and we're migrating away from its use

Obtain the SessionFactory currently scoping this TypeConfiguration.

Returns:

The SessionFactory to which this TypeConfiguration is scoped

Throws:

HibernateException - if the TypeConfiguration is not currently scoped to a SessionFactory (in a "runtime stage").

API Note:

Throws an exception if the TypeConfiguration is not yet scoped to a factory. See TypeConfiguration.Scope for more details regarding the stages a TypeConfiguration passes through (this is a "runtime stage").

getServiceRegistry

@Deprecated(since="6.2")
public ServiceRegistry getServiceRegistry()

Deprecated.

This simply isn't a very sensible place to hang the ServiceRegistry

Obtain the ServiceRegistry scoped to this TypeConfiguration.

Returns:

The ServiceRegistry for the current scope

API Note:

The current TypeConfiguration.Scope will determine from where the ServiceRegistry is obtained.

getJpaCompliance

@Deprecated(since="7.0",
            forRemoval=true)
public JpaCompliance getJpaCompliance()

Deprecated, for removal: This API element is subject to removal in a future version.

No longer used

Obtain the JpaCompliance setting.

entityClassForEntityName

@Internal
public Class<?> entityClassForEntityName(String entityName)

Workaround for an issue faced in EntityType.getReturnedClass().

sessionFactoryCreated

public void sessionFactoryCreated(SessionFactory factory)

Description copied from interface: SessionFactoryObserver

Callback to indicate that the given factory has been created and is now ready for use.

Specified by:

sessionFactoryCreated in interface SessionFactoryObserver

Parameters:

factory - The factory initialized.

sessionFactoryClosed

public void sessionFactoryClosed(SessionFactory factory)

Description copied from interface: SessionFactoryObserver

Callback to indicate that the given factory has been closed. Care should be taken in how (if at all) the passed factory reference is used since it is closed.

Specified by:

sessionFactoryClosed in interface SessionFactoryObserver

Parameters:

factory - The factory closed.

addBasicTypeRegistrationContributions

public void addBasicTypeRegistrationContributions(List<BasicTypeRegistration> contributions)

resolveCastTargetType

public BasicType<?> resolveCastTargetType(String name)

Understands the following target type names for the cast() function:

• String
• Character
• Byte, Short, Integer, Long
• Float, Double
• Time, Date, Timestamp
• LocalDate, LocalTime, LocalDateTime
• BigInteger
• BigDecimal
• Binary
• Boolean (fragile, not aware of encoding to character via CharBooleanConverter)

The type names are not case-sensitive.

resolveTupleType

public SqmBindableType<?> resolveTupleType(List<? extends SqmTypedNode<?>> typedNodes)

resolveArithmeticType

public SqmExpressible<?> resolveArithmeticType(SqmExpressible<?> firstType,
 SqmExpressible<?> secondType,
 BinaryArithmeticOperator operator)

See Also:

• QueryHelper.highestPrecedenceType2(org.hibernate.query.sqm.SqmBindableType<? extends X>, org.hibernate.query.sqm.SqmBindableType<? extends X>)

resolveArithmeticType

public SqmExpressible<?> resolveArithmeticType(SqmExpressible<?> firstType,
 SqmExpressible<?> secondType)

Determine the result type of an arithmetic operation as defined by the rules in section 6.5.8.1.

See Also:

• QueryHelper.highestPrecedenceType2(org.hibernate.query.sqm.SqmBindableType<? extends X>, org.hibernate.query.sqm.SqmBindableType<? extends X>)

getBasicTypeForGenericJavaType

public <J> BasicType<J> getBasicTypeForGenericJavaType(Class<? super J> javaType,
 Type... typeArguments)

getBasicTypeForJavaType

public <J> BasicType<J> getBasicTypeForJavaType(Class<J> javaType)

getBasicTypeForJavaType

public <J> BasicType<J> getBasicTypeForJavaType(Type javaType)

standardBasicTypeForJavaType

public <J> BasicType<J> standardBasicTypeForJavaType(Class<J> javaType)

standardBasicTypeForJavaType

public BasicType<?> standardBasicTypeForJavaType(Type javaType)

standardBasicTypeForJavaType

public <J> BasicType<J> standardBasicTypeForJavaType(Class<J> javaType,
 Function<JavaType<J>,BasicType<J>> creator)

standardBasicTypeForJavaType

public <J> BasicType<J> standardBasicTypeForJavaType(Type javaType,
 Function<JavaType<J>,BasicType<J>> creator)

getSqlTemporalType

public TemporalType getSqlTemporalType(SqmExpressible<?> type)

getSqlTemporalType

public static TemporalType getSqlTemporalType(JdbcMapping jdbcMapping)

getSqlTemporalType

public static TemporalType getSqlTemporalType(JdbcMappingContainer jdbcMappings)

getSqlTemporalType

public static TemporalType getSqlTemporalType(MappingModelExpressible<?> type)

getSqlTemporalType

public static TemporalType getSqlTemporalType(JdbcType descriptor)

getSqlTemporalType

protected static TemporalType getSqlTemporalType(int jdbcTypeCode)

getSqlIntervalType

public static IntervalType getSqlIntervalType(JdbcMappingContainer jdbcMappings)

getSqlIntervalType

public static IntervalType getSqlIntervalType(JdbcType descriptor)

getSqlIntervalType

protected static IntervalType getSqlIntervalType(int jdbcTypeCode)

isJdbcTemporalType

public static boolean isJdbcTemporalType(SqmExpressible<?> type)

isDuration

public static boolean isDuration(SqmExpressible<?> type)

createMutabilityPlan

@Internal
public <J> MutabilityPlan<J> createMutabilityPlan(Class<? extends MutabilityPlan<?>> planClass)

getJsonFormatMapper

@Internal
@Incubating
public final FormatMapper getJsonFormatMapper()

getXmlFormatMapper

@Internal
@Incubating
public final FormatMapper getXmlFormatMapper()