Timestamp
open class Timestamp : Date
kotlin.Any | ||
↳ | 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...] ands
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 | |
---|---|
Constructs a |
|
Constructs a |
Public methods | |
---|---|
open Boolean |
Indicates whether this |
open Boolean |
Indicates whether this |
open Int |
Compares this |
open Int |
Compares this |
open Boolean |
Tests to see if this |
open Boolean |
Tests to see if this |
open Int |
getNanos() Gets this |
open Long |
getTime() Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this |
open Int |
hashCode() Returns a hash code value for this object. |
open Unit |
Sets this |
open Unit |
Sets this |
open String |
toString() Formats a timestamp in JDBC timestamp escape format. |
open static Timestamp! |
Converts a |
Inherited functions | |
---|---|
Public constructors
Timestamp
Timestamp(
year: Int,
month: Int,
date: Int,
hour: Int,
minute: Int,
second: Int,
nano: Int)
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 |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the nano argument is out of bounds |
Timestamp
Timestamp(time: Long)
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
open fun after(ts: Timestamp!): Boolean
Indicates whether this Timestamp
object is later than the given Timestamp
object.
Parameters | |
---|---|
ts |
Timestamp!: the Timestamp value to compare with |
Return | |
---|---|
Boolean |
true if this Timestamp object is later; false otherwise |
before
open fun before(ts: Timestamp!): Boolean
Indicates whether this Timestamp
object is earlier than the given Timestamp
object.
Parameters | |
---|---|
ts |
Timestamp!: the Timestamp value to compare with |
Return | |
---|---|
Boolean |
true if this Timestamp object is earlier; false otherwise |
compareTo
open fun compareTo(ts: Timestamp!): Int
Compares this Timestamp
object to the given Timestamp
object.
Parameters | |
---|---|
ts |
Timestamp!: the Timestamp object to be compared to this Timestamp object |
Return | |
---|---|
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. |
compareTo
open fun compareTo(other: Date!): Int
Compares this Timestamp
object to the given Date
object.
Parameters | |
---|---|
o |
the Date to be compared to this Timestamp object |
anotherDate |
the Date to be compared. |
Return | |
---|---|
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. |
Exceptions | |
---|---|
java.lang.NullPointerException |
if anotherDate is null. |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
equals
open fun equals(ts: Timestamp!): Boolean
Tests to see if this Timestamp
object is equal to the given Timestamp
object.
Parameters | |
---|---|
ts |
Timestamp!: the Timestamp value to compare with |
Return | |
---|---|
Boolean |
true if the given Timestamp object is equal to this Timestamp object; false otherwise |
equals
open fun equals(other: Any?): Boolean
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 | |
---|---|
obj |
the object to compare with. |
ts |
the Object value to compare with |
Return | |
---|---|
Boolean |
true if the given Object is an instance of a Timestamp that is equal to this Timestamp object; false otherwise |
getNanos
open fun getNanos(): Int
Gets this Timestamp
object's nanos
value.
Return | |
---|---|
Int |
this Timestamp object's fractional seconds component |
See Also
getTime
open fun getTime(): Long
Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this Timestamp
object.
Return | |
---|---|
Long |
the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date. |
See Also
hashCode
open fun hashCode(): Int
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:
<code>(int)(this.getTime()^(this.getTime() >>> 32)) </code>
hashCode
method uses the underlying java.util.Date
implementation and therefore does not include nanos in its computation.
Return | |
---|---|
Int |
a hash code value for this object. |
setNanos
open fun setNanos(n: Int): Unit
Sets this Timestamp
object's nanos
field to the given value.
Parameters | |
---|---|
n |
Int: the new fractional seconds component |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the given argument is greater than 999999999 or less than 0 |
See Also
setTime
open fun setTime(time: Long): Unit
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
open fun toString(): String
Formats a timestamp in JDBC timestamp escape format. yyyy-mm-dd hh:mm:ss.fffffffff
, where ffffffffff
indicates nanoseconds.
Return | |
---|---|
String |
a String object in yyyy-mm-dd hh:mm:ss.fffffffff format |
valueOf
open static fun valueOf(s: String!): Timestamp!
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. |
Return | |
---|---|
Timestamp! |
corresponding Timestamp value |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the given argument does not have the format yyyy-[m]m-[d]d hh:mm:ss[.f...] |