Home Reference Source
import {ZoneRegion} from 'js-joda/src/ZoneRegion.js'
public class | source

ZoneRegion

Extends:

ZoneId → ZoneRegion

A geographical region where the same time-zone rules apply.

Time-zone information is categorized as a set of rules defining when and how the offset from UTC/Greenwich changes. These rules are accessed using identifiers based on geographical regions, such as countries or states. The most common region classification is the Time Zone Database (TZDB), which defines regions such as 'Europe/Paris' and 'Asia/Tokyo'.

The region identifier, modeled by this class, is distinct from the underlying rules, modeled by ZoneRules. The rules are defined by governments and change frequently. By contrast, the region identifier is well-defined and long-lived. This separation also allows rules to be shared between regions if appropriate.

Specification for implementors

This class is immutable and thread-safe.

Static Method Summary

Static Public Methods
public static

ofId(zoneId: string): ZoneId

not yet implemented

Method Summary

Public Methods
public

id(): string

public

Inherited Summary

From class ZoneId
public static

Obtains an instance of ZoneId from a temporal object.

public static

Gets the set of available zone IDs.

public static

of(zoneId: string): ZoneId

Obtains an instance of ZoneId from an ID ensuring that the ID is valid and available for use.

public static

ofOffset(prefix: string, offset: ZoneOffset): ZoneId

Obtains an instance of ZoneId wrapping an offset.

public static

Gets the system default time-zone.

public

equals(other: *): boolean

Checks if this time-zone ID is equal to another time-zone ID.

public

A hash code for this time-zone ID.

public

id(): String

Gets the unique time-zone ID.

public

Normalizes the time-zone ID, returning a ZoneOffset where possible.

public

Gets the time-zone rules for this ID allowing calculations to be performed.

public

toJSON() use by JSON.stringify delegates to toString()

public

Outputs this zone as a string, using the ID.

Static Public Methods

public static ofId(zoneId: string): ZoneId source

not yet implemented

Params:

NameTypeAttributeDescription
zoneId string

Return:

ZoneId

Public Methods

public id(): string source

Gets the unique time-zone ID.

This ID uniquely defines this object. The format of an offset based ID is defined by ZoneOffset#getId.

Override:

ZoneId#id

Return:

string

public rules(): ZoneRules source

Gets the time-zone rules for this ID allowing calculations to be performed.

The rules provide the functionality associated with a time-zone, such as finding the offset for a given instant or local date-time.

A time-zone can be invalid if it is deserialized in a Java Runtime which does not have the same rules loaded as the Java Runtime that stored it. In this case, calling this method will throw a ZoneRulesException.

The rules are supplied by ZoneRulesProvider. An advanced provider may support dynamic updates to the rules without restarting the Java Runtime. If so, then the result of this method may change over time. Each individual call will be still remain thread-safe.

ZoneOffset will always return a set of rules where the offset never changes.

Override:

ZoneId#rules

Return:

ZoneRules