Class JdbcTimestampJavaType

java.lang.Object
org.hibernate.type.descriptor.java.AbstractClassJavaType<Date>
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:
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.

  • Field Details

  • Constructor Details

    • JdbcTimestampJavaType

      public JdbcTimestampJavaType()

  • Method Details

    • getJavaType

      public Class<Date> getJavaType()
      Description copied from interface: JavaType
      Get the Java type (a Type object) described by this JavaType.
      Specified by:
      getJavaType in interface JavaType<Date>
      Overrides:
      getJavaType in class AbstractClassJavaType<Date>
      See Also:

    • 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.

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

    • cast

      public Date 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<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)
      Description copied from interface: JavaType
      Coerce the given value to this type, if possible.

      This method differs from wrap() in that it allows simple, basic, implicit type conversions, and does not require WrapperOptions. The wrap() method may be thought of as offering explicitly requested type conversions driven by a choice of JdbcType.

      An implementation of this method reports failure in one of two ways, by:

      Therefore, this method is declared to return Object. In case immediate coercion is required, the following idiom may be used: 

      javaType.cast(javaType.coerce(value))
      Specified by:
      coerce in interface JavaType<Date>
      Parameters:
      value - The value to coerce
      Returns:
      The coerced value, or the given value if no coercion was possible

    • unwrap

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

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