Package org.hibernate.type.descriptor.java

Interface JavaType<T>

All Superinterfaces:

Serializable

All Known Subinterfaces:

BasicJavaType<T>, PrimitiveJavaType<J>, TemporalJavaType<T>, VersionJavaType<T>

All Known Implementing Classes:

AbstractArrayJavaType, AbstractClassJavaType, AbstractJavaType, AbstractTemporalJavaType, ArrayJavaType, BasicCollectionJavaType, BigDecimalJavaType, BigIntegerJavaType, BlobJavaType, BooleanJavaType, BooleanPrimitiveArrayJavaType, ByteArrayJavaType, ByteJavaType, CalendarDateJavaType, CalendarJavaType, CalendarTimeJavaType, CharacterArrayJavaType, CharacterJavaType, ClassJavaType, ClobJavaType, CollectionJavaType, CompositeUserTypeJavaTypeWrapper, CurrencyJavaType, DateJavaType, DbTimestampJavaType, DoubleJavaType, DoublePrimitiveArrayJavaType, DurationJavaType, DynamicModelJavaType, EntityJavaType, EnumJavaType, FloatJavaType, FloatPrimitiveArrayJavaType, GeolatteGeometryJavaType, InetAddressJavaType, InstantJavaType, IntegerJavaType, IntegerPrimitiveArrayJavaType, JavaTypeBasicAdaptor, JdbcDateJavaType, JdbcTimeJavaType, JdbcTimestampJavaType, JTSGeometryJavaType, LocalDateJavaType, LocalDateTimeJavaType, LocaleJavaType, LocalTimeJavaType, LongJavaType, LongPrimitiveArrayJavaType, MapEntryJavaType, NClobJavaType, ObjectArrayJavaType, ObjectJavaType, OffsetDateTimeJavaType, OffsetTimeJavaType, PrimitiveByteArrayJavaType, PrimitiveCharacterArrayJavaType, RowVersionJavaType, SerializableJavaType, ShortJavaType, ShortPrimitiveArrayJavaType, StringJavaType, TimeZoneJavaType, UnknownBasicJavaType, UrlJavaType, UserTypeJavaTypeWrapper, UserTypeVersionJavaTypeWrapper, UUIDJavaType, YearJavaType, ZonedDateTimeJavaType, ZoneIdJavaType, ZoneOffsetJavaType

public interface JavaType<T>
extends Serializable

Descriptor for the Java side of a value mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JavaType.CoercionContext

Method Summary

