| /* |
| * @(#)TimeZone.java 1.51 00/01/19 |
| * |
| * Copyright (C) 1996-2009, International Business Machines |
| * Corporation and others. All Rights Reserved. |
| */ |
| |
| package com.ibm.icu.util; |
| |
| import java.io.Serializable; |
| import java.util.Date; |
| import java.util.Locale; |
| import java.util.MissingResourceException; |
| |
| import com.ibm.icu.impl.Grego; |
| import com.ibm.icu.impl.ICUCache; |
| import com.ibm.icu.impl.ICUConfig; |
| import com.ibm.icu.impl.JavaTimeZone; |
| import com.ibm.icu.impl.SimpleCache; |
| import com.ibm.icu.impl.TimeZoneAdapter; |
| import com.ibm.icu.impl.ZoneMeta; |
| import com.ibm.icu.text.SimpleDateFormat; |
| |
| /** |
| * <code>TimeZone</code> represents a time zone offset, and also figures out daylight |
| * savings. |
| * |
| * <p> |
| * Typically, you get a <code>TimeZone</code> using <code>getDefault</code> |
| * which creates a <code>TimeZone</code> based on the time zone where the program |
| * is running. For example, for a program running in Japan, <code>getDefault</code> |
| * creates a <code>TimeZone</code> object based on Japanese Standard Time. |
| * |
| * <p> |
| * You can also get a <code>TimeZone</code> using <code>getTimeZone</code> |
| * 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 <code>TimeZone</code> object with: |
| * <blockquote> |
| * <pre> |
| * TimeZone tz = TimeZone.getTimeZone("America/Los_Angeles"); |
| * </pre> |
| * </blockquote> |
| * You can use <code>getAvailableIDs</code> method to iterate through |
| * all the supported time zone IDs. You can then choose a |
| * supported ID to get a <code>TimeZone</code>. |
| * 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: |
| * |
| * <blockquote> |
| * <pre> |
| * GMT[+|-]hh[[:]mm] |
| * </pre> |
| * </blockquote> |
| * |
| * For example, you might specify GMT+14:00 as a custom |
| * time zone ID. The <code>TimeZone</code> that is returned |
| * when you specify a custom time zone ID does not include |
| * daylight savings time. |
| * <p> |
| * For compatibility with JDK 1.1.x, some other three-letter time zone IDs |
| * (such as "PST", "CTT", "AST") are also supported. However, <strong>their |
| * use is deprecated</strong> 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. |
| * |
| * <p><strong>Note:</strong> Starting from ICU4J 4.0, you can optionally choose |
| * JDK <code>TimeZone</code> as the time zone implementation. The TimeZone factory |
| * method <code>getTimeZone</code> creates an instance of ICU's own <code>TimeZone</code> |
| * subclass by default. If you want to use the JDK implementation always, you can |
| * set the default time zone implementation type by the new method |
| * <code>setDefaultTimeZoneType</code>. Alternatively, you can change the initial |
| * default implementation type by setting a property below. |
| * |
| * <blockquote> |
| * <pre> |
| * # |
| * # The default TimeZone implementation type used by the ICU TimeZone |
| * # factory method. [ ICU | JDK ] |
| * # |
| * com.ibm.icu.util.TimeZone.DefaultTimeZoneType = ICU |
| * </pre> |
| * </blockquote> |
| * |
| * <p>This property is included in ICUConfig.properties in com.ibm.icu package. |
| * When <code>TimeZone</code> class is loaded, the intialization code checks |
| * if the property <code>com.ibm.icu.util.TimeZone.DefaultTimeZoneType=xxx</code> |
| * is defined by the system properties. If not available, then it loads ICUConfig.properties |
| * to get the default time zone implementation type. The property setting is |
| * only used for the initial default value and you can change the default type |
| * by <code>setDefaultTimeZoneType</code> at runtime. |
| * |
| * @see Calendar |
| * @see GregorianCalendar |
| * @see SimpleTimeZone |
| * @author Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu |
| * @stable ICU 2.0 |
| */ |
| abstract public class TimeZone implements Serializable, Cloneable { |
| // using serialver from jdk1.4.2_05 |
| private static final long serialVersionUID = -744942128318337471L; |
| |
| /** |
| * Default constructor. (For invocation by subclass constructors, |
| * typically implicit.) |
| * @stable ICU 2.8 |
| */ |
| public TimeZone() { |
| } |
| |
| /** |
| * A time zone implementation type indicating ICU's own TimeZone used by |
| * <code>getTimeZone</code>, <code>setDefaultTimeZoneType</code> |
| * and <code>getDefaultTimeZoneType</code>. |
| * @stable ICU 4.0 |
| */ |
| public static final int TIMEZONE_ICU = 0; |
| /** |
| * A time zone implementation type indicating JDK TimeZone used by |
| * <code>getTimeZone</code>, <code>setDefaultTimeZoneType</code> |
| * and <code>getDefaultTimeZoneType</code>. |
| * @stable ICU 4.0 |
| */ |
| public static final int TIMEZONE_JDK = 1; |
| |
| /** |
| * A style specifier for <code>getDisplayName()</code> indicating |
| * a short name, such as "PST." |
| * @see #LONG |
| * @stable ICU 2.0 |
| */ |
| public static final int SHORT = 0; |
| |
| /** |
| * A style specifier for <code>getDisplayName()</code> indicating |
| * a long name, such as "Pacific Standard Time." |
| * @see #SHORT |
| * @stable ICU 2.0 |
| */ |
| public static final int LONG = 1; |
| |
| /** |
| * @internal |
| * @deprecated This API is ICU internal only. |
| */ |
| /* |
| private static final int SHORT_GENERIC = 2; |
| */ |
| |
| /** |
| * @internal |
| * @deprecated This API is ICU internal only. |
| */ |
| private static final int LONG_GENERIC = 3; |
| |
| /** |
| * Cache to hold the SimpleDateFormat objects for a Locale. |
| */ |
| private static ICUCache cachedLocaleData = new SimpleCache(); |
| |
| /** |
| * 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. |
| * @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 millis in day in <em>standard</em> local time. |
| * @return the offset to add *to* GMT to get local time. |
| * @stable ICU 2.0 |
| */ |
| abstract public int getOffset(int era, int year, int month, int day, |
| int dayOfWeek, int milliseconds); |
| |
| |
| /** |
| * 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. |
| * |
| * @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 |
| * @see #getOffset(long, boolean, int[]) |
| * @stable ICU 2.8 |
| */ |
| public int getOffset(long date) { |
| int[] result = new int[2]; |
| getOffset(date, false, result); |
| return result[0]+result[1]; |
| } |
| |
| /** |
| * 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(). |
| * |
| * @param date 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'. |
| * @param local if true, `date' is local wall time; otherwise it |
| * is in GMT time. |
| * @param offsets 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. |
| * |
| * @stable ICU 2.8 |
| */ |
| public void getOffset(long date, boolean local, int[] offsets) { |
| offsets[0] = getRawOffset(); |
| if (!local) { |
| date += offsets[0]; // now in local standard millis |
| } |
| |
| // When local == true, date might not be in local standard |
| // millis. getOffset taking 6 parameters used here assume |
| // the given time in day is local standard time. |
| // At STD->DST transition, there is a range of time which |
| // does not exist. When 'date' is in this time range |
| // (and local == true), this method interprets the specified |
| // local time as DST. At DST->STD transition, there is a |
| // range of time which occurs twice. In this case, this |
| // method interprets the specified local time as STD. |
| // To support the behavior above, we need to call getOffset |
| // (with 6 args) twice when local == true and DST is |
| // detected in the initial call. |
| int fields[] = new int[6]; |
| for (int pass = 0; ; pass++) { |
| Grego.timeToFields(date, fields); |
| offsets[1] = getOffset(GregorianCalendar.AD, |
| fields[0], fields[1], fields[2], |
| fields[3], fields[5]) - offsets[0]; |
| |
| if (pass != 0 || !local || offsets[1] == 0) { |
| break; |
| } |
| // adjust to local standard millis |
| date -= offsets[1]; |
| } |
| } |
| |
| /** |
| * Sets the base time zone offset to GMT. |
| * This is the offset to add *to* UTC to get local time. |
| * @param offsetMillis the given base time zone offset to GMT. |
| * @stable ICU 2.0 |
| */ |
| abstract public void setRawOffset(int offsetMillis); |
| |
| /** |
| * Gets unmodified offset, NOT modified in case of daylight savings. |
| * This is the offset to add *to* UTC to get local time. |
| * @return the unmodified offset to add *to* UTC to get local time. |
| * @stable ICU 2.0 |
| */ |
| abstract public int getRawOffset(); |
| |
| /** |
| * Gets the ID of this time zone. |
| * @return the ID of this time zone. |
| * @stable ICU 2.0 |
| */ |
| public String getID() { |
| return ID; |
| } |
| |
| /** |
| * Sets the time zone ID. This does not change any other data in |
| * the time zone object. |
| * @param ID the new time zone ID. |
| * @stable ICU 2.0 |
| */ |
| public void setID(String ID) { |
| if (ID == null) { |
| throw new NullPointerException(); |
| } |
| this.ID = ID; |
| } |
| |
| /** |
| * Returns a name of this time zone suitable for presentation to the user |
| * in the default 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 the human-readable name of this time zone in the default locale. |
| * @stable ICU 2.0 |
| */ |
| public final String getDisplayName() { |
| return _getDisplayName(false, LONG_GENERIC, ULocale.getDefault()); |
| } |
| |
| /** |
| * 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. |
| * @param locale the locale in which to supply the display name. |
| * @return the human-readable name of this time zone in the given locale |
| * or in the default locale if the given locale is not recognized. |
| * @stable ICU 2.0 |
| */ |
| public final String getDisplayName(Locale locale) { |
| return _getDisplayName(false, LONG_GENERIC, ULocale.forLocale(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, |
| * a fallback based on the country, city, or time zone id will be used. |
| * @param locale the ulocale in which to supply the display name. |
| * @return the human-readable name of this time zone in the given locale |
| * or in the default ulocale if the given ulocale is not recognized. |
| * @stable ICU 3.2 |
| */ |
| public final String getDisplayName(ULocale locale) { |
| return _getDisplayName(false, LONG_GENERIC, 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 format |
| * <code>GMT[+-]hh:mm</code>. |
| * @param daylight if true, return the daylight savings name. |
| * @param style either <code>LONG</code> or <code>SHORT</code> |
| * @return the human-readable name of this time zone in the default locale. |
| * @stable ICU 2.0 |
| */ |
| public final String getDisplayName(boolean daylight, int style) { |
| return getDisplayName(daylight, style, ULocale.getDefault()); |
| } |
| |
| /** |
| * 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 |
| * <code>GMT[+-]hh:mm</code>. |
| * @param daylight if true, return the daylight savings name. |
| * @param style either <code>LONG</code> or <code>SHORT</code> |
| * @param locale the locale in which to supply the display name. |
| * @return the human-readable name of this time zone in the given locale |
| * or in the default locale if the given locale is not recognized. |
| * @exception IllegalArgumentException style is invalid. |
| * @stable ICU 2.0 |
| */ |
| public String getDisplayName(boolean daylight, int style, Locale locale) { |
| return getDisplayName(daylight, style, ULocale.forLocale(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 |
| * <code>GMT[+-]hh:mm</code>. |
| * @param daylight if true, return the daylight savings name. |
| * @param style either <code>LONG</code> or <code>SHORT</code> |
| * @param locale the locale in which to supply the display name. |
| * @return the human-readable name of this time zone in the given locale |
| * or in the default locale if the given locale is not recognized. |
| * @exception IllegalArgumentException style is invalid. |
| * @stable ICU 3.2 |
| */ |
| public String getDisplayName(boolean daylight, int style, ULocale locale) { |
| if (style != SHORT && style != LONG) { |
| throw new IllegalArgumentException("Illegal style: " + style); |
| } |
| return _getDisplayName(daylight, style, locale); |
| } |
| |
| /** |
| * The public version of this API only accepts LONG/SHORT, the |
| * internal version (which this calls) also accepts LONG_GENERIC/SHORT_GENERIC. |
| */ |
| private synchronized String _getDisplayName(boolean daylight, int style, ULocale locale) { |
| if (locale == null) { |
| throw new NullPointerException("locale is null"); |
| } |
| |
| /* NOTES: |
| * (1) We use SimpleDateFormat for simplicity; we could do this |
| * more efficiently but it would duplicate the SimpleDateFormat code |
| * here, which is undesirable. |
| * (2) Attempts to move the code from SimpleDateFormat to here also run |
| * around because this requires SimpleDateFormat to keep a Locale |
| * object around, which it currently doesn't; to synthesize such a |
| * locale upon resurrection; and to somehow handle the special case of |
| * construction from a DateFormatSymbols object. |
| */ |
| |
| // We keep a cache, indexed by locale. The cache contains a |
| // SimpleDateFormat object, which we create on demand. |
| SimpleDateFormat format = (SimpleDateFormat)cachedLocaleData.get(locale); |
| if (format == null) { |
| format = new SimpleDateFormat(null, locale); |
| cachedLocaleData.put(locale, format); |
| } |
| |
| String[] patterns = { "z", "zzzz", "v", "vvvv" }; |
| format.applyPattern(patterns[style]); |
| format.setTimeZone(this); |
| Date d = new Date(); |
| if (style >= 2) { |
| // Generic names may change time to time even for a single time zone. |
| // This method returns the one used for the zone now. |
| return format.format(d); |
| } else { |
| int[] offsets = new int[2]; |
| getOffset(d.getTime(), false, offsets); |
| if ((daylight && offsets[1] != 0) || (!daylight && offsets[1] == 0)) { |
| return format.format(d); |
| } |
| |
| // Create a new SimpleTimeZone as a stand-in for this zone; the stand-in |
| // will have no DST, or DST during July, but the same ID and offset, |
| // and hence the same display name. We don't cache these because |
| // they're small and cheap to create. |
| SimpleTimeZone tz; |
| if (daylight && useDaylightTime()) { |
| // The display name for daylight saving time was requested, but currently not in DST |
| |
| // Set a fixed date (July 1) in this Gregorian year |
| GregorianCalendar cal = new GregorianCalendar(this); |
| cal.set(Calendar.MONTH, Calendar.JULY); |
| cal.set(Calendar.DATE, 1); |
| |
| // Get July 1 date |
| d = cal.getTime(); |
| |
| // Check if it is in DST |
| if (cal.get(Calendar.DST_OFFSET) == 0) { |
| // We need to create a fake time zone |
| tz = new SimpleTimeZone(offsets[0], getID(), |
| Calendar.JUNE, 1, 0, 0, |
| Calendar.AUGUST, 1, 0, 0, |
| getDSTSavings()); |
| format.setTimeZone(tz); |
| } |
| } else { |
| // The display name for standard time was requested, but currently in DST |
| // or display name for daylight saving time was requested, but this zone no longer |
| // observes DST. |
| tz = new SimpleTimeZone(offsets[0], getID()); |
| format.setTimeZone(tz); |
| } |
| return format.format(d); |
| } |
| } |
| |
| /** |
| * Returns the amount of time to be added to local standard time |
| * to get local wall clock time. |
| * <p> |
| * The default implementation always returns 3600000 milliseconds |
| * (i.e., one hour) if this time zone observes Daylight Saving |
| * Time. Otherwise, 0 (zero) is returned. |
| * <p> |
| * If an underlying TimeZone implementation subclass supports |
| * historical Daylight Saving Time changes, this method returns |
| * the known latest daylight saving value. |
| * |
| * @return the amount of saving time in milliseconds |
| * @stable ICU 2.8 |
| */ |
| public int getDSTSavings() { |
| if (useDaylightTime()) { |
| return 3600000; |
| } |
| return 0; |
| } |
| |
| /** |
| * Queries if this time zone uses daylight savings time. |
| * @return true if this time zone uses daylight savings time, |
| * false, otherwise. |
| * @stable ICU 2.0 |
| */ |
| abstract public boolean useDaylightTime(); |
| |
| /** |
| * Queries if the given date is in daylight savings time in |
| * this time zone. |
| * @param date the given Date. |
| * @return true if the given date is in daylight savings time, |
| * false, otherwise. |
| * @stable ICU 2.0 |
| */ |
| abstract public boolean inDaylightTime(Date date); |
| |
| /** |
| * Gets the <code>TimeZone</code> for the given ID. |
| * |
| * @param ID the ID for a <code>TimeZone</code>, 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 <code>TimeZone</code>, or the GMT zone if the given ID |
| * cannot be understood. |
| * @stable ICU 2.0 |
| */ |
| public static synchronized TimeZone getTimeZone(String ID) { |
| return getTimeZone(ID, TZ_IMPL); |
| } |
| |
| /** |
| * Gets the <code>TimeZone</code> for the given ID and the timezone type. |
| * @param ID the ID for a <code>TimeZone</code>, 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. |
| * @param type Timezone type, either <code>TIMEZONE_ICU</code> or <code>TIMEZONE_JDK</code>. |
| * @return the specified <code>TimeZone</code>, or the GMT zone if the given ID |
| * cannot be understood. |
| * @stable ICU 4.0 |
| */ |
| public static synchronized TimeZone getTimeZone(String ID, int type) { |
| TimeZone result; |
| if (type == TIMEZONE_JDK) { |
| result = new JavaTimeZone(ID); |
| } else { |
| /* We first try to lookup the zone ID in our system list. If this |
| * fails, we try to parse it as a custom string GMT[+-]hh:mm. If |
| * all else fails, we return GMT, which is probably not what the |
| * user wants, but at least is a functioning TimeZone object. |
| * |
| * We cannot return NULL, because that would break compatibility |
| * with the JDK. |
| */ |
| if(ID==null){ |
| throw new NullPointerException(); |
| } |
| result = ZoneMeta.getSystemTimeZone(ID); |
| |
| if (result == null) { |
| result = ZoneMeta.getCustomTimeZone(ID); |
| } |
| if (result == null) { |
| result = ZoneMeta.getGMT(); |
| } |
| } |
| return result; |
| } |
| |
| /** |
| * Sets the default timezone type used by <code>getTimeZone</code>. |
| * @param type Timezone type, either <code>TIMEZONE_ICU</code> or <code>TIMEZONE_JDK</code>. |
| * @stable ICU 4.0 |
| */ |
| public static synchronized void setDefaultTimeZoneType(int type) { |
| if (type != TIMEZONE_ICU && type != TIMEZONE_JDK) { |
| throw new IllegalArgumentException("Invalid timezone type"); |
| } |
| TZ_IMPL = type; |
| } |
| |
| /** |
| * Returns the default timezone type currently used. |
| * @return The default timezone type, either <code>TIMEZONE_ICU</code> or <code>TIMEZONE_JDK</code>. |
| * @stable ICU 4.0 |
| */ |
| public static int getDefaultTimeZoneType() { |
| return TZ_IMPL; |
| } |
| |
| /** |
| * Return a new String array containing all system TimeZone IDs |
| * with the given raw offset from GMT. These IDs may be passed to |
| * <code>get()</code> to construct the corresponding TimeZone |
| * object. |
| * @param rawOffset the offset in milliseconds from GMT |
| * @return an array of IDs for system TimeZones with the given |
| * raw offset. If there are none, return a zero-length array. |
| * @stable ICU 2.0 |
| */ |
| public static String[] getAvailableIDs(int rawOffset) { |
| return ZoneMeta.getAvailableIDs(rawOffset); |
| |
| } |
| |
| |
| /** |
| * Return a new String array containing all system TimeZone IDs |
| * associated with the given country. These IDs may be passed to |
| * <code>get()</code> to construct the corresponding TimeZone |
| * object. |
| * @param country a two-letter ISO 3166 country code, or <code>null</code> |
| * to return zones not associated with any country |
| * @return an array of IDs for system TimeZones in the given |
| * country. If there are none, return a zero-length array. |
| * @stable ICU 2.0 |
| */ |
| public static String[] getAvailableIDs(String country) { |
| return ZoneMeta.getAvailableIDs(country); |
| } |
| |
| /** |
| * Return a new String array containing all system TimeZone IDs. |
| * These IDs (and only these IDs) may be passed to |
| * <code>get()</code> to construct the corresponding TimeZone |
| * object. |
| * @return an array of all system TimeZone IDs |
| * @stable ICU 2.0 |
| */ |
| public static String[] getAvailableIDs() { |
| return ZoneMeta.getAvailableIDs(); |
| } |
| |
| /** |
| * 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. |
| * |
| * <p>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. |
| * @param id a system time zone ID |
| * @return the number of zones in the equivalency group containing |
| * 'id', or zero if 'id' is not a valid system ID |
| * @see #getEquivalentID |
| * @stable ICU 2.0 |
| */ |
| public static int countEquivalentIDs(String id) { |
| return ZoneMeta.countEquivalentIDs(id); |
| } |
| |
| /** |
| * 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. |
| * |
| * <p>The given index must be in the range 0..n-1, where n is the |
| * value returned by <code>countEquivalentIDs(id)</code>. 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. |
| * @param id a system time zone ID |
| * @param index a value from 0 to n-1, where n is the value |
| * returned by <code>countEquivalentIDs(id)</code> |
| * @return 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 #countEquivalentIDs |
| * @stable ICU 2.0 |
| */ |
| public static String getEquivalentID(String id, int index) { |
| return ZoneMeta.getEquivalentID(id, index); |
| } |
| |
| /** |
| * Gets the default <code>TimeZone</code> for this host. |
| * The source of the default <code>TimeZone</code> |
| * may vary with implementation. |
| * @return a default <code>TimeZone</code>. |
| * @stable ICU 2.0 |
| */ |
| public static synchronized TimeZone getDefault() { |
| if (defaultZone == null) { |
| if (TZ_IMPL == TIMEZONE_JDK) { |
| defaultZone = new JavaTimeZone(); |
| } else { |
| java.util.TimeZone temp = java.util.TimeZone.getDefault(); |
| defaultZone = getTimeZone(temp.getID()); |
| } |
| } |
| return (TimeZone) defaultZone.clone(); |
| } |
| |
| /** |
| * Sets the <code>TimeZone</code> that is |
| * returned by the <code>getDefault</code> method. If <code>zone</code> |
| * is null, reset the default to the value it had originally when the |
| * VM first started. |
| * @param tz the new default time zone |
| * @stable ICU 2.0 |
| */ |
| public static synchronized void setDefault(TimeZone tz) { |
| defaultZone = tz; |
| java.util.TimeZone jdkZone = null; |
| if (defaultZone instanceof JavaTimeZone) { |
| jdkZone = ((JavaTimeZone)defaultZone).unwrap(); |
| } else { |
| // Keep java.util.TimeZone default in sync so java.util.Date |
| // can interoperate with com.ibm.icu.util classes. |
| |
| if (tz != null) { |
| if (tz instanceof com.ibm.icu.impl.OlsonTimeZone) { |
| // Because of the lack of APIs supporting historic |
| // zone offset/dst saving in JDK TimeZone, |
| // wrapping ICU TimeZone with JDK TimeZone will |
| // cause historic offset calculation in Calendar/Date. |
| // JDK calendar implementation calls getRawOffset() and |
| // getDSTSavings() when the instance of JDK TimeZone |
| // is not an instance of JDK internal TimeZone subclass |
| // (sun.util.calendar.ZoneInfo). Ticket#6459 |
| String icuID = tz.getID(); |
| jdkZone = java.util.TimeZone.getTimeZone(icuID); |
| if (!icuID.equals(jdkZone.getID())) { |
| // JDK does not know the ID.. |
| jdkZone = null; |
| } |
| } |
| if (jdkZone == null) { |
| jdkZone = TimeZoneAdapter.wrap(tz); |
| } |
| } |
| } |
| java.util.TimeZone.setDefault(jdkZone); |
| } |
| |
| /** |
| * 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 <code>TimeZone</code> 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 |
| * @stable ICU 2.0 |
| */ |
| public boolean hasSameRules(TimeZone other) { |
| return other != null && |
| getRawOffset() == other.getRawOffset() && |
| useDaylightTime() == other.useDaylightTime(); |
| } |
| |
| /** |
| * Overrides Cloneable |
| * @stable ICU 2.0 |
| */ |
| public Object clone() { |
| try { |
| TimeZone other = (TimeZone) super.clone(); |
| other.ID = ID; |
| return other; |
| } catch (CloneNotSupportedException e) { |
| throw new IllegalStateException(); |
| } |
| } |
| |
| /** |
| * Return true if obj is a TimeZone with the same class and ID as this. |
| * @return true if obj is a TimeZone with the same class and ID as this |
| * @param obj the object to compare against |
| * @stable ICU 3.6 |
| */ |
| public boolean equals(Object obj){ |
| if (this == obj) return true; |
| if (obj == null || getClass() != obj.getClass()) return false; |
| return (ID.equals(((TimeZone)obj).ID)); |
| } |
| |
| /** |
| * Return the hash code. |
| * @return the hash code |
| * @stable ICU 3.6 |
| */ |
| public int hashCode(){ |
| return ID.hashCode(); |
| } |
| |
| /** |
| * Returns the timezone data version currently used by ICU. |
| * |
| * @return the version string, such as "2007f" |
| * @throws MissingResourceException if ICU timezone resource bundle |
| * is missing or the version information is not available. |
| * |
| * @stable ICU 3.8 |
| */ |
| public static synchronized String getTZDataVersion() { |
| if (TZDATA_VERSION == null) { |
| UResourceBundle tzbundle = UResourceBundle.getBundleInstance( |
| "com/ibm/icu/impl/data/icudt" + VersionInfo.ICU_DATA_VERSION, "zoneinfo"); |
| TZDATA_VERSION = tzbundle.getString("TZVersion"); |
| } |
| return TZDATA_VERSION; |
| } |
| |
| /** |
| * Returns the canonical system timezone ID or the normalized |
| * custom time zone ID for the given time zone ID. |
| * @param id The input timezone ID to be canonicalized. |
| * @return The canonical system timezone ID or the custom timezone ID |
| * in normalized format for the given timezone ID. When the given timezone ID |
| * is neither a known system time zone ID nor a valid custom timezone ID, |
| * null is returned. |
| * @stable ICU 4.0 |
| */ |
| public static String getCanonicalID(String id) { |
| return getCanonicalID(id, null); |
| } |
| |
| /** |
| * Returns the canonical system timezone ID or the normalized |
| * custom time zone ID for the given time zone ID. |
| * @param id The input timezone ID to be canonicalized. |
| * @param isSystemID When non-null boolean array is specified and |
| * the given ID is a known system timezone ID, true is set to <code>isSystemID[0]</code> |
| * @return The canonical system timezone ID or the custom timezone ID |
| * in normalized format for the given timezone ID. When the given timezone ID |
| * is neither a known system time zone ID nor a valid custom timezone ID, |
| * null is returned. |
| * @stable ICU 4.0 |
| */ |
| public static String getCanonicalID(String id, boolean[] isSystemID) { |
| String canonicalID = null; |
| boolean systemTzid = false; |
| if (id != null && id.length() != 0) { |
| canonicalID = ZoneMeta.getCanonicalSystemID(id); |
| if (canonicalID != null) { |
| systemTzid = true; |
| } else { |
| canonicalID = ZoneMeta.getCustomID(id); |
| } |
| } |
| if (isSystemID != null) { |
| isSystemID[0] = systemTzid; |
| } |
| return canonicalID; |
| } |
| |
| // =======================privates=============================== |
| |
| /** |
| * The string identifier of this <code>TimeZone</code>. This is a |
| * programmatic identifier used internally to look up <code>TimeZone</code> |
| * objects from the system table and also to map them to their localized |
| * display names. <code>ID</code> values are unique in the system |
| * table but may not be for dynamically created zones. |
| * @serial |
| */ |
| private String ID; |
| |
| /** |
| * The default time zone, or null if not set. |
| */ |
| private static TimeZone defaultZone = null; |
| |
| /** |
| * The tzdata version |
| */ |
| private static String TZDATA_VERSION = null; |
| |
| /** |
| * TimeZone implementation type |
| */ |
| private static int TZ_IMPL = TIMEZONE_ICU; |
| |
| /** |
| * TimeZone implementation type initialization |
| */ |
| private static final String TZIMPL_CONFIG_KEY = "com.ibm.icu.util.TimeZone.DefaultTimeZoneType"; |
| private static final String TZIMPL_CONFIG_ICU = "ICU"; |
| private static final String TZIMPL_CONFIG_JDK = "JDK"; |
| |
| static { |
| String type = ICUConfig.get(TZIMPL_CONFIG_KEY, TZIMPL_CONFIG_ICU); |
| if (type.equalsIgnoreCase(TZIMPL_CONFIG_JDK)) { |
| TZ_IMPL = TIMEZONE_JDK; |
| } |
| } |
| } |
| |
| //eof |
