TimeZoneRulesProvider

An abstraction that allows time zone rules to be supplied from any data source.

The set of supported identifiers is expected to vary depending on the source, but should typically represent regions defined in the IANA Time Zone Database.

interface TimeZoneRulesProvider

Types

Companion
Link copied to clipboard
common
object Companion : TimeZoneRulesProvider

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
hasRulesFor
Link copied to clipboard
common

Checks if regionId has rules associated with it.

abstract fun hasRulesFor(regionId: String): Boolean
rulesFor
Link copied to clipboard
common

Gets the rules associated with a particular region ID.

abstract fun rulesFor(regionId: String): TimeZoneRules
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

availableRegionIds
Link copied to clipboard
common

The available time zone region IDs as reported by the underlying provider.

In some cases, this may be only a subset of those actually supported. To check if a particular region ID can be handled, use hasRulesFor.

abstract val availableRegionIds: Set<String>
databaseVersion
Link copied to clipboard
common

The time zone database version or an empty string if unavailable.

open val databaseVersion: String

Inheritors

TimeZoneRulesProvider
Link copied to clipboard
common
PlatformTimeZoneRulesProvider
Link copied to clipboard