TimeZone
abstract class TimeZone : Cloneable, Freezable<TimeZone!>, Serializable
| kotlin.Any | |
| ↳ | android.icu.util.TimeZone |
[icu enhancement] ICU's replacement for java.util.TimeZone. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.
TimeZone represents a time zone offset, and also computes daylight savings.
Typically, you get a TimeZone using getDefault() which creates a TimeZone based on the time zone where the program is running. For example, for a program running in Japan, getDefault creates a TimeZone object based on Japanese Standard Time.
You can also get a TimeZone using getTimeZone(java.lang.String) along with a time zone ID. For instance, the time zone ID for the U.S. Pacific Time zone is "America/Los_Angeles". So, you can get a U.S. Pacific Time TimeZone object with:
TimeZone tz = TimeZone.getTimeZone("America/Los_Angeles");
getAvailableIDs() method to iterate through all the supported time zone IDs, or getCanonicalID method to check if a time zone ID is supported or not. You can then choose a supported ID to get a TimeZone. If the time zone you want is not represented by one of the supported IDs, then you can create a custom time zone ID with the following syntax:
GMT[+|-]hh[[:]mm]
TimeZone that is returned when you specify a custom time zone ID uses the specified offset from GMT(=UTC) and does not observe daylight saving time. For example, you might specify GMT+14:00 as a custom time zone ID to create a TimeZone representing 14 hours ahead of GMT (with no daylight saving time). In addition, getCanonicalID can also be used to normalize a custom time zone ID.
For compatibility with JDK 1.1.x, some other three-letter time zone IDs (such as "PST", "CTT", "AST") are also supported. However, their use is deprecated because the same abbreviation is often used for multiple time zones (for example, "CST" could be U.S. "Central Standard Time" and "China Standard Time"), and the Java platform can then only recognize one of them.
Summary
| Nested classes | |
|---|---|
|
[icu] System time zone type constants used by filtering zones in |
|
| Constants | |
|---|---|
| static Int |
[icu] A style specifier for |
| static Int |
A style specifier for |
| static Int |
[icu] A style specifier for |
| static Int |
[icu] A style specifier for |
| static Int |
A style specifier for |
| static Int |
[icu] A style specifier for |
| static Int |
[icu] A style specifier for |
| static Int |
[icu] A style specifier for |
| static Int |
[icu] A time zone implementation type indicating ICU's own TimeZone used by |
| static Int |
[icu] A time zone implementation type indicating the |
| static String |
[icu] The time zone ID reserved for unknown time zone. |
| Public constructors | |
|---|---|
TimeZone()Default constructor. |
|
| Public methods | |
|---|---|
| open Any |
clone()Overrides clone. |
| open TimeZone! |
Provides for the clone operation. |
| open static Int |
countEquivalentIDs(id: String!)[icu] Returns the number of IDs in the equivalency group that includes the given ID. |
| open Boolean |
Overrides equals. |
| open TimeZone! |
freeze()Freezes the object. |
| open static Array<String!>! |
Return a new String array containing all system TimeZone IDs. |
| open static MutableSet<String!>! |
getAvailableIDs(zoneType: TimeZone.SystemTimeZoneType!, region: String!, rawOffset: Int!)[icu] Returns a set of time zone ID strings with the given filter conditions. |
| open static Array<String!>! |
getAvailableIDs(rawOffset: Int)Return a new String array containing all system TimeZone IDs with the given raw offset from GMT. |
| open static Array<String!>! |
getAvailableIDs(country: String!)Return a new String array containing all system TimeZone IDs associated with the given country. |
| open static String! |
getCanonicalID(id: String!)[icu] Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zone ID. |
| open static String! |
getCanonicalID(id: String!, isSystemID: BooleanArray!)[icu] Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zone ID. |
| open Int |
Returns the amount of time to be added to local standard time to get local wall clock time. |
| open static TimeZone! |
Gets the default |
| String! |
Returns a name of this time zone suitable for presentation to the user in the default |
| String! |
getDisplayName(locale: ULocale!)Returns a name of this time zone suitable for presentation to the user in the specified locale. |
| String! |
getDisplayName(daylight: Boolean, style: Int)Returns a name of this time zone suitable for presentation to the user in the default |
| open String! |
getDisplayName(daylight: Boolean, style: Int, locale: ULocale!)Returns a name of this time zone suitable for presentation to the user in the specified locale. |
| open String! |
getDisplayName(daylight: Boolean, style: Int, locale: Locale!)Returns a name of this time zone suitable for presentation to the user in the specified locale. |
| String! |
getDisplayName(locale: Locale!)Returns a name of this time zone suitable for presentation to the user in the specified locale. |
| open static String! |
getEquivalentID(id: String!, index: Int)Returns an ID in the equivalency group that includes the given ID. |
| open static TimeZone! |
getFrozenTimeZone(ID: String!)Gets the |
| open String! |
getID()Gets the ID of this time zone. |
| open static String! |
getIDForWindowsID(winid: String!, region: String!)[icu] Converts a Windows time zone ID to an equivalent system time zone ID for a region. |
| open static String! |
Returns the preferred time zone ID in the IANA database for the given time zone ID. |
| abstract Int |
Gets the time zone offset, for current date, modified in case of daylight savings. |
| open Int |
Returns the offset of this time zone from UTC at the specified date. |
| open Unit |
Returns the time zone raw and GMT offset for the given moment in time. |
| abstract Int |
Gets unmodified offset, NOT modified in case of daylight savings. |
| open static String! |
[icu] Returns the region code associated with the given system time zone ID. |
| open static String! |
[icu] Returns the time zone data version currently used by ICU. |
| open static TimeZone! |
getTimeZone(ID: String!)Gets the |
| open static TimeZone! |
getTimeZone(ID: String!, type: Int)Gets the |
| open static String! |
getWindowsID(id: String!)[icu] Converts a system time zone ID to an equivalent Windows time zone ID. |
| open Boolean |
hasSameRules(other: TimeZone!)Returns true if this zone has the same rule and offset as another zone. |
| open Int |
hashCode()Overrides hashCode. |
| abstract Boolean |
inDaylightTime(date: Date!)Queries if the given date is in daylight savings time in this time zone. |
| open Boolean |
isFrozen()Determines whether the object has been frozen or not. |
| open Boolean |
Queries if this time zone is in daylight saving time or will observe daylight saving time at any future time. |
| open Unit |
Sets the time zone ID. |
| abstract Unit |
setRawOffset(offsetMillis: Int)Sets the base time zone offset to GMT. |
| abstract Boolean |
Queries if this time zone uses daylight savings time. |
| Properties | |
|---|---|
| static TimeZone! |
[icu] The immutable GMT (=UTC) time zone. |
| static TimeZone! |
[icu] The immutable (frozen) "unknown" time zone. |
Constants
GENERIC_LOCATION
static val GENERIC_LOCATION: Int
[icu] A style specifier for getDisplayName() indicating a long name derived from the timezone's fallback name, such as "United States (Los Angeles)."
Value: 7LONG
static val LONG: Int
A style specifier for getDisplayName() indicating a long name, such as "Pacific Standard Time."
Value: 1See Also
LONG_GENERIC
static val LONG_GENERIC: Int
[icu] A style specifier for getDisplayName() indicating a long generic name, such as "Pacific Time."
Value: 3See Also
LONG_GMT
static val LONG_GMT: Int
[icu] A style specifier for getDisplayName() indicating a long name derived from the timezone's offset, such as "GMT-08:00."
Value: 5See Also
SHORT
static val SHORT: Int
A style specifier for getDisplayName() indicating a short name, such as "PST."
Value: 0See Also
SHORT_COMMONLY_USED
static val SHORT_COMMONLY_USED: Int
[icu] A style specifier for getDisplayName() indicating a short name derived from the timezone's short standard or daylight timezone name ignoring commonlyUsed, such as "PDT."
Value: 6SHORT_GENERIC
static val SHORT_GENERIC: Int
[icu] A style specifier for getDisplayName() indicating a short generic name, such as "PT."
Value: 2See Also
SHORT_GMT
static val SHORT_GMT: Int
[icu] A style specifier for getDisplayName() indicating a short name derived from the timezone's offset, such as "-0800."
Value: 4See Also
TIMEZONE_ICU
static val TIMEZONE_ICU: Int
[icu] A time zone implementation type indicating ICU's own TimeZone used by getTimeZone.
Value: 0TIMEZONE_JDK
static val TIMEZONE_JDK: Int
[icu] A time zone implementation type indicating the java.util.TimeZone used by getTimeZone.
Value: 1UNKNOWN_ZONE_ID
static val UNKNOWN_ZONE_ID: String
[icu] The time zone ID reserved for unknown time zone.
Value: "Etc/Unknown"See Also
Public constructors
TimeZone
TimeZone()
Default constructor. (For invocation by subclass constructors, typically implicit.)
Public methods
clone
open fun clone(): Any
Overrides clone.
| Return | |
|---|---|
Any |
a clone of this instance. |
| Exceptions | |
|---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
cloneAsThawed
open fun cloneAsThawed(): TimeZone!
Provides for the clone operation. Any clone is initially unfrozen.
countEquivalentIDs
open static fun countEquivalentIDs(id: String!): Int
[icu] Returns the number of IDs in the equivalency group that includes the given ID. An equivalency group contains zones that have the same GMT offset and rules.
The returned count includes the given ID; it is always >= 1 for valid IDs. The given ID must be a system time zone. If it is not, returns zero.
| Parameters | |
|---|---|
id |
String!: a system time zone ID |
| Return | |
|---|---|
Int |
the number of zones in the equivalency group containing 'id', or zero if 'id' is not a valid system ID |
See Also
equals
open fun equals(other: Any?): Boolean
Overrides equals.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
freeze
open fun freeze(): TimeZone!
Freezes the object.
| Return | |
|---|---|
TimeZone! |
the object itself. |
getAvailableIDs
open static fun getAvailableIDs(): Array<String!>!
Return a new String array containing all system TimeZone IDs. These IDs (and only these IDs) may be passed to get() to construct the corresponding TimeZone object.
| Return | |
|---|---|
Array<String!>! |
an array of all system TimeZone IDs |
getAvailableIDs
open static fun getAvailableIDs(
zoneType: TimeZone.SystemTimeZoneType!,
region: String!,
rawOffset: Int!
): MutableSet<String!>!
[icu] Returns a set of time zone ID strings with the given filter conditions.
Note:A Set returned by this method is immutable.
| Parameters | |
|---|---|
zoneType |
TimeZone.SystemTimeZoneType!: The system time zone type. |
region |
String!: The ISO 3166 two-letter country code or UN M.49 three-digit area code. When null, no filtering done by region. |
rawOffset |
Int!: An offset from GMT in milliseconds, ignoring the effect of daylight savings time, if any. When null, no filtering done by zone offset. |
| Return | |
|---|---|
MutableSet<String!>! |
an immutable set of system time zone IDs. |
getAvailableIDs
open static fun getAvailableIDs(rawOffset: Int): Array<String!>!
Return a new String array containing all system TimeZone IDs with the given raw offset from GMT. These IDs may be passed to get() to construct the corresponding TimeZone object.
| Parameters | |
|---|---|
rawOffset |
Int: the offset in milliseconds from GMT |
| Return | |
|---|---|
Array<String!>! |
an array of IDs for system TimeZones with the given raw offset. If there are none, return a zero-length array. |
getAvailableIDs
open static fun getAvailableIDs(country: String!): Array<String!>!
Return a new String array containing all system TimeZone IDs associated with the given country. These IDs may be passed to get() to construct the corresponding TimeZone object.
| Parameters | |
|---|---|
country |
String!: a two-letter ISO 3166 country code, or null to return zones not associated with any country |
| Return | |
|---|---|
Array<String!>! |
an array of IDs for system TimeZones in the given country. If there are none, return a zero-length array. |
getCanonicalID
open static fun getCanonicalID(id: String!): String!
[icu] Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zone ID.
| Parameters | |
|---|---|
id |
String!: The input time zone ID to be canonicalized. |
| Return | |
|---|---|
String! |
The canonical system time zone ID or the custom time zone ID in normalized format for the given time zone ID. When the given time zone ID is neither a known system time zone ID nor a valid custom time zone ID, null is returned. |
getCanonicalID
open static fun getCanonicalID(
id: String!,
isSystemID: BooleanArray!
): String!
[icu] Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zone ID.
| Parameters | |
|---|---|
id |
String!: The input time zone ID to be canonicalized. |
isSystemID |
BooleanArray!: When non-null boolean array is specified and the given ID is a known system time zone ID, true is set to isSystemID[0] |
| Return | |
|---|---|
String! |
The canonical system time zone ID or the custom time zone ID in normalized format for the given time zone ID. When the given time zone ID is neither a known system time zone ID nor a valid custom time zone ID, null is returned. |
getDSTSavings
open fun getDSTSavings(): Int
Returns the amount of time to be added to local standard time to get local wall clock time.
The default implementation always returns 3600000 milliseconds (i.e., one hour) if this time zone observes Daylight Saving Time. Otherwise, 0 (zero) is returned.
If an underlying TimeZone implementation subclass supports historical Daylight Saving Time changes, this method returns the known latest daylight saving value.
| Return | |
|---|---|
Int |
the amount of saving time in milliseconds |
getDefault
open static fun getDefault(): TimeZone!
Gets the default TimeZone for this host. The source of the default TimeZone may vary with implementation.
| Return | |
|---|---|
TimeZone! |
a default TimeZone. |
getDisplayName
fun getDisplayName(): String!
Returns a name of this time zone suitable for presentation to the user in the default DISPLAY locale. This method returns the long generic name. If the display name is not available for the locale, a fallback based on the country, city, or time zone id will be used.
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the default locale. |
getDisplayName
fun getDisplayName(locale: ULocale!): String!
Returns a name of this time zone suitable for presentation to the user in the specified locale. This method returns the long name, not including daylight savings. If the display name is not available for the locale, a fallback based on the country, city, or time zone id will be used.
| Parameters | |
|---|---|
locale |
ULocale!: the ulocale in which to supply the display name. |
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the given locale or in the default ulocale if the given ulocale is not recognized. |
getDisplayName
fun getDisplayName(
daylight: Boolean,
style: Int
): String!
Returns a name of this time zone suitable for presentation to the user in the default DISPLAY locale. If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such as GMT[+-]HH:mm.
| Parameters | |
|---|---|
daylight |
Boolean: if true, return the daylight savings name. |
style |
Int: the output style of the display name. Valid styles are SHORT, LONG, SHORT_GENERIC, LONG_GENERIC, SHORT_GMT, LONG_GMT, SHORT_COMMONLY_USED or GENERIC_LOCATION. |
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the default locale. |
getDisplayName
open fun getDisplayName(
daylight: Boolean,
style: Int,
locale: ULocale!
): String!
Returns a name of this time zone suitable for presentation to the user in the specified locale. If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such as GMT[+-]HH:mm.
| Parameters | |
|---|---|
daylight |
Boolean: if true, return the daylight savings name. |
style |
Int: the output style of the display name. Valid styles are SHORT, LONG, SHORT_GENERIC, LONG_GENERIC, SHORT_GMT, LONG_GMT, SHORT_COMMONLY_USED or GENERIC_LOCATION. |
locale |
ULocale!: the locale in which to supply the display name. |
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
style is invalid. |
getDisplayName
open fun getDisplayName(
daylight: Boolean,
style: Int,
locale: Locale!
): String!
Returns a name of this time zone suitable for presentation to the user in the specified locale. If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such as GMT[+-]HH:mm.
| Parameters | |
|---|---|
daylight |
Boolean: if true, return the daylight savings name. |
style |
Int: the output style of the display name. Valid styles are SHORT, LONG, SHORT_GENERIC, LONG_GENERIC, SHORT_GMT, LONG_GMT, SHORT_COMMONLY_USED or GENERIC_LOCATION. |
locale |
Locale!: the locale in which to supply the display name. |
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
style is invalid. |
getDisplayName
fun getDisplayName(locale: Locale!): String!
Returns a name of this time zone suitable for presentation to the user in the specified locale. This method returns the long generic name. If the display name is not available for the locale, a fallback based on the country, city, or time zone id will be used.
| Parameters | |
|---|---|
locale |
Locale!: the locale in which to supply the display name. |
| Return | |
|---|---|
String! |
the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized. |
getEquivalentID
open static fun getEquivalentID(
id: String!,
index: Int
): String!
Returns an ID in the equivalency group that includes the given ID. An equivalency group contains zones that have the same GMT offset and rules.
The given index must be in the range 0..n-1, where n is the value returned by countEquivalentIDs(id). For some value of 'index', the returned value will be equal to the given id. If the given id is not a valid system time zone, or if 'index' is out of range, then returns an empty string.
| Parameters | |
|---|---|
id |
String!: a system time zone ID |
index |
Int: a value from 0 to n-1, where n is the value returned by countEquivalentIDs(id) |
| Return | |
|---|---|
String! |
the ID of the index-th zone in the equivalency group containing 'id', or an empty string if 'id' is not a valid system ID or 'index' is out of range |
See Also
getFrozenTimeZone
open static fun getFrozenTimeZone(ID: String!): TimeZone!
Gets the TimeZone for the given ID. The instance of TimeZone returned by this method is immutable. Any methods mutate the instance(setID(java.lang.String), setRawOffset(int)) will throw UnsupportedOperationException upon its invocation.
| Parameters | |
|---|---|
ID |
String!: the ID for a TimeZone, such as "America/Los_Angeles", or a custom ID such as "GMT-8:00". Note that the support of abbreviations, such as "PST", is for JDK 1.1.x compatibility only and full names should be used. |
| Return | |
|---|---|
TimeZone! |
the specified TimeZone, or the UNKNOWN_ZONE if the given ID cannot be understood. |
See Also
getID
open fun getID(): String!
Gets the ID of this time zone.
| Return | |
|---|---|
String! |
the ID of this time zone. |
getIDForWindowsID
open static fun getIDForWindowsID(
winid: String!,
region: String!
): String!
[icu] Converts a Windows time zone ID to an equivalent system time zone ID for a region. For example, system time zone ID "America/Los_Angeles" is returned for input Windows ID "Pacific Standard Time" and region "US" (or null), "America/Vancouver" is returned for the same Windows ID "Pacific Standard Time" and region "CA".
Not all Windows time zones can be mapped to system time zones. When the input Windows time zone ID is unknown or unmappable to a system time zone, then this method returns null.
This implementation utilizes Zone-Tzid mapping data. The mapping data is updated time to time. To get the latest changes, please read the ICU user guide section Updating the Time Zone Data.
| Parameters | |
|---|---|
winid |
String!: A Windows time zone ID |
region |
String!: A region code, or null if no regional preference. |
| Return | |
|---|---|
String! |
A system time zone ID mapped from the input Windows time zone ID, or null when the input ID is unknown or unmappable. |
See Also
getIanaID
open static fun getIanaID(id: String!): String!
Returns the preferred time zone ID in the IANA database for the given time zone ID. There are two types of preferred IDs. The first type is the one defined in zone.tab file, such as "America/Los_Angeles". The second types is the one defined for zones not associated with a specific region, but not defined with "Link" syntax, such as "Etc/GMT+10".
Note: For most of system time zone IDs, this method returns an ID same as TimeZone.getCanonicalID(String). TimeZone.getCanonicalID(String) is based on canonical time zone IDs defined in Unicode CLDR. These canonical time zone IDs in CLDR were based on very old version of the time zone database. In the IANA time zone database, some IDs were updated since then. This API returns a newer time zone ID. For example, CLDR defines "Asia/Calcutta" as the canonical time zone ID. This method returns "Asia/Kolkata" instead.
"Etc/Unknown" is a special time zone ID defined by CLDR. There are no corresponding zones in the IANA time zone database. when the input is "Etc/Unknown", this method returns "Etc/Unknown", but it really means no mappings available. Caller of this method should interpret "Etc/Unknown" as an error.
| Parameters | |
|---|---|
id |
String!: The input time zone ID. |
| Return | |
|---|---|
String! |
The preferred time zone ID in the IANA time zone database, or TimeZone.UNKNOWN_ZONE_ID if the input ID is not a system ID. |
See Also
getOffset
abstract fun getOffset(
era: Int,
year: Int,
month: Int,
day: Int,
dayOfWeek: Int,
milliseconds: Int
): Int
Gets the time zone offset, for current date, modified in case of daylight savings. This is the offset to add to UTC to get local time.
| Parameters | |
|---|---|
era |
Int: the era of the given date. |
year |
Int: the year in the given date. |
month |
Int: the month in the given date. Month is 0-based. e.g., 0 for January. |
day |
Int: the day-in-month of the given date. |
dayOfWeek |
Int: the day-of-week of the given date. |
milliseconds |
Int: the millis in day in standard local time. |
| Return | |
|---|---|
Int |
the offset to add to GMT to get local time. |
getOffset
open fun getOffset(date: Long): Int
Returns the offset of this time zone from UTC at the specified date. If Daylight Saving Time is in effect at the specified date, the offset value is adjusted with the amount of daylight saving.
| Parameters | |
|---|---|
date |
Long: the date represented in milliseconds since January 1, 1970 00:00:00 GMT |
| Return | |
|---|---|
Int |
the amount of time in milliseconds to add to UTC to get local time. |
getOffset
open fun getOffset(
date: Long,
local: Boolean,
offsets: IntArray!
): Unit
Returns the time zone raw and GMT offset for the given moment in time. Upon return, local-millis = GMT-millis + rawOffset + dstOffset. All computations are performed in the proleptic Gregorian calendar. The default implementation in the TimeZone class delegates to the 8-argument getOffset().
| Parameters | |
|---|---|
date |
Long: moment in time for which to return offsets, in units of milliseconds from January 1, 1970 0:00 GMT, either GMT time or local wall time, depending on local. |
local |
Boolean: if true, date is local wall time; otherwise it is in GMT time. |
offsets |
IntArray!: output parameter to receive the raw offset, that is, the offset not including DST adjustments, in offsets[0], and the DST offset, that is, the offset to be added to rawOffset to obtain the total offset between local and GMT time, in offsets[1]. If DST is not in effect, the DST offset is zero; otherwise it is a positive value, typically one hour. |
getRawOffset
abstract fun getRawOffset(): Int
Gets unmodified offset, NOT modified in case of daylight savings. This is the offset to add to UTC to get local time.
| Return | |
|---|---|
Int |
the unmodified offset to add to UTC to get local time. |
getRegion
open static fun getRegion(id: String!): String!
[icu] Returns the region code associated with the given system time zone ID. The region code is either ISO 3166 2-letter country code or UN M.49 3-digit area code. When the time zone is not associated with a specific location, for example - "Etc/UTC", "EST5EDT", then this method returns "001" (UN M.49 area code for World).
| Parameters | |
|---|---|
id |
String!: the system time zone ID. |
| Return | |
|---|---|
String! |
the region code associated with the given system time zone ID. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if id is not a known system ID. |
See Also
getTZDataVersion
open static fun getTZDataVersion(): String!
[icu] Returns the time zone data version currently used by ICU.
| Return | |
|---|---|
String! |
the version string, such as "2007f" |
| Exceptions | |
|---|---|
java.util.MissingResourceException |
if ICU time zone resource bundle is missing or the version information is not available. |
getTimeZone
open static fun getTimeZone(ID: String!): TimeZone!
Gets the TimeZone for the given ID.
| Parameters | |
|---|---|
ID |
String!: the ID for a TimeZone, such as "America/Los_Angeles", or a custom ID such as "GMT-8:00". Note that the support of abbreviations, such as "PST", is for JDK 1.1.x compatibility only and full names should be used. |
| Return | |
|---|---|
TimeZone! |
the specified TimeZone, or a mutable clone of the UNKNOWN_ZONE if the given ID cannot be understood or if the given ID is "Etc/Unknown". |
See Also
getTimeZone
open static fun getTimeZone(
ID: String!,
type: Int
): TimeZone!
Gets the TimeZone for the given ID and the timezone type.
| Parameters | |
|---|---|
ID |
String!: the ID for a TimeZone, such as "America/Los_Angeles", or a custom ID such as "GMT-8:00". Note that the support of abbreviations, such as "PST", is for JDK 1.1.x compatibility only and full names should be used. |
type |
Int: Time zone type, either TIMEZONE_ICU or TIMEZONE_JDK. |
| Return | |
|---|---|
TimeZone! |
the specified TimeZone, or a mutable clone of the UNKNOWN_ZONE if the given ID cannot be understood or if the given ID is "Etc/Unknown". |
See Also
getWindowsID
open static fun getWindowsID(id: String!): String!
[icu] Converts a system time zone ID to an equivalent Windows time zone ID. For example, Windows time zone ID "Pacific Standard Time" is returned for input "America/Los_Angeles".
There are system time zones that cannot be mapped to Windows zones. When the input system time zone ID is unknown or unmappable to a Windows time zone, then this method returns null.
This implementation utilizes Zone-Tzid mapping data. The mapping data is updated time to time. To get the latest changes, please read the ICU user guide section Updating the Time Zone Data.
| Parameters | |
|---|---|
id |
String!: A system time zone ID |
| Return | |
|---|---|
String! |
A Windows time zone ID mapped from the input system time zone ID, or null when the input ID is unknown or unmappable. |
See Also
hasSameRules
open fun hasSameRules(other: TimeZone!): Boolean
Returns true if this zone has the same rule and offset as another zone. That is, if this zone differs only in ID, if at all. Returns false if the other zone is null.
| Parameters | |
|---|---|
other |
TimeZone!: the TimeZone object to be compared with |
| Return | |
|---|---|
Boolean |
true if the other zone is not null and is the same as this one, with the possible exception of the ID |
hashCode
open fun hashCode(): Int
Overrides hashCode.
| Return | |
|---|---|
Int |
a hash code value for this object. |
inDaylightTime
abstract fun inDaylightTime(date: Date!): Boolean
Queries if the given date is in daylight savings time in this time zone.
| Parameters | |
|---|---|
date |
Date!: the given Date. |
| Return | |
|---|---|
Boolean |
true if the given date is in daylight savings time, false, otherwise. |
isFrozen
open fun isFrozen(): Boolean
Determines whether the object has been frozen or not.
observesDaylightTime
open fun observesDaylightTime(): Boolean
Queries if this time zone is in daylight saving time or will observe daylight saving time at any future time.
The default implementation in this class returns true if useDaylightTime() or inDaylightTime(new Date()) returns true.
Note: This method was added for java.util.TimeZone compatibility support. The java.util.TimeZone#useDaylightTime() method only checks the last known rule(s), therefore it may return false even the zone observes daylight saving time currently. java.util.TimeZone added observesDaylightTime() to resolve the issue. In ICU, useDaylightTime() works differently. The ICU implementation checks if the zone uses daylight saving time in the current calendar year. Therefore, it will never return false if daylight saving time is currently used.
ICU's TimeZone subclass implementations override this method to support the same behavior with java.util.TimeZone#observesDaylightTime(). Unlike useDaylightTime(), the implementation does not take past daylight saving time into account, so that this method may return false even when useDaylightTime() returns true.
| Return | |
|---|---|
Boolean |
true if this time zone is in daylight saving time or will observe daylight saving time at any future time. |
See Also
setID
open fun setID(ID: String!): Unit
Sets the time zone ID. This does not change any other data in the time zone object.
| Parameters | |
|---|---|
ID |
String!: the new time zone ID. |
setRawOffset
abstract fun setRawOffset(offsetMillis: Int): Unit
Sets the base time zone offset to GMT. This is the offset to add to UTC to get local time.
| Parameters | |
|---|---|
offsetMillis |
Int: the given base time zone offset to GMT. |
useDaylightTime
abstract fun useDaylightTime(): Boolean
Queries if this time zone uses daylight savings time.
| Return | |
|---|---|
Boolean |
true if this time zone uses daylight savings time, false, otherwise.
Note:The default implementation of ICU TimeZone uses the tz database, which supports historic rule changes, for system time zones. With the implementation, there are time zones that used daylight savings time in the past, but no longer used currently. For example, Asia/Tokyo has never used daylight savings time since 1951. Most clients would expect that this method to return |
Properties
GMT_ZONE
static val GMT_ZONE: TimeZone!
[icu] The immutable GMT (=UTC) time zone. Its ID is "Etc/GMT".
UNKNOWN_ZONE
static val UNKNOWN_ZONE: TimeZone!
[icu] The immutable (frozen) "unknown" time zone. It behaves like the GMT/UTC time zone but has the UNKNOWN_ZONE_ID = "Etc/Unknown". TimeZone.getTimeZone(String) returns a mutable clone of this time zone if the input ID is not recognized.
See Also