Module java.sql
Package java.sql

Class Timestamp

java.lang.Object
java.util.Date
java.sql.Timestamp
All Implemented Interfaces:
Serializable,Cloneable,Comparable<Date>

public classTimestampextendsDate

A thin wrapper aroundjava.util.Date that allows the JDBC API to identify this as an SQLTIMESTAMP value. It adds the ability to hold the SQLTIMESTAMP fractional seconds value, by allowing the specification of fractional seconds to a precision of nanoseconds. A Timestamp also provides formatting and parsing operations to support the JDBC escape syntax for timestamp values.

The precision of a Timestamp object is calculated to be either:

  • 19, which is the number of characters in yyyy-mm-dd hh:mm:ss
  • 20 + s, which is the number of characters in the yyyy-mm-dd hh:mm:ss.[fff...] ands represents the scale of the given Timestamp, its fractional seconds precision.

Note: This type is a composite of ajava.util.Date and a separate nanoseconds value. Only integral seconds are stored in thejava.util.Date component. The fractional seconds - the nanos - are separate. TheTimestamp.equals(Object) method never returnstrue when passed an object that isn't an instance ofjava.sql.Timestamp, because the nanos component of a date is unknown. As a result, theTimestamp.equals(Object) method is not symmetric with respect to thejava.util.Date.equals(Object) method. Also, thehashCode method uses the underlyingjava.util.Date implementation and therefore does not include nanos in its computation.

Due to the differences between theTimestamp class and thejava.util.Date class mentioned above, it is recommended that code not viewTimestamp values generically as an instance ofjava.util.Date. The inheritance relationship betweenTimestamp andjava.util.Date really denotes implementation inheritance, and not type inheritance.

