Class InstantJavaType

java.lang.Object

org.hibernate.type.descriptor.java.AbstractClassJavaType<Instant>

org.hibernate.type.descriptor.java.AbstractTemporalJavaType<Instant>

org.hibernate.type.descriptor.java.InstantJavaType

All Implemented Interfaces:

Serializable, BasicJavaType<Instant>, JavaType<Instant>, TemporalJavaType<Instant>, VersionJavaType<Instant>

public class InstantJavaType
extends AbstractTemporalJavaType<Instant>
implements VersionJavaType<Instant>

Java type descriptor for the Java Instant type.

See Also:

• MappingSettings.PREFERRED_INSTANT_JDBC_TYPE
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface JavaType

JavaType.CoercionContext

Field Summary

Fields

Modifier and Type	Field	Description
static final InstantJavaType	INSTANCE	Singleton access

Constructor Summary

Constructors

Constructor	Description
InstantJavaType()

Method Summary

Modifier and Type	Method	Description
Instant	cast(Object value)	Apply a simple type cast to the given value, without attempting any sort of coercion or wrapping.
protected <X> TemporalJavaType<X>	forDatePrecision(TypeConfiguration typeConfiguration)
protected <X> TemporalJavaType<X>	forTimePrecision(TypeConfiguration typeConfiguration)
protected <X> TemporalJavaType<X>	forTimestampPrecision(TypeConfiguration typeConfiguration)
Instant	fromString(CharSequence string)
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.
TemporalType	getPrecision()	The precision represented by this type
JdbcType	getRecommendedJdbcType(JdbcTypeIndicators context)	Obtain the "recommended" SQL type descriptor for this Java type.
boolean	isInstance(Object value)	Is the given value an instance of the described type?
Instant	next(Instant current, Long length, Integer precision, Integer scale, SharedSessionContractImplementor session)	Increment the version.
Instant	seed(Long length, Integer precision, Integer scale, SharedSessionContractImplementor session)	Generate an initial version.
String	toString(Instant value)
<X> X	unwrap(Instant instant, Class<X> type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
boolean	useObjectEqualsHashCode()	Whether to use Object.equals(Object) and Object.hashCode() or JavaType.areEqual(Object, Object) and JavaType.extractHashCode(Object) for objects of this java type.
<X> Instant	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

Methods inherited from class AbstractTemporalJavaType

resolveTypeForPrecision, toString

Methods inherited from class AbstractClassJavaType

areEqual, extractHashCode, extractLoggableRepresentation, getComparator, getJavaType, getJavaTypeClass, getMutabilityPlan, unknownUnwrap, unknownWrap

Methods inherited from class Object

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

Methods inherited from interface JavaType

appendEncodedString, areEqual, coerce, createJavaType, extractHashCode, extractLoggableRepresentation, fromEncodedString, fromEncodedString, getCheckCondition, getComparator, getDefaultSqlLength, getDefaultSqlScale, getDefaultValue, getJavaType, getJavaTypeClass, getLongSqlLength, getMutabilityPlan, getReplacement, getTypeName, isWider

Methods inherited from interface TemporalJavaType

isTemporalType

Field Details

INSTANCE

public static final InstantJavaType INSTANCE

Singleton access

Constructor Details

InstantJavaType

public InstantJavaType()

Method Details

isInstance

public boolean isInstance(Object value)

Description copied from interface: JavaType

Is the given value an instance of the described type?

Usually just getJavaTypeClass().isInstance(value), but some descriptors need specialized semantics, for example, the descriptors for java.sql.Date, java.sql.Time, and java.sql.Timestamp.

For EntityJavaType, this method handles proxies in a semantically correct way, by checking the entity instance underlying the proxy object.

Specified by:

isInstance in interface JavaType<Instant>

cast

public Instant cast(Object value)

Description copied from interface: JavaType

Apply a simple type cast to the given value, without attempting any sort of coercion or wrapping. This method is provided as a convenient way to avoid an unchecked cast to a type variable. Use javaType.cast(value) instead of (T) value wherever possible.

Usually just getJavaTypeClass().cast(value), but overridden in some cases as an "optimization". This optimization is almost certainly unnecessary, and might even indeed be harmful, since Class.cast() is an intrinsic.

Specified by:

cast in interface JavaType<Instant>

getPrecision

public TemporalType getPrecision()

Description copied from interface: TemporalJavaType

The precision represented by this type

Specified by:

getPrecision in interface TemporalJavaType<Instant>

forDatePrecision

protected <X> TemporalJavaType<X> forDatePrecision(TypeConfiguration typeConfiguration)

Overrides:

forDatePrecision in class AbstractTemporalJavaType<Instant>

forTimestampPrecision

protected <X> TemporalJavaType<X> forTimestampPrecision(TypeConfiguration typeConfiguration)

Overrides:

forTimestampPrecision in class AbstractTemporalJavaType<Instant>

forTimePrecision

protected <X> TemporalJavaType<X> forTimePrecision(TypeConfiguration typeConfiguration)

Overrides:

forTimePrecision in class AbstractTemporalJavaType<Instant>

getRecommendedJdbcType

public JdbcType getRecommendedJdbcType(JdbcTypeIndicators context)

Description copied from interface: BasicJavaType

Obtain the "recommended" SQL type descriptor for this Java type. Often, but not always, the source of this recommendation is the JDBC specification.

Specified by:

getRecommendedJdbcType in interface BasicJavaType<Instant>

Specified by:

getRecommendedJdbcType in interface JavaType<Instant>

Parameters:

context - Contextual information

Returns:

The recommended SQL type descriptor

useObjectEqualsHashCode

public boolean useObjectEqualsHashCode()

Description copied from interface: JavaType

Whether to use Object.equals(Object) and Object.hashCode() or JavaType.areEqual(Object, Object) and JavaType.extractHashCode(Object) for objects of this java type. This is useful to avoid mega-morphic callsites.

Specified by:

useObjectEqualsHashCode in interface JavaType<Instant>

toString

public String toString(Instant value)

Specified by:

toString in interface JavaType<Instant>

fromString

public Instant fromString(CharSequence string)

Specified by:

fromString in interface BasicJavaType<Instant>

Specified by:

fromString in interface JavaType<Instant>

unwrap

public <X> X unwrap(Instant instant,
 Class<X> type,
 WrapperOptions options)

Description copied from interface: JavaType

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.

Specified by:

unwrap in interface JavaType<Instant>

Type Parameters:

X - The conversion type.

Parameters:

instant - The value to unwrap

type - The type as which to unwrap

options - The options

Returns:

The unwrapped value.

wrap

public <X> Instant wrap(X value,
 WrapperOptions options)

Description copied from interface: JavaType

Wrap a value as our handled Java type.

Intended use is during ResultSet extraction.

Specified by:

wrap in interface JavaType<Instant>

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

getDefaultSqlPrecision

public int getDefaultSqlPrecision(Dialect dialect,
 JdbcType jdbcType)

Description copied from interface: JavaType

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

Specified by:

getDefaultSqlPrecision in interface JavaType<Instant>

Returns:

Size.DEFAULT_PRECISION unless overridden

seed

public Instant seed(Long length,
 Integer precision,
 Integer scale,
 SharedSessionContractImplementor session)

Description copied from interface: VersionJavaType

Generate an initial version.

Note that this operation is only used when the program sets a null or negative number as the value of the entity version field. It is not called when the program sets the version field to a sensible-looking version.

Specified by:

seed in interface VersionJavaType<Instant>

Parameters:

length - The length of the type

precision - The precision of the type

scale - The scale of the type

session - The session from which this request originates.

Returns:

an instance of the type

next

public Instant next(Instant current,
 Long length,
 Integer precision,
 Integer scale,
 SharedSessionContractImplementor session)

Description copied from interface: VersionJavaType

Increment the version.

Specified by:

next in interface VersionJavaType<Instant>

Parameters:

current - the current version

length - The length of the type

precision - The precision of the type

scale - The scale of the type

session - The session from which this request originates.

Returns:

an instance of the type