|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.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 Pacific
Standard Time zone is "PST". So, you can get a PST TimeZone
object
with:
You can useTimeZone tz = TimeZone.getTimeZone("PST");
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 you can create a custom time zone ID with
the following syntax:
For example, you might specify GMT+14:00 as a custom time zone ID. TheGMT[+|-]hh[[:]mm]
TimeZone
that is returned
when you specify a custom time zone ID does not include
daylight savings time.
Calendar
,
GregorianCalendar
,
SimpleTimeZone
, Serialized FormField 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()
Overrides Cloneable |
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. |
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. |
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. |
abstract int |
getRawOffset()
Gets unmodified offset, NOT modified in case of daylight savings. |
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
getDisplayName()
indicating
a short name, such as "PST."LONG
public static final int LONG
getDisplayName()
indicating
a long name, such as "Pacific Standard Time."SHORT
Constructor Detail |
public TimeZone()
Method Detail |
public abstract int getOffset(int era, int year, int month, int day, int dayOfWeek, int milliseconds)
era
- the era of the given date.year
- the year in the given date.month
- the month in the given date.
Month is 0-based. e.g., 0 for January.day
- the day-in-month of the given date.dayOfWeek
- the day-of-week of the given date.milliseconds
- the millis in day in standard local time.public abstract void setRawOffset(int offsetMillis)
offsetMillis
- the given base time zone offset to GMT.public abstract int getRawOffset()
public String getID()
public void setID(String ID)
ID
- the new time zone ID.public final String getDisplayName()
GMT[+-]hh:mm
.public final String getDisplayName(Locale locale)
GMT[+-]hh:mm
.locale
- the locale in which to supply the display name.public final String getDisplayName(boolean daylight, int style)
GMT[+-]hh:mm
.daylight
- if true, return the daylight savings name.style
- either LONG
or SHORT
public String getDisplayName(boolean daylight, int style, Locale locale)
GMT[+-]hh:mm
.daylight
- if true, return the daylight savings name.style
- either LONG
or SHORT
locale
- the locale in which to supply the display name.public abstract boolean useDaylightTime()
public abstract boolean inDaylightTime(Date date)
date
- the given Date.public static TimeZone getTimeZone(String ID)
TimeZone
for the given ID.ID
- the ID for a TimeZone
, either an abbreviation such as
"PST", a full name such as "America/Los_Angeles", or a custom ID
such as "GMT-8:00".TimeZone
, or the GMT zone if the given ID
cannot be understood.public static String[] getAvailableIDs(int rawOffset)
rawOffset
- the given time zone GMT offset.public static String[] getAvailableIDs()
public static TimeZone getDefault()
TimeZone
for this host.
The source of the default TimeZone
may vary with implementation.TimeZone
.public static void setDefault(TimeZone zone)
TimeZone
that is
returned by the getDefault
method.zone
- the new default time zonepublic boolean hasSameRules(TimeZone other)
other
- the TimeZone
object to be compared withpublic Object clone()
Cloneable
interface. Subclasses
that override the clone
method can also
throw this exception to indicate that an instance cannot
be cloned.Cloneable
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |