com.ibm.icu.util
Class SimpleTimeZone

java.lang.Object
  extended bycom.ibm.icu.util.TimeZone
      extended bycom.ibm.icu.impl.JDKTimeZone
          extended bycom.ibm.icu.util.SimpleTimeZone
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SimpleTimeZone
extends com.ibm.icu.impl.JDKTimeZone

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.

Author:
David Goldsmith, Mark Davis, Chen-Lieh Huang, Alan Liu
See Also:
Calendar, GregorianCalendar, TimeZone, Serialized Form
Status:
Stable ICU 2.0.

Field Summary
 
Fields inherited from class com.ibm.icu.impl.JDKTimeZone
zone
 
Fields inherited from class com.ibm.icu.util.TimeZone
LONG, MILLIS_PER_DAY, MILLIS_PER_HOUR, SHORT
 
Constructor Summary
SimpleTimeZone(int rawOffset, java.lang.String ID)
          Constructs a SimpleTimeZone with the given base time zone offset from GMT and time zone ID.
SimpleTimeZone(int rawOffset, java.lang.String ID, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime)
          Construct a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, time to start and end the daylight time.
SimpleTimeZone(int rawOffset, java.lang.String ID, int startMonth, int startDay, int startDayOfWeek, int startTime, int endMonth, int endDay, int endDayOfWeek, int endTime, int dstSavings)
          Constructor.
SimpleTimeZone(int raw, java.lang.String ID, int startMonth, int startDay, int startDayOfWeek, int startTime, int startTimeMode, int endMonth, int endDay, int endDayOfWeek, int endTime, int endTimeMode, int dst)
           
SimpleTimeZone(java.util.SimpleTimeZone tz, java.lang.String ID)
          Constructs a SimpleTimeZone that wraps the given java.util.SimpleTimeZone.
 
Method Summary
 java.lang.Object clone()
          Return a clone of this time zone.
 boolean equals(java.lang.Object obj)
          Return true if obj is a SimpleTimeZone equivalent to this.
 int getDSTSavings()
          Returns the amount of time in ms that the clock is advanced during DST.
 int getOffset(int era, int year, int month, int day, int dayOfWeek, int millis)
          TimeZone API; calls through to wrapped time zone.
 int getOffset(int era, int year, int month, int day, int dayOfWeek, int millis, int monthLength)
           
 int getRawOffset()
          get the raw offset.
 int hashCode()
          Return the hash code.
 boolean hasSameRules(TimeZone othr)
          TimeZone API.
 boolean inDaylightTime(java.util.Date date)
          TimeZone API; calls through to wrapped time zone.
 void setDSTSavings(int millisSavedDuringDST)
          Sets the amount of time in ms that the clock is advanced during DST.
 void setEndRule(int month, int dayOfMonth, int time)
          Sets the DST end rule to a fixed date within a month.
 void setEndRule(int month, int dayOfWeekInMonth, int dayOfWeek, int time)
          Sets the daylight savings ending rule.
 void setEndRule(int month, int dayOfMonth, int dayOfWeek, int time, boolean after)
          Sets the DST end rule to a weekday before or after a give date within a month, e.g., the first Monday on or after the 8th.
 void setRawOffset(int offsetMillis)
          Set the raw offset.
 void setStartRule(int month, int dayOfMonth, int time)
          Sets the DST start rule to a fixed date within a month.
 void setStartRule(int month, int dayOfWeekInMonth, int dayOfWeek, int time)
          Sets the daylight savings starting rule.
 void setStartRule(int month, int dayOfMonth, int dayOfWeek, int time, boolean after)
          Sets the DST start rule to a weekday before or after a give date within a month, e.g., the first Monday on or after the 8th.
 void setStartYear(int year)
          Sets the daylight savings starting year.
 java.lang.String toString()
          Returns a string representation of this object.
 boolean useDaylightTime()
          TimeZone API; calls through to wrapped time zone.
 
Methods inherited from class com.ibm.icu.impl.JDKTimeZone
getOffset, setID, wrap
 
Methods inherited from class com.ibm.icu.util.TimeZone
countEquivalentIDs, getAvailableIDs, getAvailableIDs, getAvailableIDs, getDefault, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getEquivalentID, getID, getOffset, getTimeZone, setDefault
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimpleTimeZone

public SimpleTimeZone(int rawOffset,
                      java.lang.String ID)
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:
rawOffset - The given base time zone offset to GMT.
ID - The time zone ID which is obtained from TimeZone.getAvailableIDs.
Status:
Stable ICU 2.0.

SimpleTimeZone

