TimeZone represents a time zone offset, and also figures out 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
* 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. 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 a custom time zone ID can be specified to
* produce a TimeZone. The syntax of a custom time zone ID is:
*
* CustomID:
* GMT Sign Hours : Minutes
* GMT Sign Hours Minutes
* GMT Sign Hours
* Sign: one of
* + -
* Hours:
* Digit
* Digit Digit
* Minutes:
* Digit Digit
* Digit: one of
* 0 1 2 3 4 5 6 7 8 9
*
* The format is locale independent and digits must be taken from the
* Basic Latin block of the Unicode standard. No daylight saving time
* transition schedule can be specified with a custom time zone ID. If
* the specified string doesn't match the syntax, "GMT"
* is used.
*
* When creating a TimeZone, the specified custom time
* zone ID is normalized in the following syntax:
*
* NormalizedCustomID:
* GMT Sign TwoDigitHours : Minutes
* Sign: one of
* + -
* TwoDigitHours:
* Digit Digit
* Minutes:
* Digit Digit
* Digit: one of
* 0 1 2 3 4 5 6 7 8 9
* getDisplayName() indicating
* a short name, such as "PST."
* @see #LONG
* @since 1.2
*/
// @ts-ignore
public static readonly SHORT: number /*int*/
/**
* A style specifier for getDisplayName() indicating
* a long name, such as "Pacific Standard Time."
* @see #SHORT
* @since 1.2
*/
// @ts-ignore
public static readonly LONG: number /*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.
*
* This method returns a historically correct offset if an
* underlying TimeZone implementation subclass
* supports historical Daylight Saving Time schedule and GMT
* offset changes.
* @param era the era of the given date.
* @param year the year in the given date.
* @param month the month in the given date.
* Month is 0-based. e.g., 0 for January.
* @param day the day-in-month of the given date.
* @param dayOfWeek the day-of-week of the given date.
* @param milliseconds the milliseconds in day in standard
* local time.
* @return the offset in milliseconds to add to GMT to get local time.
* @see Calendar#ZONE_OFFSET
* @see Calendar#DST_OFFSET
*/
// @ts-ignore
public abstract getOffset(era: number /*int*/, year: number /*int*/, month: number /*int*/, day: number /*int*/, dayOfWeek: number /*int*/, milliseconds: number /*int*/): number /*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.
*
* This method returns a historically correct offset value if an * underlying TimeZone implementation subclass supports historical * Daylight Saving Time schedule and GMT offset changes. * @param date the date represented in milliseconds since January 1, 1970 00:00:00 GMT * @return the amount of time in milliseconds to add to UTC to get local time. * @see Calendar#ZONE_OFFSET * @see Calendar#DST_OFFSET * @since 1.4 */ // @ts-ignore public getOffset(date: number /*long*/): number /*int*/ /** * Sets the base time zone offset to GMT. * This is the offset to add to UTC to get local time. *
* If an underlying TimeZone implementation subclass
* supports historical GMT offset changes, the specified GMT
* offset is set as the latest GMT offset and the difference from
* the known latest GMT offset value is used to adjust all
* historical GMT offset values.
* @param offsetMillis the given base time zone offset to GMT.
*/
// @ts-ignore
public abstract setRawOffset(offsetMillis: number /*int*/): void
/**
* Returns the amount of time in milliseconds to add to UTC to get
* standard time in this time zone. Because this value is not
* affected by daylight saving time, it is called raw
* offset.
*
* If an underlying TimeZone implementation subclass
* supports historical GMT offset changes, the method returns the
* raw offset value of the current date. In Honolulu, for example,
* its raw offset changed from GMT-10:30 to GMT-10:00 in 1947, and
* this method always returns -36000000 milliseconds (i.e., -10
* hours).
* @return the amount of raw offset time in milliseconds to add to UTC.
* @see Calendar#ZONE_OFFSET
*/
// @ts-ignore
public abstract getRawOffset(): number /*int*/
/**
* Gets the ID of this time zone.
* @return the ID of this time zone.
*/
// @ts-ignore
public getID(): string
/**
* Sets the time zone ID. This does not change any other data in
* the time zone object.
* @param ID the new time zone ID.
*/
// @ts-ignore
public setID(ID: java.lang.String | string): void
/**
* Returns a long standard time name of this {@code TimeZone} suitable for
* presentation to the user in the default locale.
*
This method is equivalent to: *
* getDisplayName(false, {@link #LONG},
* Locale.getDefault({@link Locale.Category#DISPLAY}))
* This method is equivalent to: *
* getDisplayName(false, {@link #LONG}, locale)
* This method is equivalent to: *
* getDisplayName(daylight, style,
* Locale.getDefault({@link Locale.Category#DISPLAY}))
* When looking up a time zone name, the {@linkplain
* ResourceBundle.Control#getCandidateLocales(String,Locale) default
* Locale search path of ResourceBundle} derived
* from the specified {@code locale} is used. (No {@linkplain
* ResourceBundle.Control#getFallbackLocale(String,Locale) fallback
* Locale} search is performed.) If a time zone name in any
* {@code Locale} of the search path, including {@link Locale#ROOT}, is
* found, the name is returned. Otherwise, a string in the
* normalized custom ID format is returned.
* @param daylight {#code true} specifying a Daylight Saving Time name, or
* {@code false} specifying a Standard Time name
* @param style either {#link #LONG} or {@link #SHORT}
* @param locale the locale in which to supply the display name.
* @return the human-readable name of this time zone in the given locale.
* @exception IllegalArgumentException if {#code style} is invalid.
* @exception NullPointerException if {#code locale} is {@code null}.
* @since 1.2
* @see java.text.DateFormatSymbols#getZoneStrings()
*/
// @ts-ignore
public getDisplayName(daylight: boolean, style: number /*int*/, locale: java.util.Locale): string
/**
* Returns the amount of time to be added to local standard time
* to get local wall clock time.
*
The default implementation returns 3600000 milliseconds * (i.e., one hour) if a call to {@link #useDaylightTime()} * returns {@code true}. Otherwise, 0 (zero) is returned. *
If an underlying {@code TimeZone} implementation subclass * supports historical and future Daylight Saving Time schedule * changes, this method returns the amount of saving time of the * last known Daylight Saving Time rule that can be a future * prediction. *
If the amount of saving time at any given time stamp is * required, construct a {@link Calendar} with this {@code * TimeZone} and the time stamp, and call {@link Calendar#get(int) * Calendar.get}{@code (}{@link Calendar#DST_OFFSET}{@code )}. * @return the amount of saving time in milliseconds * @since 1.4 * @see #inDaylightTime(Date) * @see #getOffset(long) * @see #getOffset(int,int,int,int,int,int) * @see Calendar#ZONE_OFFSET */ // @ts-ignore public getDSTSavings(): number /*int*/ /** * Queries if this {@code TimeZone} uses Daylight Saving Time. *
If an underlying {@code TimeZone} implementation subclass * supports historical and future Daylight Saving Time schedule * changes, this method refers to the last known Daylight Saving Time * rule that can be a future prediction and may not be the same as * the current rule. Consider calling {@link #observesDaylightTime()} * if the current rule should also be taken into account. * @return {#code true} if this {@code TimeZone} uses Daylight Saving Time, * {@code false}, otherwise. * @see #inDaylightTime(Date) * @see Calendar#DST_OFFSET */ // @ts-ignore public abstract useDaylightTime(): boolean /** * Returns {@code true} if this {@code TimeZone} is currently in * Daylight Saving Time, or if a transition from Standard Time to * Daylight Saving Time occurs at any future time. *
The default implementation returns {@code true} if
* {@code useDaylightTime()} or {@code inDaylightTime(new Date())}
* returns {@code true}.
* @return {#code true} if this {@code TimeZone} is currently in
* Daylight Saving Time, or if a transition from Standard Time to
* Daylight Saving Time occurs at any future time; {@code false}
* otherwise.
* @since 1.7
* @see #useDaylightTime()
* @see #inDaylightTime(Date)
* @see Calendar#DST_OFFSET
*/
// @ts-ignore
public observesDaylightTime(): boolean
/**
* Queries if the given {@code date} is in Daylight Saving Time in
* this time zone.
* @param date the given Date.
* @return {#code true} if the given date is in Daylight Saving Time,
* {@code false}, otherwise.
*/
// @ts-ignore
public abstract inDaylightTime(date: java.util.Date): boolean
/**
* Gets the TimeZone for the given ID.
* @param ID the ID for a TimeZone, either an abbreviation
* such as "PST", a full name such as "America/Los_Angeles", or a custom
* ID such as "GMT-8:00". Note that the support of abbreviations is
* for JDK 1.1.x compatibility only and full names should be used.
* @return the specified TimeZone, or the GMT zone if the given ID
* cannot be understood.
*/
// @ts-ignore
public static getTimeZone(ID: java.lang.String | string): java.util.TimeZone
/**
* Gets the {@code TimeZone} for the given {@code zoneId}.
* @param zoneId a {#link ZoneId} from which the time zone ID is obtained
* @return the specified {#code TimeZone}, or the GMT zone if the given ID
* cannot be understood.
* @throws NullPointerException if {#code zoneId} is {@code null}
* @since 1.8
*/
// @ts-ignore
public static getTimeZone(zoneId: java.time.ZoneId): java.util.TimeZone
/**
* Converts this {@code TimeZone} object to a {@code ZoneId}.
* @return a {#code ZoneId} representing the same time zone as this
* {@code TimeZone}
* @since 1.8
*/
// @ts-ignore
public toZoneId(): java.time.ZoneId
/**
* Gets the available IDs according to the given time zone offset in milliseconds.
* @param rawOffset the given time zone GMT offset in milliseconds.
* @return an array of IDs, where the time zone for that ID has
* the specified GMT offset. For example, "America/Phoenix" and "America/Denver"
* both have GMT-07:00, but differ in daylight saving behavior.
* @see #getRawOffset()
*/
// @ts-ignore
public static getAvailableIDs(rawOffset: number /*int*/): string[]
/**
* Gets all the available IDs supported.
* @return an array of IDs.
*/
// @ts-ignore
public static getAvailableIDs(): string[]
/**
* Gets the default {@code TimeZone} of the Java virtual machine. If the
* cached default {@code TimeZone} is available, its clone is returned.
* Otherwise, the method takes the following steps to determine the default
* time zone.
*
The default {@code TimeZone} created from the ID is cached,
* and its clone is returned. The {@code user.timezone} property
* value is set to the ID upon return.
* @return the default {#code TimeZone}
* @see #setDefault(TimeZone)
*/
// @ts-ignore
public static getDefault(): java.util.TimeZone
/**
* Sets the {@code TimeZone} that is returned by the {@code getDefault}
* method. {@code zone} is cached. If {@code zone} is null, the cached
* default {@code TimeZone} is cleared. This method doesn't change the value
* of the {@code user.timezone} property.
* @param zone the new default {#code TimeZone}, or null
* @throws SecurityException if the security manager's {#code checkPermission}
* denies {@code PropertyPermission("user.timezone",
* "write")}
* @see #getDefault
* @see PropertyPermission
*/
// @ts-ignore
public static setDefault(zone: java.util.TimeZone): void
/**
* 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.
* @param other the TimeZone object to be compared with
* @return true if the other zone is not null and is the same as this one,
* with the possible exception of the ID
* @since 1.2
*/
// @ts-ignore
public hasSameRules(other: java.util.TimeZone): boolean
/**
* Creates a copy of this TimeZone.
* @return a clone of this TimeZone
*/
// @ts-ignore
public clone(): any
}
}
}