Since:
1.1
See Also:
  • Constructor Details

    • Timestamp

      @Deprecated(since="1.2")public Timestamp(int year, int month, int date, int hour, int minute, int second, int nano)
      Deprecated.
      instead use the constructorTimestamp(long millis)
      Constructs aTimestamp object initialized with the given values.
      Parameters:
      year - the year minus 1900
      month - 0 to 11
      date - 1 to 31
      hour - 0 to 23
      minute - 0 to 59
      second - 0 to 59
      nano - 0 to 999,999,999
      Throws:
      IllegalArgumentException - if the nano argument is out of bounds
    • Timestamp

      public Timestamp(long time)
      Constructs aTimestamp object using a milliseconds time value. The integral seconds are stored in the underlying date value; the fractional seconds are stored in thenanos field of theTimestamp object.
      Parameters:
      time - milliseconds since January 1, 1970, 00:00:00 GMT. A negative number is the number of milliseconds before January 1, 1970, 00:00:00 GMT.
      See Also:
  • Method Details

    • setTime

      public void setTime(long time)
      Sets thisTimestamp object to represent a point in time that istime milliseconds after January 1, 1970 00:00:00 GMT.
      Overrides:
      setTime in class Date
      Parameters:
      time - the number of milliseconds.
      See Also:
    • getTime

      public long getTime()
      Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by thisTimestamp object.
      Overrides:
      getTime in class Date
      Returns:
      the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date.
      See Also:
    • valueOf

      public static Timestamp valueOf(String s)
      Converts aString object in JDBC timestamp escape format to aTimestamp value.
      Parameters:
      s - timestamp in formatyyyy-[m]m-[d]d hh:mm:ss[.f...]. The fractional seconds may be omitted. The leading zero formm anddd may also be omitted.
      Returns:
      correspondingTimestamp value
      Throws:
      IllegalArgumentException - if the given argument does not have the formatyyyy-[m]m-[d]d hh:mm:ss[.f...]
    • toString

      public String toString()
      Formats a timestamp in JDBC timestamp escape format.yyyy-mm-dd hh:mm:ss.fffffffff, wherefffffffff indicates nanoseconds.
      Overrides:
      toString in class Date
      Returns:
      aString object inyyyy-mm-dd hh:mm:ss.fffffffff format
      See Also:
    • getNanos

      public int getNanos()
      Gets thisTimestamp object'snanos value.
      Returns:
      thisTimestamp object's fractional seconds component
      See Also:
    • setNanos

      public void setNanos(int n)
      Sets thisTimestamp object'snanos field to the given value.
      Parameters:
      n - the new fractional seconds component
      Throws:
      IllegalArgumentException - if the given argument is greater than 999999999 or less than 0
      See Also:
    • equals

      public boolean equals(Timestamp ts)
      Tests to see if thisTimestamp object is equal to the givenTimestamp object.
      Parameters:
      ts - theTimestamp value to compare with
      Returns:
      true if the givenTimestamp object is equal to thisTimestamp object;false otherwise
    • equals

      public boolean equals(Object ts)
      Tests to see if thisTimestamp object is equal to the given object. This version of the methodequals has been added to fix the incorrect signature ofTimestamp.equals(Timestamp) and to preserve backward compatibility with existing class files. Note: This method is not symmetric with respect to theequals(Object) method in the base class.
      Overrides:
      equals in class Date
      Parameters:
      ts - theObject value to compare with
      Returns:
      true if the givenObject is an instance of aTimestamp that is equal to thisTimestamp object;false otherwise
      See Also:
    • before

      public boolean before(Timestamp ts)
      Indicates whether thisTimestamp object is earlier than the givenTimestamp object.
      Parameters:
      ts - theTimestamp value to compare with
      Returns:
      true if thisTimestamp object is earlier;false otherwise
    • after

      public boolean after(Timestamp ts)
      Indicates whether thisTimestamp object is later than the givenTimestamp object.
      Parameters:
      ts - theTimestamp value to compare with
      Returns:
      true if thisTimestamp object is later;false otherwise
    • compareTo

      public int compareTo(Timestamp ts)
      Compares thisTimestamp object to the givenTimestamp object.
      Parameters:
      ts - theTimestamp object to be compared to thisTimestamp object
      Returns:
      the value0 if the twoTimestamp objects are equal; a value less than0 if thisTimestamp object is before the given argument; and a value greater than0 if thisTimestamp object is after the given argument.
      Since:
      1.4
    • compareTo

      public int compareTo(Date o)
      Compares thisTimestamp object to the givenDate object.
      Specified by:
      compareTo in interface Comparable<Date>
      Overrides:
      compareTo in class Date
      Parameters:
      o - theDate to be compared to thisTimestamp object
      Returns:
      the value0 if thisTimestamp object and the given object are equal; a value less than0 if thisTimestamp object is before the given argument; and a value greater than0 if thisTimestamp object is after the given argument.
      Since:
      1.5
    • hashCode

      public int hashCode()
      Returns a hash code value for this object. The result is the exclusive OR of the two halves of the primitivelong value returned by theDate.getTime() method. That is, the hash code is the value of the expression:
       (int)(this.getTime()^(this.getTime() >>> 32))
      ThehashCode method uses the underlyingjava.util.Date implementation and therefore does not include nanos in its computation.
      Overrides:
      hashCode in class Date
      Returns:
      a hash code value for this object.
      See Also:
    • valueOf

      public static Timestamp valueOf(LocalDateTime dateTime)
      Obtains an instance ofTimestamp from aLocalDateTime object, with the same year, month, day of month, hours, minutes, seconds and nanos date-time value as the providedLocalDateTime.

      The providedLocalDateTime is interpreted as the local date-time in the local time zone.

      Parameters:
      dateTime - aLocalDateTime to convert
      Returns:
      aTimestamp object
      Throws:
      NullPointerException - ifdateTime is null.
      Since:
      1.8
    • toLocalDateTime

      public LocalDateTime toLocalDateTime()
      Converts thisTimestamp object to aLocalDateTime.

      The conversion creates aLocalDateTime that represents the same year, month, day of month, hours, minutes, seconds and nanos date-time value as thisTimestamp in the local time zone.

      Returns:
      aLocalDateTime object representing the same date-time value
      Since:
      1.8
    • from

      public static Timestamp from(Instant instant)
      Obtains an instance ofTimestamp from anInstant object.

      Instant can store points on the time-line further in the future and further in the past thanDate. In this scenario, this method will throw an exception.

      Parameters:
      instant - the instant to convert
      Returns:
      anTimestamp representing the same point on the time-line as the provided instant
      Throws:
      NullPointerException - ifinstant is null.
      IllegalArgumentException - if the instant is too large to represent as aTimestamp
      Since:
      1.8
    • toInstant

      public Instant toInstant()
      Converts thisTimestamp object to anInstant.

      The conversion creates anInstant that represents the same point on the time-line as thisTimestamp.

      Overrides:
      toInstant in class Date
      Returns:
      an instant representing the same point on the time-line
      Since:
      1.8