public SimpleTimeZone(int rawOffset,
                      java.lang.String ID,
                      int startMonth,
                      int startDay,
                      int startDayOfWeek,
                      int startTime,
                      int endMonth,
                      int endDay,
                      int endDayOfWeek,
                      int endTime)
Construct a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, time to start and end the daylight 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.

Parameters:
rawOffset - The given base time zone offset to GMT.
ID - 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 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. Month 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:
java.lang.IllegalArgumentException - the month, day, dayOfWeek, or time parameters are out of range for the start or end rule
Status:
Stable ICU 2.0.

SimpleTimeZone

public SimpleTimeZone(int rawOffset,
                      java.lang.String ID,
                      int startMonth,
                      int startDay,
                      int startDayOfWeek,
                      int startTime,
                      int endMonth,
                      int endDay,
                      int endDayOfWeek,
                      int endTime,
                      int dstSavings)
Constructor. This constructor is identical to the 10-argument constructor, but also takes a dstSavings parameter.

Parameters:
dstSavings - The amount of time in ms saved during DST.
Throws:
java.lang.IllegalArgumentException - the month, day, dayOfWeek, or time parameters are out of range for the start or end rule
Status:
Stable ICU 2.0.

SimpleTimeZone

public SimpleTimeZone(java.util.SimpleTimeZone tz,
                      java.lang.String ID)
Constructs a SimpleTimeZone that wraps the given java.util.SimpleTimeZone. Do not call; use the TimeZone API.

Status:
Internal. This API is ICU internal only.

SimpleTimeZone

public SimpleTimeZone(int raw,
                      java.lang.String ID,
                      int startMonth,
                      int startDay,
                      int startDayOfWeek,
                      int startTime,
                      int startTimeMode,
                      int endMonth,
                      int endDay,
                      int endDayOfWeek,
                      int endTime,
                      int endTimeMode,
                      int dst)
Status:
Internal. This API is ICU internal only.
Method Detail

setRawOffset

public void setRawOffset(int offsetMillis)
Set the raw offset.

Parameters:
offsetMillis - the raw offset of the time zone
Status:
Draft ICU 3.4.

getRawOffset

public int getRawOffset()
get the raw offset.

Returns:
the raw offset
Status:
Internal. This API is ICU internal only.

setStartYear

public void setStartYear(int year)
Sets the daylight savings starting year.

Parameters:
year - The daylight savings starting year.
Status:
Stable ICU 2.0.

setStartRule

public void setStartRule(int month,
                         int dayOfWeekInMonth,
                         int dayOfWeek,
                         int time)
Sets the daylight savings starting rule. For example, Daylight Savings Time starts at the first Sunday in April, at 2 AM in standard time. Therefore, you can set the start rule by calling: setStartRule(TimeFields.APRIL, 1, TimeFields.SUNDAY, 2*60*60*1000);

Parameters:
month - The daylight savings starting month. Month is 0-based. eg, 0 for January.
dayOfWeekInMonth - The daylight savings starting day-of-week-in-month. Please see the member description for an example.
dayOfWeek - The daylight savings starting day-of-week. Please see the member description for an example.
time - The daylight savings starting time in local wall time, which is standard time in this case. Please see the member description for an example.
Throws:
java.lang.IllegalArgumentException - the month, dayOfWeekInMonth, dayOfWeek, or time parameters are out of range
Status:
Stable ICU 2.0.

setStartRule

public void setStartRule(int month,
                         int dayOfMonth,
                         int time)
Sets the DST start rule to a fixed date within a month.

Parameters:
month - The month in which this rule occurs (0-based).
dayOfMonth - The date in that month (1-based).
time - The time of that day (number of millis after midnight) when DST takes effect in local wall time, which is standard time in this case.
Throws:
java.lang.IllegalArgumentException - the month, dayOfMonth, or time parameters are out of range
Status:
Stable ICU 2.0.

setStartRule

public void setStartRule(int month,
                         int dayOfMonth,
                         int dayOfWeek,
                         int time,
                         boolean after)
Sets the DST start rule to a weekday before or after a give date within a month, e.g., the first Monday on or after the 8th.

Parameters:
month - The month in which this rule occurs (0-based).
dayOfMonth - A date within that month (1-based).
dayOfWeek - The day of the week on which this rule occurs.
time - The time of that day (number of millis after midnight) when DST takes effect in local wall time, which is standard time in this case.
after - If true, this rule selects the first dayOfWeek on or after dayOfMonth. If false, this rule selects the last dayOfWeek on or before dayOfMonth.
Throws:
java.lang.IllegalArgumentException - the month, dayOfMonth, dayOfWeek, or time parameters are out of range
Status:
Stable ICU 2.0.

setEndRule

