java.util
Class TimeZone
java.lang.Object
|
+--java.util.TimeZone
All Implemented Interfaces:
Serializable, Cloneable
This class represents a time zone offset and handles daylight savings.
You can get the default time zone with getDefault
.
This represents the time zone where program is running.
Another way to create a time zone is getTimeZone
, where
you can give an identifier as parameter. For instance, the identifier
of the Central European Time zone is "CET".
With the getAvailableIDs
method, you can get all the
supported time zone identifiers.
Author:See Also:
LONG
public static final int LONG
Constant used to indicate that a long timezone name should be
returned, such as "Eastern Standard Time".
SHORT
public static final int SHORT
Constant used to indicate that a short timezone abbreviation should
be returned, such as "EST"
clone
public Object clone()
Returns a clone of this object. I can't imagine, why this is
useful for a time zone.
getAvailableIDs
public static String[] getAvailableIDs()
Gets all available IDs.
Returns:
- An array of all supported IDs.
getAvailableIDs
public static String[] getAvailableIDs(int rawOffset)
Gets the available IDs according to the given time zone
offset.
Parameters:
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.
getDSTSavings
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.
Since:Returns:
- the daylight savings offset in milliseconds.
getDefault
public static TimeZone getDefault()
Returns the time zone under which the host is running. This
can be changed with setDefault.
Returns:
- the time zone for this host.
See Also:
getDisplayName
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.
getDisplayName
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:
Returns:
- The name of the time zone.
getDisplayName
public String getDisplayName(boolean dst, int style, java.util.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:
Returns:
- The name of the time zone.
getDisplayName
public final String getDisplayName(java.util.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:
Returns:
- The name of the time zone.
getID
public String getID()
Gets the identifier of this time zone. For instance, PST for
Pacific Standard Time.
getOffset
public 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:
Returns:
- the time zone offset in milliseconds.
getRawOffset
public 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.
getTimeZone
public static TimeZone getTimeZone(java.lang.String ID)
Gets the TimeZone for the given ID.
Parameters:
Returns:
- The time zone for the identifier or GMT, if no such time
zone exists.
hasSameRules
public boolean hasSameRules(java.util.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.
Parameters:
Returns:
- true if this zone has the same raw offset
inDaylightTime
public boolean inDaylightTime(java.util.Date date)
Returns true, if the given date is in Daylight Savings Time in this
time zone.
Parameters:
setDefault
public static void setDefault(java.util.TimeZone zone)
Parameters:
setID
public void setID(java.lang.String id)
Sets the identifier of this time zone. For instance, PST for
Pacific Standard Time.
Parameters:
setRawOffset
public 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:
useDaylightTime
public boolean useDaylightTime()
Returns true, if this time zone uses Daylight Savings Time.
getDefault
. This represents the time zone where program is running. Another way to create a time zone isgetTimeZone
, where you can give an identifier as parameter. For instance, the identifier of the Central European Time zone is "CET". With thegetAvailableIDs
method, you can get all the supported time zone identifiers.