Added in API level 1

Timestamp

public class Timestamp
extends Date

java.lang.Object
   ↳ java.util.Date
     ↳ java.sql.Timestamp


A thin wrapper around java.util.Date that allows the JDBC API to identify this as an SQL TIMESTAMP value. It adds the ability to hold the SQL TIMESTAMP 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...] and s represents the scale of the given Timestamp, its fractional seconds precision.

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

Due to the differences between the Timestamp class and the java.util.Date class mentioned above, it is recommended that code not view Timestamp values generically as an instance of java.util.Date. The inheritance relationship between Timestamp and java.util.Date really denotes implementation inheritance, and not type inheritance.

Summary

Public constructors

Timestamp(int year, int month, int date, int hour, int minute, int second, int nano)

This constructor is deprecated. instead use the constructor Timestamp(long millis)

Timestamp(long time)

Constructs a Timestamp object using a milliseconds time value.

Public methods

boolean after(Timestamp ts)

Indicates whether this Timestamp object is later than the given Timestamp object.

boolean before(Timestamp ts)

Indicates whether this Timestamp object is earlier than the given Timestamp object.

int compareTo(Date o)

Compares this Timestamp object to the given Date object.

int compareTo(Timestamp ts)

Compares this Timestamp object to the given Timestamp object.

boolean equals(Timestamp ts)

Tests to see if this Timestamp object is equal to the given Timestamp object.

boolean equals(Object ts)

Tests to see if this Timestamp object is equal to the given object.

int getNanos()

Gets this Timestamp object's nanos value.

long getTime()

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this Timestamp object.

int hashCode()

Returns a hash code value for this object. The hashCode method uses the underlying java.util.Date implementation and therefore does not include nanos in its computation.

void setNanos(int n)

Sets this Timestamp object's nanos field to the given value.

void setTime(long time)

Sets this Timestamp object to represent a point in time that is time milliseconds after January 1, 1970 00:00:00 GMT.

String toString()

Formats a timestamp in JDBC timestamp escape format.

static Timestamp valueOf(String s)

Converts a String object in JDBC timestamp escape format to a Timestamp value.

Inherited methods

static long UTC(int year, int month, int date, int hrs, int min, int sec)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(year + 1900, month, date, hrs, min, sec) or GregorianCalendar(year + 1900, month, date, hrs, min, sec), using a UTC TimeZone, followed by Calendar.getTime().getTime().

boolean after(Date when)

Tests if this date is after the specified date.

boolean before(Date when)

Tests if this date is before the specified date.

Object clone()

Return a copy of this object.

int compareTo(Date anotherDate)

Compares two Dates for ordering.

boolean equals(Object obj)

Compares two dates for equality.

static Date from(Instant instant)

Obtains an instance of Date from an Instant object.

int getDate()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.DAY_OF_MONTH).

int getDay()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.DAY_OF_WEEK).

int getHours()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.HOUR_OF_DAY).

int getMinutes()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.MINUTE).

int getMonth()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.MONTH).

int getSeconds()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.SECOND).

long getTime()

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this Date object.

int getTimezoneOffset()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by -(Calendar.get(Calendar.ZONE_OFFSET) + Calendar.get(Calendar.DST_OFFSET)) / (60 * 1000).

int getYear()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.get(Calendar.YEAR) - 1900.

int hashCode()

Returns a hash code value for this object.

static long parse(String s)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by DateFormat.parse(String s).

void setDate(int date)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.DAY_OF_MONTH, int date).

void setHours(int hours)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.HOUR_OF_DAY, int hours).

void setMinutes(int minutes)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.MINUTE, int minutes).

void setMonth(int month)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.MONTH, int month).

void setSeconds(int seconds)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.SECOND, int seconds).

void setTime(long time)

Sets this Date object to represent a point in time that is time milliseconds after January 1, 1970 00:00:00 GMT.

void setYear(int year)

This method was deprecated in API level 15. As of JDK version 1.1, replaced by Calendar.set(Calendar.YEAR, year + 1900).

String toGMTString()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by DateFormat.format(Date date), using a GMT TimeZone.

Instant toInstant()

Converts this Date object to an Instant.

String toLocaleString()

This method was deprecated in API level 15. As of JDK version 1.1, replaced by DateFormat.format(Date date).

String toString()

Converts this Date object to a String of the form:

 dow mon dd hh:mm:ss zzz yyyy
where:
  • dow is the day of the week (Sun, Mon, Tue, Wed, Thu, Fri, Sat).

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int compareTo(Date o)

Compares this object with the specified object for order.

Public constructors

Timestamp

Added in API level 1
public Timestamp (int year, 
                int month, 
                int date, 
                int hour, 
                int minute, 
                int second, 
                int nano)

