Package org.hibernate.type.descriptor.java

Class JdbcTimestampJavaType

java.lang.Object

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

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

org.hibernate.type.descriptor.java.JdbcTimestampJavaType

All Implemented Interfaces:

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

public class JdbcTimestampJavaType
extends AbstractTemporalJavaType<Date>
implements VersionJavaType<Date>

Descriptor for Timestamp handling.

See Also:

Serialized Form

Implementation Specification:

Unlike most JavaType implementations, can handle 2 different "domain representations" (most map just a single type): general Date values in addition to Timestamp values. This capability is shared with JdbcDateJavaType and JdbcTimeJavaType.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcTimestampJavaType.TimestampMutabilityPlan

Nested classes/interfaces inherited from interface org.hibernate.type.descriptor.java.JavaType

JavaType.CoercionContext

Field Summary

Fields

Modifier and Type	Field	Description
static JdbcTimestampJavaType	INSTANCE
static DateTimeFormatter	LITERAL_FORMATTER	Intended for use in reading HQL literals and writing SQL literals
static String	TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor	Description
JdbcTimestampJavaType()

Method Summary

Modifier and Type	Method	Description
void	appendEncodedString(SqlAppender sb, Date value)	Appends the value to the SqlAppender in an encoded format that can be decoded again by JavaType.fromEncodedString(CharSequence, int, int).
boolean	areEqual(Date one, Date another)	Determine if two instances are equal
Date	coerce(Object value, JavaType.CoercionContext coercionContext)
int	extractHashCode(Date value)	Extract a proper hash code for the given value.
protected <X> TemporalJavaType<X>	forDatePrecision(TypeConfiguration typeConfiguration)
protected <X> TemporalJavaType<X>	forTimestampPrecision(TypeConfiguration typeConfiguration)
Date	fromEncodedString(CharSequence charSequence, int start, int end)	Reads the encoded value from the char sequence start index until the end index and returns the decoded value.
Date	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?
boolean	isWider(JavaType<?> javaType)	Determines if this Java type is wider than the given Java type, that is, if the given type can be safely widened to this type.
Date	next(Date current, Long length, Integer precision, Integer scale, SharedSessionContractImplementor session)	Increment the version.
Date	seed(Long length, Integer precision, Integer scale, SharedSessionContractImplementor session)	Generate an initial version.
String	toString(Date value)
Object	unwrap(Date value, Class type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
<X> Date	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

Methods inherited from class org.hibernate.type.descriptor.java.AbstractTemporalJavaType

forTimePrecision, resolveTypeForPrecision, toString

Methods inherited from class org.hibernate.type.descriptor.java.AbstractClassJavaType

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.type.descriptor.java.JavaType

createJavaType, createJavaType, extractLoggableRepresentation, getCheckCondition, getComparator, getDefaultSqlLength, getDefaultSqlScale, getDefaultValue, getJavaType, getJavaTypeClass, getLongSqlLength, getMutabilityPlan, getReplacement, getTypeName, useObjectEqualsHashCode

Methods inherited from interface org.hibernate.type.descriptor.java.TemporalJavaType

isTemporalType

Field Detail

INSTANCE

public static final JdbcTimestampJavaType INSTANCE

TIMESTAMP_FORMAT

public static final String TIMESTAMP_FORMAT

See Also:

Constant Field Values

LITERAL_FORMATTER

public static final DateTimeFormatter LITERAL_FORMATTER

Intended for use in reading HQL literals and writing SQL literals

See Also:

TIMESTAMP_FORMAT

Constructor Detail

JdbcTimestampJavaType

public JdbcTimestampJavaType()

Method Detail

getPrecision

public TemporalType getPrecision()

Description copied from interface: TemporalJavaType

The precision represented by this type

Specified by:

getPrecision in interface TemporalJavaType<Date>

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.

Specified by:

isInstance in interface JavaType<Date>

areEqual

public boolean areEqual(Date one,
                        Date another)

Description copied from interface: JavaType

Determine if two instances are equal

Specified by:

areEqual in interface JavaType<Date>

Overrides:

areEqual in class AbstractClassJavaType<Date>

Parameters:

one - One instance

another - The other instance

Returns:

True if the two are considered equal; false otherwise.

extractHashCode

public int extractHashCode(Date value)

Description copied from interface: JavaType

Extract a proper hash code for the given value.

Specified by:

extractHashCode in interface JavaType<Date>

Overrides:

extractHashCode in class AbstractClassJavaType<Date>

Parameters:

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

Returns:

The extracted hash code.

coerce

public Date coerce(Object value,
                   JavaType.CoercionContext coercionContext)

Specified by:

coerce in interface JavaType<Date>

unwrap

public Object unwrap(Date value,
                     Class 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<Date>

Parameters:

value - The value to unwrap

type - The type as which to unwrap

options - The options

Returns:

The unwrapped value.

wrap

public <X> Date 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<Date>

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

isWider

public boolean isWider(JavaType<?> javaType)

Description copied from interface: JavaType

Determines if this Java type is wider than the given Java type, that is, if the given type can be safely widened to this type.

Specified by:

isWider in interface JavaType<Date>

toString

public String toString(Date value)

Specified by:

toString in interface JavaType<Date>

fromString

public Date fromString(CharSequence string)

Specified by:

fromString in interface BasicJavaType<Date>

Specified by:

fromString in interface JavaType<Date>

appendEncodedString

public void appendEncodedString(SqlAppender sb,
                                Date value)

Description copied from interface: JavaType

Appends the value to the SqlAppender in an encoded format that can be decoded again by JavaType.fromEncodedString(CharSequence, int, int). Implementers do not need to care about escaping. This is similar to JavaType.toString(Object), with the difference that the aim of this method is encoding to the appender.

Specified by:

appendEncodedString in interface JavaType<Date>

fromEncodedString

public Date fromEncodedString(CharSequence charSequence,
                              int start,
                              int end)

Description copied from interface: JavaType

Reads the encoded value from the char sequence start index until the end index and returns the decoded value. Implementers do not need to care about escaping. This is similar to JavaType.fromString(CharSequence), with the difference that the aim of this method is decoding from a range within an existing char sequence.

Specified by:

fromEncodedString in interface JavaType<Date>

getRecommendedJdbcType

public JdbcType getRecommendedJdbcType(JdbcTypeIndicators context)

Description copied from interface: JavaType

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<Date>

Specified by:

getRecommendedJdbcType in interface JavaType<Date>

Parameters:

context - Contextual information

Returns:

The recommended SQL type descriptor

forTimestampPrecision

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

Overrides:

forTimestampPrecision in class AbstractTemporalJavaType<Date>

forDatePrecision

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

Overrides:

forDatePrecision in class AbstractTemporalJavaType<Date>

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<Date>

Returns:

Size.DEFAULT_PRECISION unless overridden

next

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

Description copied from interface: VersionJavaType

Increment the version.

Specified by:

next in interface VersionJavaType<Date>

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

seed

public Date 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<Date>

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