Companion

object Companion

Functions

fromMillisecondOfUnixEpoch
Link copied to clipboard
common
fun fromMillisecondOfUnixEpoch(millisecond: Long, offset: UtcOffset): OffsetDateTime

Creates an OffsetDateTime from the millisecond of the Unix epoch at offset.

fromMillisecondsSinceUnixEpoch
Link copied to clipboard
common
fun fromMillisecondsSinceUnixEpoch(milliseconds: Milliseconds, offset: UtcOffset): OffsetDateTime

Creates an OffsetDateTime from a duration of milliseconds relative to the Unix epoch at offset.

fromSecondOfUnixEpoch
Link copied to clipboard
common
fun fromSecondOfUnixEpoch(second: Long, nanosecond: Int = 0, offset: UtcOffset): OffsetDateTime

Creates an OffsetDateTime from the second of the Unix epoch at offset and optionally, the nanosecond of the second.

fromSecondsSinceUnixEpoch
Link copied to clipboard
common
fun fromSecondsSinceUnixEpoch(seconds: Seconds, nanosecondAdjustment: Nanoseconds = 0.nanoseconds, offset: UtcOffset): OffsetDateTime

Creates an OffsetDateTime from a duration of seconds relative to the Unix epoch at offset, optionally, with some number of additional nanoseconds added to it.

Properties

DefaultSortOrder
Link copied to clipboard
common
val DefaultSortOrder: Comparator<OffsetDateTime>

A Comparator that compares by instant, then date-time. Using this Comparator guarantees a deterministic order when sorting.

MAX
Link copied to clipboard
common
val MAX: OffsetDateTime

The latest supported OffsetDateTime, which can be used as a "far future" sentinel.

MIN
Link copied to clipboard
common
val MIN: OffsetDateTime

The earliest supported OffsetDateTime, which can be used as a "far past" sentinel.

TimelineOrder
Link copied to clipboard
common
val TimelineOrder: Comparator<TimePoint<*>>

A Comparator that compares by timeline order only, ignoring any offset differences.

Extensions

now
Link copied to clipboard
fun OffsetDateTime.Companion.now(clock: Clock): OffsetDateTime

Gets the current OffsetDateTime from the provided clock.

common
fun OffsetDateTime.Companion.now(): OffsetDateTime

Gets the current OffsetDateTime from the system clock.

common
fun OffsetDateTime.Companion.now(clock: Clock): OffsetDateTime

Gets the current OffsetDateTime from the provided clock.