Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

TimeZone

extends Object
implements Serializable Cloneable

java.lang.Object
↳	java.util.TimeZone

Known Direct Subclasses

SimpleTimeZone

Class Overview

TimeZone represents a time zone, primarily used for configuring a Calendar or SimpleDateFormat instance.

Most applications will use getDefault() which returns a TimeZone based on the time zone where the program is running.

You can also get a specific TimeZone by id.

It is highly unlikely you'll ever want to use anything but the factory methods yourself. Let classes like Calendar and SimpleDateFormat do the date computations for you.

If you do need to do date computations manually, there are two common cases to take into account:

Somewhere like California, where daylight time is used. The useDaylightTime() method will always return true, and inDaylightTime(Date) must be used to determine whether or not daylight time applies to a given Date. The getRawOffset() method will return a raw offset of (in this case) -8 hours from UTC, which isn't usually very useful. More usefully, the getOffset(int, int, int, int, int, int) methods return the actual offset from UTC for a given point in time; this is the raw offset plus (if the point in time is in daylight time) the applicable DST savings (usually, but not necessarily, 1 hour).
Somewhere like Japan, where daylight time is not used. The useDaylightTime() and inDaylightTime(Date) methods both always return false, and the raw and actual offsets will always be the same.

Note the type returned by the factory methods getDefault() and getTimeZone(String) is implementation dependent. This may introduce serialization incompatibility issues between different implementations. Android returns instances of SimpleTimeZone so that the bytes serialized by Android can be deserialized successfully on other implementations, but the reverse compatibility cannot be guaranteed.

Summary

Constants
int	LONG	The long display name style, such as `Pacific Daylight Time`.
int	SHORT	The short display name style, such as `PDT`.

Public Constructors
	TimeZone()

Public Methods
Object	clone() Returns a new time zone with the same ID, raw offset, and daylight savings time rules as this time zone.
synchronized static String[]	getAvailableIDs() Returns the system's installed time zone IDs.
synchronized static String[]	getAvailableIDs(int offsetMillis) Returns the IDs of the time zones whose offset from UTC is `offsetMillis`.
int	getDSTSavings() Returns the daylight savings offset in milliseconds for this time zone.
synchronized static TimeZone	getDefault() Returns the user's preferred time zone.
final String	getDisplayName(Locale locale) Equivalent to `getDisplayName(false, TimeZone.LONG, locale)`.
String	getDisplayName(boolean daylightTime, int style, Locale locale) Returns the `short` or `long` name of this time zone with either standard or daylight time, as written in `locale`.
final String	getDisplayName() Equivalent to `getDisplayName(false, TimeZone.LONG, Locale.getDefault())`.
final String	getDisplayName(boolean daylightTime, int style) Equivalent to `getDisplayName(daylightTime, style, Locale.getDefault())`.
String	getID() Returns the ID of this `TimeZone`, such as `America/Los_Angeles`, `GMT-08:00` or `UTC`.
abstract int	getOffset(int era, int year, int month, int day, int dayOfWeek, int timeOfDayMillis) Returns this time zone's offset in milliseconds from UTC at the specified date and time.
int	getOffset(long time) Returns the offset in milliseconds from UTC for this time zone at `time`.
abstract int	getRawOffset() Returns the offset in milliseconds from UTC of this time zone's standard time.
synchronized static TimeZone	getTimeZone(String id) Returns a `TimeZone` suitable for `id`, or `GMT` on failure.
boolean	hasSameRules(TimeZone timeZone) Returns true if `timeZone` has the same rules as this time zone.
abstract boolean	inDaylightTime(Date time) Returns true if `time` is in a daylight savings time period for this time zone.
synchronized static void	setDefault(TimeZone timeZone) Overrides the default time zone for the current process only.
void	setID(String id) Sets the ID of this `TimeZone`.
abstract void	setRawOffset(int offsetMillis) Sets the offset in milliseconds from UTC of this time zone's standard time.
abstract boolean	useDaylightTime() Returns true if this time zone has a future transition to or from daylight savings time.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final int LONG

Since: API Level 1

The long display name style, such as Pacific Daylight Time. Requests for this style may yield GMT offsets like GMT-08:00.

Constant Value: 1 (0x00000001)

public static final int SHORT

Since: API Level 1

The short display name style, such as PDT. Requests for this style may yield GMT offsets like GMT-08:00.

Constant Value: 0 (0x00000000)

daylightTime	true for daylight time, false for standard time.
style	either `LONG` or `SHORT`.
locale	the display locale.

Interfaces

Classes

Enums

Exceptions

Errors

TimeZone

Class Overview

See Also

Summary

Constants

public static final int LONG

public static final int SHORT

Public Constructors

public TimeZone ()

Public Methods

public Object clone ()

Returns

public static synchronized String[] getAvailableIDs ()

public static synchronized String[] getAvailableIDs (int offsetMillis)

Returns

public int getDSTSavings ()

public static synchronized TimeZone getDefault ()

public final String getDisplayName (Locale locale)

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

Parameters

public final String getDisplayName ()

public final String getDisplayName (boolean daylightTime, int style)

public String getID ()

public abstract int getOffset (int era, int year, int month, int day, int dayOfWeek, int timeOfDayMillis)

public int getOffset (long time)

Parameters

public abstract int getRawOffset ()

public static synchronized TimeZone getTimeZone (String id)

public boolean hasSameRules (TimeZone timeZone)

public abstract boolean inDaylightTime (Date time)

public static synchronized void setDefault (TimeZone timeZone)

Parameters

public void setID (String id)

public abstract void setRawOffset (int offsetMillis)

public abstract boolean useDaylightTime ()