Package org.hibernate.type

Interface BasicType<T>

All Superinterfaces:

BasicDomainType<T>, BasicType<T>, BasicValuedMapping, Bindable, BindableType<T>, DomainType<T>, JavaTypedExpressible, JdbcMapping, JdbcMappingContainer, MappingModelExpressible, MappingType, OutputableType<T>, ReturnableType<T>, Serializable, SimpleDomainType<T>, SqlExpressible, SqmExpressible<T>, Type<T>, Type, ValueMapping

All Known Subinterfaces:

AdjustableBasicType<J>, BasicPluralType<C,E>, ConvertedBasicType<J>

All Known Implementing Classes:

AbstractSingleColumnStandardBasicType, AbstractStandardBasicType, BasicArrayType, BasicCollectionType, CustomType, DbTimestampType, DiscriminatorType, JavaObjectType, NullType, SerializableToBlobType, SerializableType, StandardBasicTypeTemplate

public interface BasicType<T>
extends Type, BasicDomainType<T>, MappingType, BasicValuedMapping, JdbcMapping

Marker interface for basic types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Type

Type.PersistenceType

Method Summary

Modifier and Type	Method	Description
default Object	disassemble(Object value, SharedSessionContractImplementor session)
default int	forEachDisassembledJdbcValue(Object value, Clause clause, int offset, Bindable.JdbcValuesConsumer valuesConsumer, SharedSessionContractImplementor session)
default int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
default int	forEachJdbcType(IndexedConsumer<JdbcMapping> action)	Visit each of JdbcMapping
default JavaType<T>	getExpressibleJavaType()	The descriptor for the Java type (i.e.
default JavaType<T>	getJavaTypeDescriptor()	The descriptor for the Java type represented by this expressible type
default JdbcLiteralFormatter<T>	getJdbcLiteralFormatter()	The strategy for formatting values of this expressible type to a SQL literal.
default JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
default List<JdbcMapping>	getJdbcMappings()	The list of JDBC mappings
default int	getJdbcTypeCount()	The number of JDBC mappings
default ValueBinder<T>	getJdbcValueBinder()	The strategy for binding values of this expressible type to JDBC PreparedStatements and CallableStatements.
default ValueExtractor<T>	getJdbcValueExtractor()	The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc
default JavaType<T>	getMappedJavaType()
default MappingType	getMappedType()	Descriptor for the type of this mapping
String[]	getRegistrationKeys()	Get the names under which this type should be registered in the type registry.
default BasicValueConverter<T,?>	getValueConverter()	Returns the converter that this basic type uses for transforming from the domain type, to the relational type, or null if there is no conversion.

Methods inherited from interface org.hibernate.metamodel.model.domain.BasicDomainType

areEqual, getPersistenceType

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

forEachDisassembledJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface org.hibernate.metamodel.model.domain.DomainType

getTypeName

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMapping

getCastType, getJdbcJavaType, getJdbcType

Methods inherited from interface org.hibernate.query.OutputableType

canDoExtraction, extract, extract, getJdbcType

Methods inherited from interface org.hibernate.metamodel.model.domain.SimpleDomainType

getBindableJavaType

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

isInstance, resolveExpressible

Methods inherited from interface jakarta.persistence.metamodel.Type

getJavaType

Methods inherited from interface org.hibernate.type.Type

assemble, beforeAssemble, compare, deepCopy, disassemble, disassemble, getColumnSpan, getHashCode, getHashCode, getName, getReturnedClass, getSqlTypeCodes, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isDirty, isEntityType, isEqual, isEqual, isModified, isMutable, isSame, nullSafeSet, nullSafeSet, replace, replace, toColumnNullness, toLoggableString

Methods inherited from interface org.hibernate.metamodel.mapping.ValueMapping

treatAs

Method Detail

getRegistrationKeys

String[] getRegistrationKeys()

Get the names under which this type should be registered in the type registry.

Returns:

The keys under which to register this type.

getMappedType

default MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

getJavaTypeDescriptor

default JavaType<T> getJavaTypeDescriptor()

Description copied from interface: JdbcMapping

The descriptor for the Java type represented by this expressible type

Specified by:

getJavaTypeDescriptor in interface JdbcMapping

getExpressibleJavaType

default JavaType<T> getExpressibleJavaType()

Description copied from interface: DomainType

The descriptor for the Java type (i.e. Class) represented by this DomainType.

Specified by:

getExpressibleJavaType in interface DomainType<T>

Specified by:

getExpressibleJavaType in interface JavaTypedExpressible<T>

Specified by:

getExpressibleJavaType in interface SqmExpressible<T>

Specified by:

getExpressibleJavaType in interface ValueMapping

See Also:

DomainType.getTypeName()

forEachJdbcType

default int forEachJdbcType(IndexedConsumer<JdbcMapping> action)

Description copied from interface: Bindable

Visit each of JdbcMapping

Specified by:

forEachJdbcType in interface Bindable

Specified by:

forEachJdbcType in interface JdbcMapping

Specified by:

forEachJdbcType in interface JdbcMappingContainer

getJdbcMapping

default JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface SqlExpressible

getJdbcTypeCount

default int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface BasicValuedMapping

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface JdbcMapping

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

getJdbcMappings

default List<JdbcMapping> getJdbcMappings()

Description copied from interface: Bindable

The list of JDBC mappings

Specified by:

getJdbcMappings in interface BasicValuedMapping

Specified by:

getJdbcMappings in interface Bindable

Specified by:

getJdbcMappings in interface JdbcMapping

Specified by:

getJdbcMappings in interface JdbcMappingContainer

getMappedJavaType

default JavaType<T> getMappedJavaType()

Specified by:

getMappedJavaType in interface JdbcMapping

Specified by:

getMappedJavaType in interface MappingType

getValueConverter

default BasicValueConverter<T,?> getValueConverter()

Description copied from interface: JdbcMapping

Returns the converter that this basic type uses for transforming from the domain type, to the relational type, or null if there is no conversion.

Specified by:

getValueConverter in interface JdbcMapping

getJdbcValueExtractor

default ValueExtractor<T> getJdbcValueExtractor()

Description copied from interface: JdbcMapping

The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc

Specified by:

getJdbcValueExtractor in interface JdbcMapping

getJdbcValueBinder

default ValueBinder<T> getJdbcValueBinder()

Description copied from interface: JdbcMapping

The strategy for binding values of this expressible type to JDBC PreparedStatements and CallableStatements.

Specified by:

getJdbcValueBinder in interface JdbcMapping

getJdbcLiteralFormatter

default JdbcLiteralFormatter<T> getJdbcLiteralFormatter()

Description copied from interface: JdbcMapping

The strategy for formatting values of this expressible type to a SQL literal.

Specified by:

getJdbcLiteralFormatter in interface JdbcMapping

forEachJdbcType

default int forEachJdbcType(int offset,
                            IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface JdbcMapping

Specified by:

forEachJdbcType in interface JdbcMappingContainer

disassemble

default Object disassemble(Object value,
                           SharedSessionContractImplementor session)

Specified by:

disassemble in interface Bindable

See Also:

As an example, consider the following domain model: ````

forEachDisassembledJdbcValue

default int forEachDisassembledJdbcValue(Object value,
                                         Clause clause,
                                         int offset,
                                         Bindable.JdbcValuesConsumer valuesConsumer,
                                         SharedSessionContractImplementor session)

Specified by:

forEachDisassembledJdbcValue in interface Bindable