Region

A named time zone, typically corresponding to a region identifier in the IANA Time Zone Database, but may be any name that can be understood by a TimeZoneRulesProvider.

class Region : TimeZone

Parameters

an ID that is understood by a time zone rules provider

Functions

compareTo

common

open operator override fun compareTo(other: TimeZone): Int

displayName

common

A textual representation of this time zone, suitable for display purposes. The localized name will be returned, if available for the locale in the specified style. If not, the id will be returned instead.

The result depends on the configured TimeZoneTextProvider and may differ between platforms.

Example output for the "America/New_York" ID and "en-US" locale:

Standard: "Eastern Standard Time"
Short standard: "EST"
Daylight Saving: "Eastern Daylight Time"
Short daylight saving: "EDT"
Generic: "Eastern Time"
Short generic: "ET"

override fun displayName(style: TimeZoneTextStyle, locale: Locale): String

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

localizedName

common

The localized name of this time zone, if available for the locale in the specified style. The result depends on the configured TimeZoneTextProvider and may differ between platforms.

Example output for the "America/New_York" ID and "en-US" locale:

Standard: "Eastern Standard Time"
Short standard: "EST"
Daylight Saving: "Eastern Daylight Time"
Short daylight saving: "EDT"
Generic: "Eastern Time"
Short generic: "ET"

override fun localizedName(style: TimeZoneTextStyle, locale: Locale): String?

normalized

common

Returns a normalized time zone, converting any zone with a fixed offset to use a consistent identifier.

open override fun normalized(): TimeZone

toString

common

Returns the id of this time zone.

open override fun toString(): String

validate

common

Checks if this time zone is valid and throws an exception if it isn't.

override fun validate()

validated

common

Ensures that this time zone is valid, throwing an exception if it isn't.

override fun validated(): TimeZone

Properties

common

an ID that is understood by a time zone rules provider

open override val id: String

isValid

common

Checks if this is a valid time zone according to the current time zone rules provider.

open override val isValid: Boolean

rules

common

The rules associated with this time zone.

open override val rules: TimeZoneRules