Timestamp (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.Timestamp

All Implemented Interfaces:

Serializable, Comparable<Timestamp>
```
@Public
public final class Timestamp
extends Object
implements Comparable<Timestamp>, Serializable
```
An internal data structure representing data of TimestampType.
This data structure is immutable and consists of a milliseconds and nanos-of-millisecond since 1970-01-01 00:00:00. It might be stored in a compact representation (as a long value) if values are small enough.
Legacy: This class represents LocalZonedTimestampType too, now it is recommended to use LocalZoneTimestamp.

Since:

0.4.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long MICROS_PER_MILLIS

static long MILLIS_PER_DAY

static long NANOS_PER_MICROS

Fields
Modifier and Type	Field and Description
`static long`	`MICROS_PER_MILLIS`
`static long`	`MILLIS_PER_DAY`
`static long`	`NANOS_PER_MICROS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Timestamp that)`
`boolean`	`equals(Object obj)`
`static Timestamp`	`fromEpochMillis(long milliseconds)` Creates an instance of `Timestamp` from milliseconds.
`static Timestamp`	`fromEpochMillis(long milliseconds, int nanosOfMillisecond)` Creates an instance of `Timestamp` from milliseconds and a nanos-of-millisecond.
`static Timestamp`	`fromInstant(java.time.Instant instant)` Deprecated. use `LocalZoneTimestamp`.
`static Timestamp`	`fromLocalDateTime(java.time.LocalDateTime dateTime)` Creates an instance of `Timestamp` from an instance of `LocalDateTime`.
`static Timestamp`	`fromMicros(long micros)` Creates an instance of `Timestamp` from micros.
`static Timestamp`	`fromSQLTimestamp(Timestamp timestamp)` Creates an instance of `Timestamp` from an instance of `Timestamp`.
`long`	`getMillisecond()` Returns the number of milliseconds since `1970-01-01 00:00:00`.
`int`	`getNanoOfMillisecond()` Returns the number of nanoseconds (the nanoseconds within the milliseconds).
`int`	`hashCode()`
`static boolean`	`isCompact(int precision)` Returns whether the timestamp data is small enough to be stored in a long of milliseconds.
`static Timestamp`	`now()` Creates an instance of `Timestamp` for now.
`java.time.Instant`	`toInstant()` Deprecated. use `LocalZoneTimestamp`.
`java.time.LocalDateTime`	`toLocalDateTime()` Converts this `Timestamp` object to a `LocalDateTime`.
`long`	`toMicros()` Converts this `Timestamp` object to micros.
`Timestamp`	`toMillisTimestamp()`
`Timestamp`	`toSQLTimestamp()` Converts this `Timestamp` object to a `Timestamp`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MILLIS_PER_DAY
```
public static final long MILLIS_PER_DAY
```
    See Also:
    
    Constant Field Values
  - MICROS_PER_MILLIS
```
public static final long MICROS_PER_MILLIS
```
    See Also:
    
    Constant Field Values
  - NANOS_PER_MICROS
```
public static final long NANOS_PER_MICROS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getMillisecond
```
public long getMillisecond()
```
    Returns the number of milliseconds since 1970-01-01 00:00:00.
  - getNanoOfMillisecond
```
public int getNanoOfMillisecond()
```
    Returns the number of nanoseconds (the nanoseconds within the milliseconds).
    The value range is from 0 to 999,999.
  - toSQLTimestamp
```
public Timestamp toSQLTimestamp()
```
    Converts this Timestamp object to a Timestamp.
  - toMillisTimestamp
```
public Timestamp toMillisTimestamp()
```
  - toLocalDateTime
```
public java.time.LocalDateTime toLocalDateTime()
```
    Converts this Timestamp object to a LocalDateTime.
  - toInstant
```
@Deprecated
public java.time.Instant toInstant()
```
    Deprecated. use LocalZoneTimestamp.
    
    Converts this Timestamp object to a Instant.
  - toMicros
```
public long toMicros()
```
    Converts this Timestamp object to micros.
  - compareTo
```
public int compareTo(Timestamp that)
```
    Specified by:
    
    compareTo in interface Comparable<Timestamp>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - now
```
public static Timestamp now()
```
    Creates an instance of Timestamp for now.
  - fromEpochMillis
```
public static Timestamp fromEpochMillis(long milliseconds)
```
    Creates an instance of Timestamp from milliseconds.
    The nanos-of-millisecond field will be set to zero.
    
    Parameters:
    
    milliseconds - the number of milliseconds since 1970-01-01 00:00:00; a negative number is the number of milliseconds before 1970-01-01 00:00:00
  - fromEpochMillis
```
public static Timestamp fromEpochMillis(long milliseconds,
                                        int nanosOfMillisecond)
```
    Creates an instance of Timestamp from milliseconds and a nanos-of-millisecond.
    
    Parameters:
    
    milliseconds - the number of milliseconds since 1970-01-01 00:00:00; a negative number is the number of milliseconds before 1970-01-01 00:00:00
    
    nanosOfMillisecond - the nanoseconds within the millisecond, from 0 to 999,999
  - fromLocalDateTime
```
public static Timestamp fromLocalDateTime(java.time.LocalDateTime dateTime)
```
    Creates an instance of Timestamp from an instance of LocalDateTime.
    
    Parameters:
    
    dateTime - an instance of LocalDateTime
  - fromSQLTimestamp
```
public static Timestamp fromSQLTimestamp(Timestamp timestamp)
```
    Creates an instance of Timestamp from an instance of Timestamp.
    
    Parameters:
    
    timestamp - an instance of Timestamp
  - fromInstant
```
@Deprecated
public static Timestamp fromInstant(java.time.Instant instant)
```
    Deprecated. use LocalZoneTimestamp.
    
    Creates an instance of Timestamp from an instance of Instant.
    
    Parameters:
    
    instant - an instance of Instant
  - fromMicros
```
public static Timestamp fromMicros(long micros)
```
    Creates an instance of Timestamp from micros.
  - isCompact
```
public static boolean isCompact(int precision)
```
    Returns whether the timestamp data is small enough to be stored in a long of milliseconds.

Back to Paimon Website

Class Timestamp

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLIS_PER_DAY

MICROS_PER_MILLIS

NANOS_PER_MICROS

Method Detail

getMillisecond

getNanoOfMillisecond

toSQLTimestamp

toMillisTimestamp

toLocalDateTime

toInstant

toMicros

compareTo

equals

toString

hashCode

now

fromEpochMillis

fromEpochMillis

fromLocalDateTime

fromSQLTimestamp

fromInstant

fromMicros

isCompact

Back to Paimon Website