IslandTime

Global configuration for Island Time.

object IslandTime

Types

Initializer
Link copied to clipboard
common

Controls the settings that Island Time is initialized with.

interface Initializer

Functions

equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
initialize
Link copied to clipboard
common

Initializes Island Time.

This method should be called prior to any of use of the library, usually during an application's initialization process. If Island Time is not explicitly initialized, the PlatformTimeZoneRulesProvider and all other default settings will be used.

fun initialize(block: IslandTime.Initializer.() -> Unit)
initializeWith
Link copied to clipboard
common

Initializes Island Time with a specific time zone rules provider, leaving all other settings in their default state.

This method should be called prior to any of use of the library, usually during an application's initialization process. If Island Time is not explicitly initialized, the PlatformTimeZoneRulesProvider and all other default settings will be used.

fun initializeWith(provider: TimeZoneRulesProvider)
reset
Link copied to clipboard
common

Resets Island Time to an uninitialized state.

This method is intended to be used to clean up custom providers in tests. It shouldn't be necessary to call this in production.

fun reset()
toString
Link copied to clipboard
common
open override fun toString(): String