TimeZone JDK 1.6)

Description

publicabstract abstract class TimeZone

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");

You can use the 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

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.

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

For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".

Three-letter time zone IDs

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.

See also: Calendar GregorianCalendar SimpleTimeZone

Methods

Hide/Show inherited methods

public Object clone ()

Creates a copy of this TimeZone.

Creates a copy of this TimeZone.
Returns: a clone of this TimeZone

publicstaticsynchronized String getAvailableIDs ()

Gets all the available IDs supported.

publicstaticsynchronized String getAvailableIDs (int rawOffset)

Gets the available IDs according to the given time zone offset in milliseconds.

publicstatic TimeZone getDefault ()

Gets the default TimeZone for this host.

Gets the default TimeZone for this host.
The source of the default TimeZone
may vary with implementation.
Returns: a default TimeZone.
See Also: TimeZone.setDefault(java.util.TimeZone),

pack-privatestatic TimeZone getDefaultRef ()

Returns the reference to the default TimeZone object.

publicfinal String getDisplayName ()

Returns a name of this time zone suitable for presentation to the user in the default locale.

publicfinal String getDisplayName (boolean daylight, int style)

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.
If the display name is not available for the locale, then this
method returns a string in the
normalized custom ID format.
Returns: the human-readable name of this time zone in the default locale.
Parameters:
- daylight - if true, return the daylight savings name.
- style - either LONG or SHORT
Since: 1.2

public String getDisplayName (boolean daylight, int style, Locale 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 specified locale.
If the display name is not available for the locale,
then this method returns a string in the
normalized custom ID format.
Returns: the human-readable name of this time zone in the given locale.
Parameters:
- daylight - if true, return the daylight savings name.
- style - either LONG or SHORT
- locale - the locale in which to supply the display name.
Throws:
- IllegalArgumentException - style is invalid.
Since: 1.2

publicfinal String getDisplayName (Locale locale)

Returns a name of this time zone suitable for presentation to the user in the specified locale.

public int getDSTSavings ()

Returns the amount of time to be added to local standard time to get local wall clock time.

public String getID ()

Gets the ID of this time zone.

publicabstract int getOffset (int era, int year, int month, int day, int dayOfWeek, int milliseconds)

Gets the time zone offset, for current date, modified in case of daylight savings.

public int getOffset (long date)

Returns the offset of this time zone from UTC at the specified date.

pack-private int getOffsets (long date, int[] offsets)

Gets the raw GMT offset and the amount of daylight saving of this time zone at the given time.

publicabstract int getRawOffset ()

Returns the amount of time in milliseconds to add to UTC to get standard time in this time zone.

publicstaticsynchronized TimeZone getTimeZone (String ID)

Gets the TimeZone for the given ID.

Gets the TimeZone for the given ID.
Returns: the specified TimeZone, or the GMT zone if the given ID cannot be understood.
Parameters:
- 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.

public boolean hasSameRules (TimeZone other)

Returns true if this zone has the same rule and offset as another zone.

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.
Returns: true if the other zone is not null and is the same as this one, with the possible exception of the ID
Parameters:
- other - the TimeZone object to be compared with
Since: 1.2

publicabstract boolean inDaylightTime (Date date)

Queries if the given date is in daylight savings time in this time zone.

publicstatic void setDefault (TimeZone zone)

Sets the TimeZone that is returned by the getDefault method.

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.
Parameters:
- zone - the new default time zone
See Also: TimeZone.getDefault(),

public void setID (String ID)

Sets the time zone ID.

publicabstract void setRawOffset (int offsetMillis)

Sets the base time zone offset to GMT.

publicabstract boolean useDaylightTime ()

Queries if this time zone uses daylight savings time.