public void setEndRule(int month,
                       int dayOfWeekInMonth,
                       int dayOfWeek,
                       int time)
Sets the daylight savings ending rule. For example, Daylight Savings Time ends at the last (-1) Sunday in October, at 2 AM in standard time. Therefore, you can set the end rule by calling: setEndRule(TimeFields.OCTOBER, -1, TimeFields.SUNDAY, 2*60*60*1000);

Parameters:
month - The daylight savings ending month. Month is 0-based. eg, 0 for January.
dayOfWeekInMonth - The daylight savings ending day-of-week-in-month. Please see the member description for an example.
dayOfWeek - The daylight savings ending day-of-week. Please see the member description for an example.
time - 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:
java.lang.IllegalArgumentException - the month, dayOfWeekInMonth, dayOfWeek, or time parameters are out of range
Status:
Stable ICU 2.0.

setEndRule

public void setEndRule(int month,
                       int dayOfMonth,
                       int time)
Sets the DST end rule to a fixed date within a month.

Parameters:
month - The month in which this rule occurs (0-based).
dayOfMonth - The date in that month (1-based).
time - The time of that day (number of millis after midnight) when DST ends in local wall time, which is daylight time in this case.
Throws:
java.lang.IllegalArgumentException - the month, dayOfMonth, or time parameters are out of range
Status:
Stable ICU 2.0.

setEndRule

public void setEndRule(int month,
                       int dayOfMonth,
                       int dayOfWeek,
                       int time,
                       boolean after)
Sets the DST end rule to a weekday before or after a give date within a month, e.g., the first Monday on or after the 8th.

Parameters:
month - The month in which this rule occurs (0-based).
dayOfMonth - A date within that month (1-based).
dayOfWeek - The day of the week on which this rule occurs.
time - The time of that day (number of millis after midnight) when DST ends in local wall time, which is daylight time in this case.
after - If true, this rule selects the first dayOfWeek on or after dayOfMonth. If false, this rule selects the last dayOfWeek on or before dayOfMonth.
Throws:
java.lang.IllegalArgumentException - the month, dayOfMonth, dayOfWeek, or time parameters are out of range
Status:
Stable ICU 2.0.

setDSTSavings

public void setDSTSavings(int millisSavedDuringDST)
Sets the amount of time in ms that the clock is advanced during DST.

Parameters:
millisSavedDuringDST - the number of milliseconds the time is advanced with respect to standard time when the daylight savings rules are in effect. A positive number, typically one hour (3600000).
Status:
Stable ICU 2.0.

getDSTSavings

public int getDSTSavings()
Returns the amount of time in ms that the clock is advanced during DST.

Returns:
the number of milliseconds the time is advanced with respect to standard time when the daylight savings rules are in effect. A positive number, typically one hour (3600000).
Status:
Stable ICU 2.0.

toString

public java.lang.String toString()
Returns a string representation of this object.

Returns:
a string representation of this object
Status:
Draft ICU 3.4.2.

getOffset

public int getOffset(int era,
                     int year,
                     int month,
                     int day,
                     int dayOfWeek,
                     int millis)
Description copied from class: com.ibm.icu.impl.JDKTimeZone
TimeZone API; calls through to wrapped time zone.

Status:
Internal. This API is ICU internal only.

getOffset

public int getOffset(int era,
                     int year,
                     int month,
                     int day,
                     int dayOfWeek,
                     int millis,
                     int monthLength)
Status:
Internal. This API is ICU internal only.

useDaylightTime

public boolean useDaylightTime()
Description copied from class: com.ibm.icu.impl.JDKTimeZone
TimeZone API; calls through to wrapped time zone.

Status:
Internal. This API is ICU internal only.

inDaylightTime

public boolean inDaylightTime(java.util.Date date)
Description copied from class: com.ibm.icu.impl.JDKTimeZone
TimeZone API; calls through to wrapped time zone.

Status:
Internal. This API is ICU internal only.

equals

public boolean equals(java.lang.Object obj)
Return true if obj is a SimpleTimeZone equivalent to this.

Returns:
true if obj is a SimpleTimeZone equivalent to this
Status:
Draft ICU 3.4.2.

hashCode

public int hashCode()
Return the hash code.

Returns:
the hash code
Status:
Draft ICU 3.4.2.

clone

public java.lang.Object clone()
Return a clone of this time zone.

Returns:
a clone of this time zone
Status:
Draft ICU 3.4.2.

hasSameRules

public boolean hasSameRules(TimeZone othr)
Description copied from class: com.ibm.icu.impl.JDKTimeZone
TimeZone API.

Status:
Internal. This API is ICU internal only.


Copyright (c) 2006 IBM Corporation and others.