|
FlexDoc/Javadoc 2.0 Demo Java Doc |
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 final int |
A style specifier for getDisplayName() indicating
a long name, such as "Pacific Standard Time."
|
|
static final int |
A style specifier for getDisplayName() indicating
a short name, such as "PST."
|
Constructor Summary |
||
TimeZone()
Sole constructor.
|
Method Summary |
||
clone()
Creates a copy of this TimeZone.
|
||
static String[] |
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 |
Gets the default TimeZone of the Java virtual machine.
|
|
final String |
Returns a long standard time name of this TimeZone suitable for
presentation to the user in the default locale.
|
|
final String |
getDisplayName(boolean daylight, int style)
Returns a name in the specified style of this TimeZone
suitable for presentation to the user in the default locale.
|
|
getDisplayName(boolean daylight, int style, Locale locale)
Returns a name in the specified style of this TimeZone
suitable for presentation to the user in the specified
locale.
|
||
final String |
getDisplayName(Locale locale)
Returns a long standard time name of this TimeZone suitable for
presentation to the user in the specified locale.
|
|
int |
Returns the amount of time to be added to local standard time
to get local wall clock time.
|
|
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 |
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.
|
|
static TimeZone |
getTimeZone(ZoneId zoneId)
Gets the TimeZone for the given zoneId.
|
|
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 Saving Time in
this time zone.
|
|
boolean |
Returns true if this TimeZone is currently in
Daylight Saving Time, or if a transition from Standard Time to
Daylight Saving Time occurs at any future time.
|
|
static void |
setDefault(TimeZone zone)
Sets the TimeZone that is returned by the getDefault
method.
|
|
void |
Sets the time zone ID.
|
|
abstract void |
setRawOffset(int offsetMillis)
Sets the base time zone offset to GMT.
|
|
toZoneId()
Converts this TimeZone object to a ZoneId.
|
||
abstract boolean |
Queries if this TimeZone uses Daylight Saving Time.
|
Methods inherited from class java.lang.Object |
public TimeZone |
() |
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 |
() |
This method is equivalent to:
getDisplayName(false, LONG, Locale.getDefault(Locale.Category.DISPLAY))
public final String getDisplayName |
(Locale locale) |
This method is equivalent to:
getDisplayName(false, LONG, locale)
public final String getDisplayName |
(boolean daylight, int style) |
This method is equivalent to:
getDisplayName(daylight, style,
Locale.getDefault(Locale.Category.DISPLAY))
public String getDisplayName |
When looking up a time zone name, the default Locale search path of ResourceBundle derived from the specified locale is used. (No fallback Locale search is performed.) If a time zone name in any Locale of the search path, including Locale.ROOT, is found, the name is returned. Otherwise, a string in the normalized custom ID format is returned.
public int getDSTSavings |
() |
The default implementation returns 3600000 milliseconds (i.e., one hour) if a call to useDaylightTime() returns true. Otherwise, 0 (zero) is returned.
If an underlying TimeZone implementation subclass supports historical and future Daylight Saving Time schedule changes, this method returns the amount of saving time of the last known Daylight Saving Time rule that can be a future prediction.
If the amount of saving time at any given time stamp is required, construct a Calendar with this TimeZone and the time stamp, and call Calendar.get(Calendar.DST_OFFSET).
public abstract boolean useDaylightTime |
() |
If an underlying TimeZone implementation subclass supports historical and future Daylight Saving Time schedule changes, this method refers to the last known Daylight Saving Time rule that can be a future prediction and may not be the same as the current rule. Consider calling observesDaylightTime() if the current rule should also be taken into account.
public boolean observesDaylightTime |
() |
The default implementation returns true if useDaylightTime() or inDaylightTime(new Date()) returns true.
public abstract boolean inDaylightTime |
(Date date) |
public static TimeZone getTimeZone |
(String ID) |
public static TimeZone getTimeZone |
(ZoneId zoneId) |
public ZoneId toZoneId |
() |
public static String[] getAvailableIDs |
(int rawOffset) |
public static String[] getAvailableIDs |
() |
public static TimeZone getDefault |
() |
The default TimeZone created from the ID is cached, and its clone is returned. The user.timezone property value is set to the ID upon return.
public static void setDefault |
(TimeZone zone) |
public boolean hasSameRules |
(TimeZone other) |
public Object clone |
() |
|
FlexDoc/Javadoc 2.0 Demo Java Doc |