Since: API Level 1

public class

SimpleTimeZone

extends TimeZone

java.lang.Object
↳	java.util.TimeZone
	↳	java.util.SimpleTimeZone

Class Overview

SimpleTimeZone is a concrete subclass of TimeZone that represents a time zone for use with a Gregorian calendar. This class does not handle historical changes.

Use a negative value for dayOfWeekInMonth to indicate that SimpleTimeZone should count from the end of the month backwards. For example, Daylight Savings Time ends at the last (dayOfWeekInMonth = -1) Sunday in October, at 2 AM in standard time.

Summary

Constants
int	STANDARD_TIME	The constant for representing a start or end time in standard local time mode, based on timezone's raw offset from GMT; does not include Daylight savings.
int	UTC_TIME	The constant for representing a start or end time in GMT time mode.
int	WALL_TIME	The constant for representing a start or end time in local wall clock time mode, based on timezone's adjusted offset from GMT; includes Daylight savings.

[Expand]

Inherited Constants

From class java.util.TimeZone

Public Constructors
	SimpleTimeZone(int offset, String name) Constructs a `SimpleTimeZone` with the given base time zone offset from GMT and time zone ID.
	SimpleTimeZone(int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime) Constructs a `SimpleTimeZone` with the given base time zone offset from GMT, time zone ID, and times to start and end the daylight savings time.
	SimpleTimeZone(int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime, int daylightSavings) Constructs a `SimpleTimeZone` with the given base time zone offset from GMT, time zone ID, times to start and end the daylight savings time, and the daylight savings time difference in milliseconds.
	SimpleTimeZone(int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int startTimeMode, int endMonth, int endDay, int endDayOfWeek, int endTime, int endTimeMode, int daylightSavings) Construct a `SimpleTimeZone` with the given base time zone offset from GMT, time zone ID, times to start and end the daylight savings time including a mode specifier, the daylight savings time difference in milliseconds.

