com.ibm.icu.util
Class TimeZone

java.lang.Object
  |
  +--com.ibm.icu.util.TimeZone
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
SimpleTimeZone

public abstract class TimeZone
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

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 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 you can create a custom time zone ID with the following syntax:
 GMT[+|-]hh[[:]mm]
 
For example, you might specify GMT+14:00 as a custom time zone ID. The TimeZone that is returned when you specify a custom time zone ID does not include daylight savings time.

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.

Since:
JDK1.1
Version:
1.51 01/19/00
Author:
Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu
See Also:
Calendar, GregorianCalendar, SimpleTimeZone, Serialized Form

Field Summary
static int LONG
          A style specifier for getDisplayName() indicating a long name, such as "Pacific Standard Time."
static int SHORT
          A style specifier for getDisplayName() indicating a short name, such as "PST."
 
Constructor Summary
TimeZone()
          Sole constructor.
 
Method Summary
 java.lang.Object clone()
          Overrides Cloneable
static int countEquivalentIDs(java.lang.String id)
          Returns the number of IDs in the equivalency group that includes the given ID.
static java.lang.String[] getAvailableIDs()
          Return a new String array containing all system TimeZone IDs.
static java.lang.String[] getAvailableIDs(int rawOffset)
          Return a new String array containing all system TimeZone IDs with the given raw offset from GMT.
static java.lang.String[] getAvailableIDs(java.lang.String country)
          Return a new String array containing all system TimeZone IDs associated with the given country.
static TimeZone getDefault()
          Gets the default TimeZone for this host.
 java.lang.String getDisplayName()
          Returns a name of this time zone suitable for presentation to the user in the default locale.
 java.lang.String getDisplayName(boolean daylight, int style)
          Returns a name of this time zone suitable for presentation to the user in the default locale.
 java.lang.String getDisplayName(boolean daylight, int style, java.util.Locale locale)
          Returns a name of this time zone suitable for presentation to the user in the specified locale.
 java.lang.String getDisplayName(java.util.Locale locale)
          Returns a name of this time zone suitable for presentation to the user in the specified locale.
static java.lang.String getEquivalentID(java.lang.String id, int index)
          Returns an ID in the equivalency group that includes the given ID.
 java.lang.String getID()
          Gets the ID of this time zone.
abstract  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.
abstract  int getRawOffset()
          Gets unmodified offset, NOT modified in case of daylight savings.
static TimeZone getTimeZone(java.lang.String ID)
          Gets the TimeZone for the given ID.
 boolean hasSameRules(TimeZone other)
          Returns true if this zone has the same rule and offset as another zone.
abstract  boolean inDaylightTime(java.util.Date date)
          Queries if the given date is in daylight savings time in this time zone.
static void setDefault(TimeZone zone)
          Sets the TimeZone that is returned by the getDefault method.
 void setID(java.lang.String ID)
          Sets the time zone ID.
abstract  void setRawOffset(int offsetMillis)
          Sets the base time zone offset to GMT.
abstract  boolean useDaylightTime()
          Queries if this time zone uses daylight savings time.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SHORT

public static final int SHORT
A style specifier for getDisplayName() indicating a short name, such as "PST."
See Also:
LONG
Since:
1.2

LONG

public static final int LONG
A style specifier for getDisplayName() indicating a long name, such as "Pacific Standard Time."
See Also:
SHORT
Since:
1.2
Constructor Detail

TimeZone

public TimeZone()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Method Detail

getOffset

public abstract 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. This is the offset to add *to* UTC to get local time.
Parameters:
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 millis in day in standard local time.
Returns:
the offset to add *to* GMT to get local time.

setRawOffset

public abstract void setRawOffset(int offsetMillis)
Sets the base time zone offset to GMT. This is the offset to add *to* UTC to get local time.
Parameters:
offsetMillis - the given base time zone offset to GMT.

getRawOffset

