Class TimeZone

public static final int LONG

Constant used to indicate that a long timezone name should be returned, such as "Eastern Standard Time".

Field Value:

1

public static final int SHORT

Constant used to indicate that a short timezone abbreviation should be returned, such as "EST"

Field Value:

0

public Object clone()

Returns a clone of this object. I can't imagine, why this is useful for a time zone.

Overrides:

clone in interface Object

public static String[] getAvailableIDs()

Gets all available IDs.

Returns:

An array of all supported IDs.

public static String[] getAvailableIDs(int rawOffset)

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

Parameters:

rawOffset - the given time zone GMT offset.

Returns:

An array of IDs, where the time zone has the specified GMT offset. For example {"Phoenix", "Denver"}, since both have GMT-07:00, but differ in daylight savings behaviour.

public int getDSTSavings()

Gets the daylight savings offset. This is a positive offset in milliseconds with respect to standard time. Typically this is one hour, but for some time zones this may be half an our.

The default implementation returns 3600000 milliseconds (one hour) if the time zone uses daylight savings time (as specified by useDaylightTime()), otherwise it returns 0.

Returns:

the daylight savings offset in milliseconds.

Since:

1.4

public static TimeZone getDefault()

Returns the time zone under which the host is running. This can be changed with setDefault.

Returns:

A clone of the current default time zone for this host.

See Also:

setDefault(TimeZone)

public final String getDisplayName()

This method returns a string name of the time zone suitable for displaying to the user. The string returned will be the long description of the timezone in the current locale. The name displayed will assume daylight savings time is not in effect.

Returns:

The name of the time zone.

public final String getDisplayName(boolean dst,
                                   int style)

This method returns a string name of the time zone suitable for displaying to the user. The string returned will be of the specified type in the current locale.

Parameters:

dst - Whether or not daylight savings time is in effect.

style - LONG for a long name, SHORT for a short abbreviation.

Returns:

The name of the time zone.

public String getDisplayName(boolean dst,
                             int style,
                             Locale locale)

This method returns a string name of the time zone suitable for displaying to the user. The string returned will be of the specified type in the specified locale.

Parameters:

dst - Whether or not daylight savings time is in effect.

style - LONG for a long name, SHORT for a short abbreviation.

locale - The locale for this timezone name.

Returns:

The name of the time zone.

public final String getDisplayName(Locale locale)

This method returns a string name of the time zone suitable for displaying to the user. The string returned will be the long description of the timezone in the specified locale. The name displayed will assume daylight savings time is not in effect.

Parameters:

locale - The locale for this timezone name.

Returns:

The name of the time zone.

public String getID()

Gets the identifier of this time zone. For instance, PST for Pacific Standard Time.

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 the local time.

Parameters:

era - the era of the given date

year - the year of the given date

month - the month of the given date, 0 for January.

day - the day of month

dayOfWeek - the day of week

milliseconds - the millis in the day (in local standard time)

Returns:

the time zone offset in milliseconds.

public int getOffset(long date)

Get the time zone offset for the specified date, modified in case of daylight savings. This is the offset to add to UTC to get the local time.

Parameters:

date - the date represented in millisecends since January 1, 1970 00:00:00 GMT.

Since:

1.4

public abstract int getRawOffset()

Gets the time zone offset, ignoring daylight savings. This is the offset to add to UTC to get the local time.

Returns:

the time zone offset in milliseconds.

public static TimeZone getTimeZone(String ID)

Gets the TimeZone for the given ID.

Parameters:

ID - the time zone identifier.

Returns:

The time zone for the identifier or GMT, if no such time zone exists.

public boolean hasSameRules(TimeZone other)

Test if the other time zone uses the same rule and only possibly differs in ID. This implementation for this particular class will return true if the raw offsets are identical. Subclasses should override this method if they use daylight savings.

Returns:

true if this zone has the same raw offset

public abstract boolean inDaylightTime(Date date)

Returns true, if the given date is in Daylight Savings Time in this time zone.

Parameters:

date - the given Date.

public static void setDefault(TimeZone zone)

public void setID(String id)

Sets the identifier of this time zone. For instance, PST for Pacific Standard Time.

Parameters:

id - the new time zone ID.

Throws:

NullPointerException - if id is null

public abstract void setRawOffset(int offsetMillis)

Sets the time zone offset, ignoring daylight savings. This is the offset to add to UTC to get the local time.

Parameters:

offsetMillis - the time zone offset to GMT.

public abstract boolean useDaylightTime()

Returns true, if this time zone uses Daylight Savings Time.