Modifier and Type	Method	Description
default boolean	areEqual(T one, T another)	Determine if two instances are equal
default <X> T	coerce(X value, JavaType.CoercionContext coercionContext)
default JavaType<T>	createJavaType(ParameterizedType parameterizedType)	Deprecated. Use createJavaType(ParameterizedType, TypeConfiguration) instead
default JavaType<T>	createJavaType(ParameterizedType parameterizedType, TypeConfiguration typeConfiguration)	Creates the JavaType for the given ParameterizedType based on this JavaType registered for the raw type.
default int	extractHashCode(T value)	Extract a proper hash code for this value.
default String	extractLoggableRepresentation(T value)	Extract a loggable representation of the value.
T	fromString(CharSequence string)
default String	getCheckCondition(String columnName, JdbcType sqlType, Dialect dialect)	The check constraint that should be added to the column definition in generated DDL.
default Comparator<T>	getComparator()	Retrieve the natural comparator for this type.
default long	getDefaultSqlLength(Dialect dialect, JdbcType jdbcType)	The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.
default int	getDefaultSqlPrecision(Dialect dialect, JdbcType jdbcType)	The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.
default int	getDefaultSqlScale(Dialect dialect, JdbcType jdbcType)	The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.
default T	getDefaultValue()	Get this Java type's default value.
default Type	getJavaType()	Get the Java type (Type) described
default Class<T>	getJavaTypeClass()	Get the Java type (Class) described
default long	getLongSqlLength()	The default column length when this Java type is mapped to a column of type Types.LONGVARCHAR or Types.LONGVARBINARY.
default MutabilityPlan<T>	getMutabilityPlan()	Retrieve the mutability plan for this Java type.
JdbcType	getRecommendedJdbcType(JdbcTypeIndicators context)	Obtain the "recommended" SQL type descriptor for this Java type.
default T	getReplacement(T original, T target, SharedSessionContractImplementor session)
default boolean	isInstance(Object value)	Is the given value an instance of the described type? Generally this comes down to getJavaTypeClass().isInstance(), though some descriptors (mainly the java.sql.Date, Time and Timestamp descriptors) might need different semantics
default boolean	isWider(JavaType<?> javaType)	Returns whether this java type is wider than the given type i.e.
default String	toString(T value)
<X> X	unwrap(T value, Class<X> type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
<X> T	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

Method Detail

getJavaType

default Type getJavaType()

Get the Java type (Type) described

See Also:

getJavaTypeClass()

getJavaTypeClass

default Class<T> getJavaTypeClass()

Get the Java type (Class) described

See Also:

getJavaType()

isInstance

default boolean isInstance(Object value)

Is the given value an instance of the described type? Generally this comes down to getJavaTypeClass().isInstance(), though some descriptors (mainly the java.sql.Date, Time and Timestamp descriptors) might need different semantics

getMutabilityPlan

default MutabilityPlan<T> getMutabilityPlan()

Retrieve the mutability plan for this Java type.

getReplacement

default T getReplacement(T original,
                         T target,
                         SharedSessionContractImplementor session)

getDefaultValue

default T getDefaultValue()

Get this Java type's default value.

Returns:

The default value.

getRecommendedJdbcType

JdbcType getRecommendedJdbcType(JdbcTypeIndicators context)

Obtain the "recommended" SQL type descriptor for this Java type. The recommended aspect comes from the JDBC spec (mostly).

Parameters:

context - Contextual information

Returns:

The recommended SQL type descriptor

getDefaultSqlLength

default long getDefaultSqlLength(Dialect dialect,
                                 JdbcType jdbcType)

The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.

Returns:

Size.DEFAULT_LENGTH unless overridden

getLongSqlLength

default long getLongSqlLength()

The default column length when this Java type is mapped to a column of type Types.LONGVARCHAR or Types.LONGVARBINARY.

Returns:

Size.LONG_LENGTH unless overridden

getDefaultSqlPrecision

default int getDefaultSqlPrecision(Dialect dialect,
                                   JdbcType jdbcType)

The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.

Returns:

Size.DEFAULT_PRECISION unless overridden

getDefaultSqlScale

default int getDefaultSqlScale(Dialect dialect,
                               JdbcType jdbcType)

The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.

Returns:

Size.DEFAULT_SCALE unless overridden

getComparator

default Comparator<T> getComparator()

Retrieve the natural comparator for this type.

extractHashCode

default int extractHashCode(T value)

Extract a proper hash code for this value.

Parameters:

value - The value for which to extract a hash code.

Returns:

The extracted hash code.

areEqual

default boolean areEqual(T one,
                         T another)

Determine if two instances are equal

Parameters:

one - One instance

another - The other instance

Returns:

True if the two are considered equal; false otherwise.

extractLoggableRepresentation

default String extractLoggableRepresentation(T value)

Extract a loggable representation of the value.

Parameters:

value - The value for which to extract a loggable representation.

Returns:

The loggable representation

toString

default String toString(T value)

fromString

T fromString(CharSequence string)

unwrap

<X> X unwrap(T value,
             Class<X> type,
             WrapperOptions options)

Unwrap an instance of our handled Java type into the requested type.

As an example, if this is a JavaType<Integer> and we are asked to unwrap the Integer value as a Long we would return something like Long.valueOf( value.longValue() ).

Intended use is during PreparedStatement binding.

Type Parameters:

X - The conversion type.

Parameters:

value - The value to unwrap

type - The type as which to unwrap

options - The options

Returns:

The unwrapped value.

wrap

<X> T wrap(X value,
           WrapperOptions options)

Wrap a value as our handled Java type.

Intended use is during ResultSet extraction.

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

isWider

default boolean isWider(JavaType<?> javaType)

Returns whether this java type is wider than the given type i.e. if the given type can be widened to this java type.

coerce

default <X> T coerce(X value,
                     JavaType.CoercionContext coercionContext)

getCheckCondition

default String getCheckCondition(String columnName,
                                 JdbcType sqlType,
                                 Dialect dialect)

The check constraint that should be added to the column definition in generated DDL.

Parameters:

columnName - the name of the column

sqlType - the JdbcType of the mapped column

dialect - the SQL Dialect

Returns:

a check constraint condition or null

createJavaType

@Deprecated(since="6.1")
default JavaType<T> createJavaType(ParameterizedType parameterizedType)

Deprecated.

Use createJavaType(ParameterizedType, TypeConfiguration) instead

Creates the JavaType for the given ParameterizedType based on this JavaType registered for the raw type.

createJavaType

default JavaType<T> createJavaType(ParameterizedType parameterizedType,
                                   TypeConfiguration typeConfiguration)

Creates the JavaType for the given ParameterizedType based on this JavaType registered for the raw type.

Since:

6.1