Timestamp (Java 2 Platform SE 5.0) (original) (raw)

java.sql

Class Timestamp

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Date>

public class Timestamp

extends Date

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 nanos value and provides formatting and parsing operations to support the JDBC escape syntax for timestamp values.

Note: This type is a composite of a java.util.Date and a separate nanoseconds value. Only integral seconds are stored in thejava.util.Date component. The fractional seconds - the nanos - are separate. The Timestamp.equals(Object) method never returns true when passed a value of type java.util.Date because the nanos component of a date is unknown. As a result, the Timestamp.equals(Object) method is not symmetric with respect to thejava.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 viewTimestamp values generically as an instance ofjava.util.Date. The inheritance relationship between Timestamp and java.util.Date really denotes implementation inheritance, and not type inheritance.

See Also:

Serialized Form

Timestamp

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

Deprecated. instead use the constructor Timestamp(long millis)

Constructs a Timestamp 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](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the nano argument is out of bounds

Timestamp

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

for more information

setTime

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.

Overrides:

[setTime](../../java/util/Date.html#setTime%28long%29) in class [Date](../../java/util/Date.html "class in java.util")

Parameters:

time - the number of milliseconds.

See Also:

getTime(), Timestamp(long time), for more information

getTime

public long getTime()

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

Overrides:

[getTime](../../java/util/Date.html#getTime%28%29) in class [Date](../../java/util/Date.html "class in java.util")

Returns:

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

See Also:

setTime(long)

valueOf

public static Timestamp valueOf(String s)

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

Parameters:

s - timestamp in format yyyy-mm-dd hh:mm:ss.fffffffff

Returns:

corresponding Timestamp value

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the given argument does not have the format yyyy-mm-dd hh:mm:ss.fffffffff

toString

public String toString()

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

NOTE: To specify a timestamp for the class java.text.SimpleDateFormat, use "yyyy.MM.dd" rather than "yyyy-mm-dd". In the context of java.text.SimpleDateFormat, "mm" indicates minutes rather than the month. Note that java.text.SimpleDateFormat does not allow for the nanoseconds component of a Timestamp object. For Example:

Format Pattern Result

"yyyy.MM.dd G 'at' hh:mm:ss z" --> 2002.07.10 AD at 15:08:56 PDT

Overrides:

[toString](../../java/util/Date.html#toString%28%29) in class [Date](../../java/util/Date.html "class in java.util")

Returns:

a String object inyyyy-mm-dd hh:mm:ss.fffffffff format

See Also:

Date.toLocaleString(), Date.toGMTString()

getNanos

public int getNanos()

Gets this Timestamp object's nanos value.

Returns:

this Timestamp object's fractional seconds component

See Also:

setNanos(int)

setNanos

public void setNanos(int n)

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

Parameters:

n - the new fractional seconds component

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the given argument is greater than 999999999 or less than 0

See Also:

getNanos()

equals

public boolean equals(Timestamp ts)

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

Parameters:

ts - the Timestamp value to compare with

Returns:

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

equals

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.

Overrides:

[equals](../../java/util/Date.html#equals%28java.lang.Object%29) in class [Date](../../java/util/Date.html "class in java.util")

Parameters:

ts - the Object value to compare with

Returns:

true if the given Object instance is equal to this Timestamp object;false otherwise

See Also:

Date.getTime()

before

public boolean before(Timestamp ts)

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

Parameters:

ts - the Timestamp value to compare with

Returns:

true if this Timestamp object is earlier;false otherwise

after

public boolean after(Timestamp ts)

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

Parameters:

ts - the Timestamp value to compare with

Returns:

true if this Timestamp object is later;false otherwise

compareTo

public int compareTo(Timestamp ts)

Compares this Timestamp object to the given Timestamp object.

Parameters:

ts - the Timestamp object to be compared to this Timestamp object

Returns:

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.

Since:

1.2

compareTo

public int compareTo(Date o)

Compares this Timestamp object to the given Date, which must be a Timestamp object. If the argument is not a Timestamp object, this method throws a ClassCastException object. (Timestamp objects are comparable only to other Timestamp objects.)

Specified by:

[compareTo](../../java/lang/Comparable.html#compareTo%28T%29) in interface [Comparable](../../java/lang/Comparable.html "interface in java.lang")<[Date](../../java/util/Date.html "class in java.util")>

Overrides:

[compareTo](../../java/util/Date.html#compareTo%28java.util.Date%29) in class [Date](../../java/util/Date.html "class in java.util")

Parameters:

o - the Date to be compared, which must be aTimestamp object

Returns:

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.

Throws:

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if the argument is not aTimestamp object

Since:

1.5

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.