This constructor is deprecated.
instead use the constructor Timestamp(long millis)

Constructs a Timestamp object initialized with the given values.

Parameters
year int: the year minus 1900

month int: 0 to 11

date int: 1 to 31

hour int: 0 to 23

minute int: 0 to 59

second int: 0 to 59

nano int: 0 to 999,999,999

Throws
IllegalArgumentException if the nano argument is out of bounds

Timestamp

Added in API level 1
public Timestamp (long time)

Constructs a Timestamp object using a milliseconds time value. The integral seconds are stored in the underlying date value; the fractional seconds are stored in the nanos field of the Timestamp object.

Parameters
time long: 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:

Public methods

after

Added in API level 1
public boolean after (Timestamp ts)

Indicates whether this Timestamp object is later than the given Timestamp object.

Parameters
ts Timestamp: the Timestamp value to compare with

Returns
boolean true if this Timestamp object is later; false otherwise

before

Added in API level 1
public boolean before (Timestamp ts)

Indicates whether this Timestamp object is earlier than the given Timestamp object.

Parameters
ts Timestamp: the Timestamp value to compare with

Returns
boolean true if this Timestamp object is earlier; false otherwise

compareTo

Added in API level 1
public int compareTo (Date o)

Compares this Timestamp object to the given Date object.

Parameters
o Date: the Date to be compared to this Timestamp object

Returns
int the value 0 if this Timestamp object and the given object are equal; a value less than 0 if this Timestamp object is before the given argument; and a value greater than 0 if this Timestamp object is after the given argument.

compareTo

Added in API level 1
public int compareTo (Timestamp ts)

Compares this Timestamp object to the given Timestamp object.

Parameters
ts Timestamp: the Timestamp object to be compared to this Timestamp object

Returns
int the value 0 if the two Timestamp objects are equal; a value less than 0 if this Timestamp object is before the given argument; and a value greater than 0 if this Timestamp object is after the given argument.

equals

Added in API level 1
public boolean equals (Timestamp ts)

Tests to see if this Timestamp object is equal to the given Timestamp object.

Parameters
ts Timestamp: the Timestamp value to compare with

Returns
boolean true if the given Timestamp object is equal to this Timestamp object; false otherwise

equals

Added in API level 1
public boolean equals (Object ts)

Tests to see if this Timestamp object is equal to the given object. This version of the method equals has been added to fix the incorrect signature of Timestamp.equals(Timestamp) and to preserve backward compatibility with existing class files. Note: This method is not symmetric with respect to the equals(Object) method in the base class.

Parameters
ts Object: the Object value to compare with

Returns
boolean true if the given Object is an instance of a Timestamp that is equal to this Timestamp object; false otherwise

getNanos

Added in API level 1
public int getNanos ()

Gets this Timestamp object's nanos value.

Returns
int this Timestamp object's fractional seconds component

See also:

getTime

Added in API level 1
public long getTime ()

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this Timestamp object.

Returns
long the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date.

See also:

hashCode

Added in API level 1
public int hashCode ()

Returns a hash code value for this object. The result is the exclusive OR of the two halves of the primitive long value returned by the Date.getTime method. That is, the hash code is the value of the expression:

(int)(this.getTime()^(this.getTime() >>> 32))
 
The hashCode method uses the underlying java.util.Date implementation and therefore does not include nanos in its computation.

Returns
int a hash code value for this object.

setNanos

Added in API level 1
public void setNanos (int n)

Sets this Timestamp object's nanos field to the given value.

Parameters
n int: the new fractional seconds component

Throws
IllegalArgumentException if the given argument is greater than 999999999 or less than 0

See also:

setTime

Added in API level 1
public void setTime (long time)

Sets this Timestamp object to represent a point in time that is time milliseconds after January 1, 1970 00:00:00 GMT.

Parameters
time long: the number of milliseconds.

toString

Added in API level 1
public String toString ()

Formats a timestamp in JDBC timestamp escape format. yyyy-mm-dd hh:mm:ss.fffffffff, where ffffffffff indicates nanoseconds.

Returns
String a String object in yyyy-mm-dd hh:mm:ss.fffffffff format

valueOf

Added in API level 1
public static Timestamp valueOf (String s)

Converts a String object in JDBC timestamp escape format to a Timestamp value.

Parameters
s String: timestamp in format yyyy-[m]m-[d]d hh:mm:ss[.f...]. The fractional seconds may be omitted. The leading zero for mm and dd may also be omitted.

Returns
Timestamp corresponding Timestamp value

Throws
IllegalArgumentException if the given argument does not have the format yyyy-[m]m-[d]d hh:mm:ss[.f...]