Public Methods
Object	clone() Returns a new `SimpleTimeZone` with the same ID, `rawOffset` and daylight savings time rules as this SimpleTimeZone.
boolean	equals(Object object) Compares the specified object to this `SimpleTimeZone` and returns whether they are equal.
int	getDSTSavings() Returns the daylight savings offset in milliseconds for this time zone.
int	getOffset(int era, int year, int month, int day, int dayOfWeek, int time) 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`.
int	getRawOffset() Returns the offset in milliseconds from UTC of this time zone's standard time.
boolean	hasSameRules(TimeZone zone) Returns true if `timeZone` has the same rules as this time zone.
synchronized int	hashCode() Returns an integer hash code for the receiver.
boolean	inDaylightTime(Date time) Returns true if `time` is in a daylight savings time period for this time zone.
void	setDSTSavings(int milliseconds) Sets the daylight savings offset in milliseconds for this `SimpleTimeZone`.
void	setEndRule(int month, int day, int dayOfWeek, int time) Sets the rule which specifies the end of daylight savings time.
void	setEndRule(int month, int dayOfMonth, int time) Sets the rule which specifies the end of daylight savings time.
void	setEndRule(int month, int day, int dayOfWeek, int time, boolean after) Sets the rule which specifies the end of daylight savings time.
void	setRawOffset(int offset) Sets the offset for standard time from GMT for this `SimpleTimeZone`.
void	setStartRule(int month, int day, int dayOfWeek, int time, boolean after) Sets the rule which specifies the start of daylight savings time.
void	setStartRule(int month, int dayOfMonth, int time) Sets the rule which specifies the start of daylight savings time.
void	setStartRule(int month, int day, int dayOfWeek, int time) Sets the rule which specifies the start of daylight savings time.
void	setStartYear(int year) Sets the starting year for daylight savings time in this `SimpleTimeZone`.
String	toString() Returns the string representation of this `SimpleTimeZone`.
boolean	useDaylightTime() Returns true if this time zone has a daylight savings time period.

[Expand]

Inherited Methods

From class java.util.TimeZone

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 daylight savings time period.

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() Called before the object's memory is reclaimed by the VM.
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 STANDARD_TIME

Since: API Level 1

The constant for representing a start or end time in standard local time mode, based on timezone's raw offset from GMT; does not include Daylight savings.

Constant Value: 1 (0x00000001)

public static final int UTC_TIME

Since: API Level 1

The constant for representing a start or end time in GMT time mode.

Constant Value: 2 (0x00000002)

public static final int WALL_TIME

Since: API Level 1

The constant for representing a start or end time in local wall clock time mode, based on timezone's adjusted offset from GMT; includes Daylight savings.

Constant Value: 0 (0x00000000)

Public Constructors

public SimpleTimeZone (int offset, String name)

Since: API Level 1

Constructs a SimpleTimeZone with the given base time zone offset from GMT and time zone ID. Timezone IDs can be obtained from TimeZone.getAvailableIDs. Normally you should use TimeZone.getDefault to construct a TimeZone.

Parameters

offset	the given base time zone offset to GMT.
name	the time zone ID which is obtained from `TimeZone.getAvailableIDs`.

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime)

Since: API Level 1

Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and times to start and end the daylight savings time. Timezone IDs can be obtained from TimeZone.getAvailableIDs. Normally you should use TimeZone.getDefault to create a TimeZone. For a time zone that does not use daylight saving time, do not use this constructor; instead you should use SimpleTimeZone(rawOffset, ID).

By default, this constructor specifies day-of-week-in-month rules. That is, if the startDay is 1, and the startDayOfWeek is SUNDAY, then this indicates the first Sunday in the startMonth. A startDay of -1 likewise indicates the last Sunday. However, by using negative or zero values for certain parameters, other types of rules can be specified.

Day of month: To specify an exact day of the month, such as March 1, set startDayOfWeek to zero.

Day of week after day of month: To specify the first day of the week occurring on or after an exact day of the month, make the day of the week negative. For example, if startDay is 5 and startDayOfWeek is -MONDAY, this indicates the first Monday on or after the 5th day of the startMonth.

Day of week before day of month: To specify the last day of the week occurring on or before an exact day of the month, make the day of the week and the day of the month negative. For example, if startDay is -21 and startDayOfWeek is -WEDNESDAY, this indicates the last Wednesday on or before the 21st of the startMonth.

The above examples refer to the startMonth, startDay, and startDayOfWeek; the same applies for the endMonth, endDay, and endDayOfWeek.

The daylight savings time difference is set to the default value: one hour.

Parameters

offset	the given base time zone offset to GMT.
name	the time zone ID which is obtained from `TimeZone.getAvailableIDs`.
startMonth	the daylight savings starting month. The month indexing is 0-based. eg, 0 for January.
startDay	the daylight savings starting day-of-week-in-month. Please see the member description for an example.
startDayOfWeek	the daylight savings starting day-of-week. Please see the member description for an example.
startTime	the daylight savings starting time in local wall time, which is standard time in this case. Please see the member description for an example.
endMonth	the daylight savings ending month. The month indexing is 0-based. eg, 0 for January.
endDay	the daylight savings ending day-of-week-in-month. Please see the member description for an example.
endDayOfWeek	the daylight savings ending day-of-week. Please see the member description for an example.
endTime	the daylight savings ending time in local wall time, which is daylight time in this case. Please see the member description for an example.

Throws

IllegalArgumentException	if the month, day, dayOfWeek, or time parameters are out of range for the start or end rule.

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime, int daylightSavings)

Since: API Level 1

Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, times to start and end the daylight savings time, and the daylight savings time difference in milliseconds.

Parameters

offset	the given base time zone offset to GMT.
name	the time zone ID which is obtained from `TimeZone.getAvailableIDs`.
startMonth	the daylight savings starting month. Month is 0-based. eg, 0 for January.
startDay	the daylight savings starting day-of-week-in-month. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
startDayOfWeek	the daylight savings starting day-of-week. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
startTime	The daylight savings starting time in local wall time, which is standard time in this case. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
endMonth	the daylight savings ending month. Month is 0-based. eg, 0 for January.
endDay	the daylight savings ending day-of-week-in-month. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
endDayOfWeek	the daylight savings ending day-of-week. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
endTime	the daylight savings ending time in local wall time, which is daylight time in this case. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
daylightSavings	the daylight savings time difference in milliseconds.

Throws

IllegalArgumentException	if the month, day, dayOfWeek, or time parameters are out of range for the start or end rule.

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int startTimeMode, int endMonth, int endDay, int endDayOfWeek, int endTime, int endTimeMode, int daylightSavings)

Since: API Level 1

Construct a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, times to start and end the daylight savings time including a mode specifier, the daylight savings time difference in milliseconds. The mode specifies either WALL_TIME, STANDARD_TIME, or UTC_TIME.

Parameters

offset	the given base time zone offset to GMT.
name	the time zone ID which is obtained from `TimeZone.getAvailableIDs`.
startMonth	the daylight savings starting month. The month indexing is 0-based. eg, 0 for January.
startDay	the daylight savings starting day-of-week-in-month. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
startDayOfWeek	the daylight savings starting day-of-week. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
startTime	the time of day in milliseconds on which daylight savings time starts, based on the `startTimeMode`.
startTimeMode	the mode (UTC, standard, or wall time) of the start time value.
endMonth	the daylight savings ending month. The month indexing is 0-based. eg, 0 for January.
endDay	the day of the week on which daylight savings time ends.
endDayOfWeek	the daylight savings ending day-of-week. Please see the description of `SimpleTimeZone(int, String, int, int, int, int, int, int, int, int)` for an example.
endTime	the time of day in milliseconds on which daylight savings time ends, based on the `endTimeMode`.
endTimeMode	the mode (UTC, standard, or wall time) of the end time value.
daylightSavings	the daylight savings time difference in milliseconds.

Throws

IllegalArgumentException	if the month, day, dayOfWeek, or time parameters are out of range for the start or end rule.

Public Methods

public Object clone ()

Since: API Level 1

Returns a new SimpleTimeZone with the same ID, rawOffset and daylight savings time rules as this SimpleTimeZone.

Returns

a shallow copy of this SimpleTimeZone.

public boolean equals (Object object)

Since: API Level 1

Compares the specified object to this SimpleTimeZone and returns whether they are equal. The object must be an instance of SimpleTimeZone and have the same internal data.

Parameters

object	the object to compare with this object.

Returns

true if the specified object is equal to this SimpleTimeZone, false otherwise.

public int getDSTSavings ()

Since: API Level 1

Returns the daylight savings offset in milliseconds for this time zone. The base implementation returns 3600000 (1 hour) for time zones that use daylight savings time and 0 for timezones that do not. Subclasses should override this method for other daylight savings offsets.

Note that this method doesn't tell you whether or not to apply the offset: you need to call inDaylightTime for the specific time you're interested in. If this method returns a non-zero offset, that only tells you that this TimeZone sometimes observes daylight savings.

public int getOffset (int era, int year, int month, int day, int dayOfWeek, int time)

Since: API Level 1

Returns this time zone's offset in milliseconds from UTC at the specified date and time. The offset includes daylight savings time if the date and time is within the daylight savings time period.

This method is intended to be used by Calendar to compute DST_OFFSET and ZONE_OFFSET. Application code should have no reason to call this method directly. Each parameter is interpreted in the same way as the corresponding Calendar field. Refer to Calendar for specific definitions of this method's parameters.

public int getOffset (long time)

Since: API Level 1

Returns the offset in milliseconds from UTC for this time zone at time. The offset includes daylight savings time if the specified date is within the daylight savings time period.

Parameters

time	the date in milliseconds since January 1, 1970 00:00:00 UTC

public int getRawOffset ()

Since: API Level 1

Returns the offset in milliseconds from UTC of this time zone's standard time.

public boolean hasSameRules (TimeZone zone)

Since: API Level 1

Returns true if timeZone has the same rules as this time zone.

The base implementation returns true if both time zones have the same raw offset.

public synchronized int hashCode ()

Since: API Level 1

Returns an integer hash code for the receiver. Objects which are equal return the same value for this method.

Returns

the receiver's hash.

public boolean inDaylightTime (Date time)

Since: API Level 1

Returns true if time is in a daylight savings time period for this time zone.

public void setDSTSavings (int milliseconds)

Since: API Level 1

Sets the daylight savings offset in milliseconds for this SimpleTimeZone.

Parameters

milliseconds	the daylight savings offset in milliseconds.

public void setEndRule (int month, int day, int dayOfWeek, int time)

Since: API Level 1

Sets the rule which specifies the end of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time ends.
day	the occurrence of the day of the week on which daylight savings time ends.
dayOfWeek	the `Calendar` day of the week on which daylight savings time ends.
time	the time of day in milliseconds standard time on which daylight savings time ends.

public void setEndRule (int month, int dayOfMonth, int time)

Since: API Level 1

Sets the rule which specifies the end of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time ends.
dayOfMonth	the `Calendar` day of the month on which daylight savings time ends.
time	the time of day in milliseconds standard time on which daylight savings time ends.

public void setEndRule (int month, int day, int dayOfWeek, int time, boolean after)

Since: API Level 1

Sets the rule which specifies the end of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time ends.
day	the `Calendar` day of the month.
dayOfWeek	the `Calendar` day of the week on which daylight savings time ends.
time	the time of day in milliseconds on which daylight savings time ends.
after	selects the day after or before the day of month.

public void setRawOffset (int offset)

Since: API Level 1

Sets the offset for standard time from GMT for this SimpleTimeZone.

Parameters

offset	the offset from GMT of standard time in milliseconds.

public void setStartRule (int month, int day, int dayOfWeek, int time, boolean after)

Since: API Level 1

Sets the rule which specifies the start of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time starts.
day	the `Calendar` day of the month.
dayOfWeek	the `Calendar` day of the week on which daylight savings time starts.
time	the time of day in milliseconds on which daylight savings time starts.
after	selects the day after or before the day of month.

public void setStartRule (int month, int dayOfMonth, int time)

Since: API Level 1

Sets the rule which specifies the start of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time starts.
dayOfMonth	the `Calendar` day of the month on which daylight savings time starts.
time	the time of day in milliseconds on which daylight savings time starts.

public void setStartRule (int month, int day, int dayOfWeek, int time)

Since: API Level 1

Sets the rule which specifies the start of daylight savings time.

Parameters

month	the `Calendar` month in which daylight savings time starts.
day	the occurrence of the day of the week on which daylight savings time starts.
dayOfWeek	the `Calendar` day of the week on which daylight savings time starts.
time	the time of day in milliseconds on which daylight savings time starts.

public void setStartYear (int year)

Since: API Level 1

Sets the starting year for daylight savings time in this SimpleTimeZone. Years before this start year will always be in standard time.

Parameters

year	the starting year.

public String toString ()

Since: API Level 1

Returns the string representation of this SimpleTimeZone.

Returns

the string representation of this SimpleTimeZone.

public boolean useDaylightTime ()

Since: API Level 1

Returns true if this time zone has a daylight savings time period. More specifically, this method returns true to indicate that there's at least one known future transition to or from daylight savings. This means that, say, Taiwan will return false because its historical use of daylight savings doesn't count. A hypothetical country that has never observed daylight savings before but plans to start next year would return true.

If this method returns true, that only tells you that this TimeZone sometimes observes daylight savings. You need to call inDaylightTime to find out whether daylight savings is in effect.

Interfaces

Classes

Enums

Exceptions

Errors

SimpleTimeZone

Class Overview

See Also

Summary

Constants

public static final int STANDARD_TIME

public static final int UTC_TIME

public static final int WALL_TIME

Public Constructors

public SimpleTimeZone (int offset, String name)

Parameters

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime)

Parameters

Throws

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime, int daylightSavings)

Parameters

Throws

public SimpleTimeZone (int offset, String name, int startMonth, int startDay, int startDayOfWeek, int startTime, int startTimeMode, int endMonth, int endDay, int endDayOfWeek, int endTime, int endTimeMode, int daylightSavings)

Parameters

Throws

Public Methods

public Object clone ()

Returns

See Also

public boolean equals (Object object)

Parameters

Returns

See Also

public int getDSTSavings ()

public int getOffset (int era, int year, int month, int day, int dayOfWeek, int time)

public int getOffset (long time)

Parameters

public int getRawOffset ()

public boolean hasSameRules (TimeZone zone)

public synchronized int hashCode ()

Returns

See Also

public boolean inDaylightTime (Date time)

public void setDSTSavings (int milliseconds)

Parameters

public void setEndRule (int month, int day, int dayOfWeek, int time)

Parameters

public void setEndRule (int month, int dayOfMonth, int time)

Parameters

public void setEndRule (int month, int day, int dayOfWeek, int time, boolean after)

Parameters

public void setRawOffset (int offset)

Parameters

public void setStartRule (int month, int day, int dayOfWeek, int time, boolean after)

Parameters

public void setStartRule (int month, int dayOfMonth, int time)

Parameters

public void setStartRule (int month, int day, int dayOfWeek, int time)

Parameters

public void setStartYear (int year)

Parameters

public String toString ()

Returns

public boolean useDaylightTime ()