java.lang.Object | |
↳ | java.util.TimeZone |
Known Direct Subclasses |
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:
You can use theTimeZone 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:
Hours must be between 0 to 23 and Minutes must be between 00 to 59. For example, "GMT+10" and "GMT+0010" mean ten hours and ten minutes ahead of GMT, respectively.CustomID:GMT
Sign Hours:
MinutesGMT
Sign Hours MinutesGMT
Sign Hours Sign: one of+ -
Hours: Digit Digit Digit Minutes: Digit Digit Digit: one of0 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:
For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".NormalizedCustomID:GMT
Sign TwoDigitHours:
Minutes Sign: one of+ -
TwoDigitHours: Digit Digit Minutes: Digit Digit Digit: one of0 1 2 3 4 5 6 7 8 9
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | LONG | A style specifier for getDisplayName() indicating
a long name, such as "Pacific Standard Time." |
|||||||||
int | SHORT | A style specifier for getDisplayName() indicating
a short name, such as "PST." |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Sole constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a copy of this
TimeZone . | |||||||||||
Gets all the available IDs supported.
| |||||||||||
Gets the available IDs according to the given time zone offset in milliseconds.
| |||||||||||
Returns the amount of time to be added to local standard time
to get local wall clock time.
| |||||||||||
Gets the default
TimeZone for this host. | |||||||||||
Returns a name of this time zone suitable for presentation to the user
in the specified locale.
| |||||||||||
Returns a name of this time zone suitable for presentation to the user
in the specified locale.
| |||||||||||
Returns a name of this time zone suitable for presentation to the user
in the default locale.
| |||||||||||
Returns a name of this time zone suitable for presentation to the user
in the default locale.
| |||||||||||
Gets the ID of this time zone.
| |||||||||||
Gets the time zone offset, for current date, modified in case of
daylight savings.
| |||||||||||
Returns the offset of this time zone from UTC at the specified
date.
| |||||||||||
Returns the amount of time in milliseconds to add to UTC to get
standard time in this time zone.
| |||||||||||
Gets the
TimeZone for the given ID. | |||||||||||
Returns true if this zone has the same rule and offset as another zone.
| |||||||||||
Queries if the given date is in daylight savings time in
this time zone.
| |||||||||||
Sets the
TimeZone that is
returned by the getDefault method. | |||||||||||
Sets the time zone ID.
| |||||||||||
Sets the base time zone offset to GMT.
| |||||||||||
Queries if this time zone uses daylight savings time.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
A style specifier for getDisplayName()
indicating
a long name, such as "Pacific Standard Time."
A style specifier for getDisplayName()
indicating
a short name, such as "PST."
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Gets all the available IDs supported.
Gets the available IDs according to the given time zone offset in milliseconds.
rawOffset | the given time zone GMT offset in milliseconds. |
---|
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.
Gets the default TimeZone
for this host.
The source of the default TimeZone
may vary with implementation.
TimeZone
.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, then this method returns a string in the normalized custom ID format.
locale | the locale in which to supply the display name. |
---|
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 normalized custom ID format.
daylight | if true, return the daylight savings name. |
---|---|
style | either LONG or SHORT |
locale | the locale in which to supply the display name. |
IllegalArgumentException | style is invalid. |
---|
Returns a name of this time zone suitable for presentation to the user in the default locale. This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Returns a name of this time zone suitable for presentation to the user in the default locale. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
daylight | if true, return the daylight savings name. |
---|---|
style | either LONG or SHORT |
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.
era | the era of the given date. |
---|---|
year | the year in the given date. |
month | the month in the given date. Month is 0-based. e.g., 0 for January. |
day | the day-in-month of the given date. |
dayOfWeek | the day-of-week of the given date. |
milliseconds | the milliseconds in day in standard local time. |
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.
date | the date represented in milliseconds since January 1, 1970 00:00:00 GMT |
---|
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).
Gets the TimeZone
for the given ID.
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. |
---|
TimeZone
, or the GMT zone if the given ID
cannot be understood.
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.
other | the TimeZone object to be compared with |
---|
Queries if the given date is in daylight savings time in this time zone.
date | the given Date. |
---|
Sets the TimeZone
that is
returned by the getDefault
method. If zone
is null, reset the default to the value it had originally when the
VM first started.
zone | the new default time zone |
---|
Sets the time zone ID. This does not change any other data in the time zone object.
ID | the new time zone ID. |
---|
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.
offsetMillis | the given base time zone offset to GMT. |
---|
Queries if this time zone uses daylight savings time.
If an underlying TimeZone
implementation subclass
supports historical Daylight Saving Time schedule changes, the
method refers to the latest Daylight Saving Time schedule
information.