public abstract int getRawOffset()
Gets unmodified offset, NOT modified in case of daylight savings. This is the offset to add *to* UTC to get local time.
Returns:
the unmodified offset to add *to* UTC to get local time.

getID

public java.lang.String getID()
Gets the ID of this time zone.
Returns:
the ID of this time zone.

setID

public void setID(java.lang.String ID)
Sets the time zone ID. This does not change any other data in the time zone object.
Parameters:
ID - the new time zone ID.

getDisplayName

public final java.lang.String getDisplayName()
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 format GMT[+-]hh:mm.
Returns:
the human-readable name of this time zone in the default locale.
Since:
1.2

getDisplayName

public final java.lang.String getDisplayName(java.util.Locale locale)
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 format GMT[+-]hh:mm.
Parameters:
locale - the locale in which to supply the display name.
Returns:
the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized.
Since:
1.2

getDisplayName

public final java.lang.String getDisplayName(boolean daylight,
                                             int style)
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 format GMT[+-]hh:mm.
Parameters:
daylight - if true, return the daylight savings name.
style - either LONG or SHORT
Returns:
the human-readable name of this time zone in the default locale.
Since:
1.2

getDisplayName

public java.lang.String getDisplayName(boolean daylight,
                                       int style,
                                       java.util.Locale 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 format GMT[+-]hh:mm.
Parameters:
daylight - if true, return the daylight savings name.
style - either LONG or SHORT
locale - the locale in which to supply the display name.
Returns:
the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized.
Throws:
java.lang.IllegalArgumentException - style is invalid.
Since:
1.2

useDaylightTime

public abstract boolean useDaylightTime()
Queries if this time zone uses daylight savings time.
Returns:
true if this time zone uses daylight savings time, false, otherwise.

inDaylightTime

public abstract boolean inDaylightTime(java.util.Date date)
Queries if the given date is in daylight savings time in this time zone.
Parameters:
date - the given Date.
Returns:
true if the given date is in daylight savings time, false, otherwise.

getTimeZone

public static TimeZone getTimeZone(java.lang.String ID)
Gets the TimeZone for the given ID.
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.
Returns:
the specified TimeZone, or the GMT zone if the given ID cannot be understood.

getAvailableIDs

public static java.lang.String[] getAvailableIDs(int rawOffset)
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 - the offset in milliseconds from GMT
Returns:
an array of IDs for system TimeZones with the given raw offset. If there are none, return a zero-length array.

getAvailableIDs

public static java.lang.String[] getAvailableIDs(java.lang.String country)
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:
a - two-letter ISO 3166 country code, or null to return zones not associated with any country
Returns:
an array of IDs for system TimeZones in the given country. If there are none, return a zero-length array.

getAvailableIDs

public static java.lang.String[] getAvailableIDs()
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.
Returns:
an array of all system TimeZone IDs

countEquivalentIDs

public static int countEquivalentIDs(java.lang.String id)
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 - a system time zone ID
Returns:
the number of zones in the equivalency group containing 'id', or zero if 'id' is not a valid system ID
See Also:
getEquivalentID(java.lang.String, int)

getEquivalentID

public static java.lang.String getEquivalentID(java.lang.String id,
                                               int index)
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 - a system time zone ID
index - a value from 0 to n-1, where n is the value returned by countEquivalentIDs(id)
Returns:
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:
countEquivalentIDs(java.lang.String)

getDefault

public static TimeZone getDefault()
Gets the default TimeZone for this host. The source of the default TimeZone may vary with implementation.
Returns:
a default TimeZone.

setDefault

public static void setDefault(TimeZone zone)
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

hasSameRules

public boolean hasSameRules(TimeZone other)
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 - the TimeZone object to be compared with
Returns:
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

clone

public java.lang.Object clone()
Overrides Cloneable
Overrides:
clone in class java.lang.Object


Copyright (c) 2001 IBM Corporation and others.