type

TimeZone

src @Serializable { simple=true } const class TimeZone : Obj

TimeZone represents a region's offset from UTC and its daylight savings time rules. TimeZones are historical - UTC offset and DST rules may change depending on the year. The Fantom implementation of historical time zones is optimized to handle only year boundaries (so some historical changes which don't occur on year boundaries may not be 100% accurate).

The Fantom time zone database and naming model is based on the ZoneInfo database used by UNIX and Java. All time zones have both a simple name and a fullName. The fullName is the full identifier used in the zoneinfo database such as "America/New_York". The simple name is the city name only such as "New_York".

Use cur to get current default timezone for VM.

Also see docLang.

constructors

fromStr	Find a time zone by name from the built-in database

methods

cur	Get the current default TimeZone of the VM.
defVal	Default value is UTC.
dstAbbr	Get the abbreviated name during daylight savings time or null if daylight savings time not observed.
dstOffset	Get the duration of time which will be added to local standard time to get wall time during daylight savings time (often 1hr).
fullName	Get the full name of this time zone as defined by the zoneinfo database.
listFullNames	List all zoneinfo (Olson database) full names of the time zones available in the local time zone database.
listNames	List the names of all the time zones available in the local time zone database.
name	Get the identifier of this time zone in the time zone database.
offset	Get the duration of time added to UTC to compute standard time in this time zone.
rel	Relative time zone instance is "Etc/Rel".
stdAbbr	Get the abbreviated name during standard time.
toStr	Return `name`.
utc	UTC time zone instance is "Etc/Utc".

Slot Details

cur

src static TimeZone cur()

Get the current default TimeZone of the VM. The default timezone is configured by the Java or .NET runtime or it can be manually configured in "etc/sys/config.props" with the key "timezone" and any value accepted by fromStr. Once Fantom is booted, the default timezone cannot be changed.

defVal

src static TimeZone defVal()

Default value is UTC.

dstAbbr

src Str? dstAbbr(Int year)

Get the abbreviated name during daylight savings time or null if daylight savings time not observed.

dstOffset

src Duration? dstOffset(Int year)

Get the duration of time which will be added to local standard time to get wall time during daylight savings time (often 1hr). If daylight savings time is not observed then return null.

fromStr

src static new fromStr(Str name, Bool checked := true)

Find a time zone by name from the built-in database:

First check for simple name like "New_York" or the zoneinfo full name "America/New_York"
Attempt to match against timezone aliases, if a match is found return the canonical TimeZone instance
If no matches are found and checked is false then return null, otherwise throw ParseErr.

Also see:

fullName

src Str fullName()

Get the full name of this time zone as defined by the zoneinfo database. These names are formatted as "continent/location" where location is a major city within the time zone region. Examples of full names are "America/New_York" and "Europe/London".

listFullNames

src static Str[] listFullNames()

List all zoneinfo (Olson database) full names of the time zones available in the local time zone database. This list is the full names only such as "America/New_York" and "Europe/London".

listNames

src static Str[] listNames()

List the names of all the time zones available in the local time zone database. This database is stored in "{home}/lib/timezone.ftz" as a binary file. This list contains only the simple names such as "New_York" and "London".

name

src Str name()

Get the identifier of this time zone in the time zone database. Name is the city name portion of the zoneinfo fullName identifier such as "New_York" or "London".

offset

src Duration offset(Int year)

Get the duration of time added to UTC to compute standard time in this time zone. The offset is independent of daylight savings time - during daylight savings the actual offset is this value plus dstOffset.

rel

src static TimeZone rel()

Relative time zone instance is "Etc/Rel". The relative timezone has a zero offset like UTC, but is used to normalize by time of day versus absolute time. See DateTime.toRel and docLang.

stdAbbr

src Str stdAbbr(Int year)

Get the abbreviated name during standard time.

toStr

src virtual override Str toStr()

Return name.

utc

src static TimeZone utc()

UTC time zone instance is "Etc/Utc".