Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

java.sql
Class Timestamp

java.lang.Object
  |
  +--java.util.Date
        |
        +--java.sql.Timestamp

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

public class Timestamp

extends java.util.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 the java.util.Date component. The fractional seconds - the nanos - are separate. The getTime method will return only integral seconds. If a time value that includes the fractional seconds is desired, you must convert nanos to milliseconds (nanos/1000000) and add this to the getTime value. 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 the java.util.Date.equals(Object) method. Also, the hashcode method uses the underlying java.util.Data 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.

See Also:

Serialized Form

Constructor Summary

Timestamp(long time)
Constructs a Timestamp object using a milliseconds time value.

Method Summary

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(java.lang.Object o) Compares this Timestamp to another Object.
int	compareTo(Timestamp ts) Compares two Timestamps for ordering.
boolean	equals(java.lang.Object ts) Tests to see if this Timestamp object is equal to the given object.
boolean	equals(Timestamp ts) Tests to see if this Timestamp object is equal to the given Timestamp 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.
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.
java.lang.String	toString() Formats a timestamp in JDBC timestamp escape format.
static Timestamp	valueOf(java.lang.String s) Converts a String object in JDBC timestamp escape format to a Timestamp value.

Methods inherited from class java.util.Date

after, before, clone, compareTo, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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

Method Detail

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 in class java.util.Date

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 in class java.util.Date

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(java.lang.String s)

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

Parameters:

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

Returns:

corresponding Timestamp value

Throws:

java.lang.IllegalArgumentException - if the given argument does not have the format yyyy-mm-dd hh:mm:ss.fffffffff

toString

public java.lang.String toString()

Formats a timestamp in JDBC timestamp escape format. NOTE: To specify a timestamp format for the class SimpleDateFormat, use "yyyy.MM.dd" rather than "yyyy-mm-dd". In the context of SimpleDateFormat, "mm" indicates minutes rather than the month. Note that SimpleDateFormat does not allw for the nanoseconds components 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 in class java.util.Date

Returns:

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

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:

java.lang.IllegalArgumentException - 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(java.lang.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 in class java.util.Date

Parameters:

ts - the Object value to compare with

Returns:

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

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 two Timestamps for ordering.

Parameters:

ts - the Timestamp to be compared.

Returns:

the value 0 if the argument Timestamp is equal to this Timestamp; a value less than 0 if this Timestamp is before the Date argument; and a value greater than 0 if this Timestamp is after the Timestamp argument.

Since:

1.2

compareTo

public int compareTo(java.lang.Object o)

Compares this Timestamp to another Object. If the Object is a Timestamp, this function behaves like compareTo(Timestamp). Otherwise, it throws aClassCastException (as Timestamps are comparable only to other Timestamps)

Overrides:

compareTo in class java.util.Date

Parameters:

o - the object to be compared

Returns:

the value 0 if the argument is a Timestamp equal to this Timestamp; a value less than 0 if the argument is a Timestamp after this Timestamp; and a value greater than 0 if the argument is a Timestamp before this Timestamp.

Throws:

ClassCastException - if the argument is not a Timestamp.