Package io.islandtime

Date-time primitives and core concepts, including classes such as Date, Time, Instant, and ZonedDateTime.

Types

Date

common

class Date(year: Int, month: Month, day: Int) : Comparable<Date>

A date in an ambiguous region.

DateTime

common

class DateTime(date: Date, time: Time) : Comparable<DateTime>

A date and time of day in an ambiguous region.

DateTimeException

common

open class DateTimeException(message: String?, cause: Throwable?) : Exception

DayOfWeek

common

enum DayOfWeek : Enum<DayOfWeek>

A day of the week.

Instant

common

class Instant : TimePoint<Instant> , Comparable<Instant>

An instant in time with nanosecond-precision.

IslandTime

common

object IslandTime

Global configuration for Island Time.

Month

common

enum Month : Enum<Month>

A month of the year.

OffsetConversionStrategy

common

enum OffsetConversionStrategy : Enum<OffsetConversionStrategy>

Strategy to use when converting a local date-time accompanied by a UtcOffset to a date and time that are valid according to the rules of a TimeZone.

OffsetDateTime

common

class OffsetDateTime(dateTime: DateTime, offset: UtcOffset) : TimePoint<OffsetDateTime>

A date and time of day with an offset from UTC.

OffsetTime

common

class OffsetTime(time: Time, offset: UtcOffset)

A time of day with an offset from UTC.

PlatformInstant

common

class PlatformInstant

A platform-specific representation of an instant in time.

typealias PlatformInstant = <ERROR CLASS>

typealias PlatformInstant = Instant

Time

common

class Time(hour: Int, minute: Int, second: Int, nanosecond: Int) : Comparable<Time>

A time of day in an ambiguous region.

TimeZone

common

sealed class TimeZone : Comparable<TimeZone>

A time zone.

UtcOffset

common

inline class UtcOffset(totalSeconds: IntSeconds) : Comparable<UtcOffset>

The time shift between a local time and UTC.

Year

common

inline class Year(value: Int) : Comparable<Year>

A year as defined by ISO-8601.

YearMonth

common

class YearMonth(year: Int, month: Month) : Comparable<YearMonth>

A month in a particular year.

ZonedDateTime

common

class ZonedDateTime : TimePoint<ZonedDateTime>

A date and time of day in a particular region.

Functions

asTimeZone

common

fun UtcOffset.asTimeZone(): TimeZone

Converts this UtcOffset into a fixed-offset TimeZone.

asUtcOffset

common

fun IntHours.asUtcOffset(): UtcOffset

Converts a duration of hours into a UtcOffset of the same length.

fun IntMinutes.asUtcOffset(): UtcOffset

Converts a duration of minutes into a UtcOffset of the same length.

fun IntSeconds.asUtcOffset(): UtcOffset

Converts a duration of seconds into a UtcOffset of the same length.

asZonedDateTime

common

fun OffsetDateTime.asZonedDateTime(): ZonedDateTime

Converts this OffsetDateTime to an equivalent ZonedDateTime using a fixed-offset time zone.

common

infix fun Date.at(offsetTime: OffsetTime): OffsetDateTime

Combines a local date with a time and UTC offset to create an OffsetDateTime.

infix fun Date.at(time: Time): DateTime

Combines a Date with a Time to create a DateTime.

infix fun DateTime.at(zone: TimeZone): ZonedDateTime

Combines a local date and time with a time zone to create a ZonedDateTime.

infix fun DateTime.at(offset: UtcOffset): OffsetDateTime

Combines a local date and time with a UTC offset to create an OffsetDateTime.

infix fun Instant.at(zone: TimeZone): ZonedDateTime

Combines an instant with a time zone to create a ZonedDateTime.

infix fun Instant.at(offset: UtcOffset): OffsetDateTime

Combines an instant with a UTC offset to create an OffsetDateTime.

infix fun Time.at(offset: UtcOffset): OffsetTime

Combines a local time with a UTC offset to create an OffsetTime.

infix fun Year.at(month: Month): YearMonth

Combines a year and month to create a YearMonth.

atDay

common

fun YearMonth.atDay(day: Int): Date

Combines a YearMonth with a day of the month to create a Date.

atMonth

common

fun Year.atMonth(number: Int): YearMonth

Combines a year and month number to create a YearMonth.

atTime

common

fun Date.atTime(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0): DateTime

Combines a Date with a time to create a DateTime.

Date

common

fun Date(year: Int, dayOfYear: Int): Date

Creates a Date from a year and day of year

endOfDayAt

common

fun Date.endOfDayAt(zone: TimeZone): ZonedDateTime

The ZonedDateTime at the last representable instant of the day in zone, taking into account any daylight savings transitions.

endOfWeek

common

fun Date.endOfWeek(settings: WeekSettings): Date

The date at the end of the week that this date falls in.

fun Date.endOfWeek(locale: Locale): Date

The date at the end of the week that this date falls in.

fun DateTime.endOfWeek(settings: WeekSettings): DateTime