java.lang.Object java.util.TimeZone
public 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:
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:TimeZone tz = TimeZone.getTimeZone("America/Los_Angeles");
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.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
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:
For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".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
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 | |
---|---|
Object |
clone
() Creates a copy of this TimeZone. |
static String [] |
getAvailableIDs
() Gets all the available IDs supported. |
static String |
getAvailableIDs
(int rawOffset) Gets the available IDs according to the given time zone offset in milliseconds. |
static TimeZone |
getDefault
() Gets the default TimeZone for this host. |
String |
getDisplayName
() Returns a name of this time zone suitable for presentation to the user in the default locale. |
String |
getDisplayName
(boolean daylight, int style) Returns a name of this time zone suitable for presentation to the user in the default locale. |
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. |
String |
getDisplayName
(
Locale
locale) Returns a name of this time zone suitable for presentation to the user in the specified locale. |
int |
getDSTSavings
() Returns the amount of time to be added to local standard time to get local wall clock time. |
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. |
int |
getOffset
(long date) Returns the offset of this time zone from UTC at the specified date. |
abstract int |
getRawOffset
() Returns the amount of time in milliseconds to add to UTC to get standard time in this time zone. |
static TimeZone |
getTimeZone
(
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
(
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
(
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 |
---|
public static final int SHORT
public static final int LONG
Constructor Detail |
---|
public TimeZone()
Method Detail |
---|
public abstract int getOffset(int era, int year, int month, int day, int dayOfWeek, int milliseconds)
This method returns a historically correct offset if an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule and GMT offset changes.
public int getOffset(long date)
This method returns a historically correct offset value if an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule and GMT offset changes.
public abstract void setRawOffset(int offsetMillis)
If an underlying TimeZone implementation subclass supports historical GMT offset changes, the specified GMT offset is set as the latest GMT offset and the difference from the known latest GMT offset value is used to adjust all historical GMT offset values.
public abstract int getRawOffset()
If an underlying TimeZone implementation subclass supports historical GMT offset changes, the method returns the raw offset value of the current date. In Honolulu, for example, its raw offset changed from GMT-10:30 to GMT-10:00 in 1947, and this method always returns -36000000 milliseconds (i.e., -10 hours).
public String getID()
public void setID(String ID)
public final String getDisplayName()
public final String getDisplayName(Locale locale)
public final String getDisplayName(boolean daylight, int style)
public String getDisplayName(boolean daylight, int style, Locale locale)
public int getDSTSavings()
The default implementation always returns 3600000 milliseconds (i.e., one hour) if this time zone observes Daylight Saving Time. Otherwise, 0 (zero) is returned.
If an underlying TimeZone implementation subclass supports historical Daylight Saving Time changes, this method returns the known latest daylight saving value.
public abstract boolean useDaylightTime()
If an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule changes, the method refers to the latest Daylight Saving Time schedule information.
public abstract boolean inDaylightTime(Date date)
public static TimeZone getTimeZone(String ID)
public static String[] getAvailableIDs(int rawOffset)
public static String[] getAvailableIDs()
public static TimeZone getDefault()
public static void setDefault(TimeZone zone)
public boolean hasSameRules(TimeZone other)
public Object clone()