SimpleTimeZone
open class SimpleTimeZone : TimeZone
| kotlin.Any | ||
| ↳ | java.util.TimeZone | |
| ↳ | java.util.SimpleTimeZone | |
SimpleTimeZone is a concrete subclass of TimeZone that represents a time zone for use with a Gregorian calendar. The class holds an offset from GMT, called raw offset, and start and end rules for a daylight saving time schedule. Since it only holds single values for each, it cannot handle historical changes in the offset from GMT and the daylight saving schedule, except that the setStartYear method can specify the year when the daylight saving time schedule starts in effect.
To construct a SimpleTimeZone with a daylight saving time schedule, the schedule can be described with a set of rules, start-rule and end-rule. A day when daylight saving time starts or ends is specified by a combination of month, day-of-month, and day-of-week values. The month value is represented by a Calendar MONTH field value, such as Calendar.MARCH. The day-of-week value is represented by a Calendar DAY_OF_WEEK value, such as SUNDAY. The meanings of value combinations are as follows.
- Exact day of month
To specify an exact day of month, set the month and day-of-month to an exact value, and day-of-week to zero. For example, to specify March 1, set the month toMARCH, day-of-month to 1, and day-of-week to 0. - Day of week on or after day of month
To specify a day of week on or after an exact day of month, set the month to an exact month value, day-of-month to the day on or after which the rule is applied, and day-of-week to a negativeDAY_OF_WEEKfield value. For example, to specify the second Sunday of April, set month toAPRIL, day-of-month to 8, and day-of-week to-SUNDAY. - Day of week on or before day of month
To specify a day of the week on or before an exact day of the month, set day-of-month and day-of-week to a negative value. For example, to specify the last Wednesday on or before the 21st of March, set month toMARCH, day-of-month is -21 and day-of-week is-WEDNESDAY. - Last day-of-week of month
To specify, the last day-of-week of the month, set day-of-week to aDAY_OF_WEEKvalue and day-of-month to -1. For example, to specify the last Sunday of October, set month toOCTOBER, day-of-week toSUNDAYand day-of-month to -1.
WALL_TIME, STANDARD_TIME and UTC_TIME. For example, if daylight saving time ends at 2:00 am in the wall clock time, it can be specified by 7200000 milliseconds in the WALL_TIME mode. In this case, the wall clock time for an end-rule means the same thing as the daylight time.
The following are examples of parameters for constructing time zone objects.
<code> // Base GMT offset: -8:00 // DST starts: at 2:00am in standard time // on the first Sunday in April // DST ends: at 2:00am in daylight time // on the last Sunday in October // Save: 1 hour SimpleTimeZone(-28800000, "America/Los_Angeles", Calendar.APRIL, 1, -Calendar.SUNDAY, 7200000, Calendar.OCTOBER, -1, Calendar.SUNDAY, 7200000, 3600000) // Base GMT offset: +1:00 // DST starts: at 1:00am in UTC time // on the last Sunday in March // DST ends: at 1:00am in UTC time // on the last Sunday in October // Save: 1 hour SimpleTimeZone(3600000, "Europe/Paris", Calendar.MARCH, -1, Calendar.SUNDAY, 3600000, SimpleTimeZone.UTC_TIME, Calendar.OCTOBER, -1, Calendar.SUNDAY, 3600000, SimpleTimeZone.UTC_TIME, 3600000) </code>
setStartRule.
Summary
| Constants | |
|---|---|
| static Int |
Constant for a mode of start or end time specified as standard time. |
| static Int |
Constant for a mode of start or end time specified as UTC. |
| static Int |
Constant for a mode of start or end time specified as wall clock time. |
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
SimpleTimeZone(rawOffset: Int, ID: String!)Constructs a SimpleTimeZone with the given base time zone offset from GMT and time zone ID with no daylight saving time schedule. |
|
SimpleTimeZone(rawOffset: Int, ID: String!, startMonth: Int, startDay: Int, startDayOfWeek: Int, startTime: Int, endMonth: Int, endDay: Int, endDayOfWeek: Int, endTime: Int)Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. |
|
SimpleTimeZone(rawOffset: Int, ID: String!, startMonth: Int, startDay: Int, startDayOfWeek: Int, startTime: Int, endMonth: Int, endDay: Int, endDayOfWeek: Int, endTime: Int, dstSavings: Int)Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. |
|
SimpleTimeZone(rawOffset: Int, ID: String!, startMonth: Int, startDay: Int, startDayOfWeek: Int, startTime: Int, startTimeMode: Int, endMonth: Int, endDay: Int, endDayOfWeek: Int, endTime: Int, endTimeMode: Int, dstSavings: Int)Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. |
|
| Public methods | |
|---|---|
| open Any |
clone()Returns a clone of this |
| open Boolean |
Compares the equality of two |
| open Int |
Returns the amount of time in milliseconds that the clock is advanced during daylight saving time. |
| open Int |
Returns the difference in milliseconds between local time and UTC, taking into account both the raw offset and the effect of daylight saving, for the specified date and time. |
| open Int |
Returns the offset of this time zone from UTC at the given time. |
| open Int |
Gets the GMT offset for this time zone. |
| open Boolean |
hasSameRules(other: TimeZone!)Returns |
| open Int |
hashCode()Generates the hash code for the SimpleDateFormat object. |
| open Boolean |
inDaylightTime(date: Date!)Queries if the given date is in daylight saving time. |
| open Boolean |
Returns |
| open Unit |
setDSTSavings(millisSavedDuringDST: Int)Sets the amount of time in milliseconds that the clock is advanced during daylight saving time. |
| open Unit |
setEndRule(endMonth: Int, endDay: Int, endTime: Int)Sets the daylight saving time end rule to a fixed date within a month. |
| open Unit |
setEndRule(endMonth: Int, endDay: Int, endDayOfWeek: Int, endTime: Int)Sets the daylight saving time end rule. |
| open Unit |
Sets the daylight saving time end rule to a weekday before or after the given date within a month, e. |
| open Unit |
setRawOffset(offsetMillis: Int)Sets the base time zone offset to GMT. |
| open Unit |
setStartRule(startMonth: Int, startDay: Int, startTime: Int)Sets the daylight saving time start rule to a fixed date within a month. |
| open Unit |
setStartRule(startMonth: Int, startDay: Int, startDayOfWeek: Int, startTime: Int)Sets the daylight saving time start rule. |
| open Unit |
Sets the daylight saving time start rule to a weekday before or after the given date within a month, e. |
| open Unit |
setStartYear(year: Int)Sets the daylight saving time starting year. |
| open String |
toString()Returns a string representation of this time zone. |
| open Boolean |
Queries if this time zone uses daylight saving time. |
| Inherited functions | |
|---|---|
Constants
STANDARD_TIME
static val STANDARD_TIME: Int
Constant for a mode of start or end time specified as standard time.
Value: 1UTC_TIME
static val UTC_TIME: Int
Constant for a mode of start or end time specified as UTC. European Union rules are specified as UTC time, for example.
Value: 2WALL_TIME
static val WALL_TIME: Int
Constant for a mode of start or end time specified as wall clock time. Wall clock time is standard time for the onset rule, and daylight time for the end rule.
Value: 0Public constructors
SimpleTimeZone
SimpleTimeZone(
rawOffset: Int,
ID: String!)
Constructs a SimpleTimeZone with the given base time zone offset from GMT and time zone ID with no daylight saving time schedule.
| Parameters | |
|---|---|
rawOffset |
Int: The base time zone offset in milliseconds to GMT. |
ID |
String!: The time zone name that is given to this instance. |
SimpleTimeZone
SimpleTimeZone(
rawOffset: Int,
ID: String!,
startMonth: Int,
startDay: Int,
startDayOfWeek: Int,
startTime: Int,
endMonth: Int,
endDay: Int,
endDayOfWeek: Int,
endTime: Int)
Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. Both startTime and endTime are specified to be represented in the wall clock time. The amount of daylight saving is assumed to be 3600000 milliseconds (i.e., one hour). This constructor is equivalent to:
<code> SimpleTimeZone(rawOffset, ID, startMonth, startDay, startDayOfWeek, startTime, SimpleTimeZone.<code><a docref="java.util.SimpleTimeZone$WALL_TIME">#WALL_TIME</a></code>, endMonth, endDay, endDayOfWeek, endTime, SimpleTimeZone.<code><a docref="java.util.SimpleTimeZone$WALL_TIME">#WALL_TIME</a></code>, 3600000) </code>
| Parameters | |
|---|---|
rawOffset |
Int: The given base time zone offset from GMT. |
ID |
String!: The time zone ID which is given to this object. |
startMonth |
Int: The daylight saving time starting month. Month is a MONTH field value (0-based. e.g., 0 for January). |
startDay |
Int: The day of the month on which the daylight saving time starts. See the class description for the special cases of this parameter. |
startDayOfWeek |
Int: The daylight saving time starting day-of-week. See the class description for the special cases of this parameter. |
startTime |
Int: The daylight saving time starting time in local wall clock time (in milliseconds within the day), which is local standard time in this case. |
endMonth |
Int: The daylight saving time ending month. Month is a MONTH field value (0-based. e.g., 9 for October). |
endDay |
Int: The day of the month on which the daylight saving time ends. See the class description for the special cases of this parameter. |
endDayOfWeek |
Int: The daylight saving time ending day-of-week. See the class description for the special cases of this parameter. |
endTime |
Int: The daylight saving ending time in local wall clock time, (in milliseconds within the day) which is local daylight time in this case. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the month, day, dayOfWeek, or time parameters are out of range for the start or end rule |
SimpleTimeZone
SimpleTimeZone(
rawOffset: Int,
ID: String!,
startMonth: Int,
startDay: Int,
startDayOfWeek: Int,
startTime: Int,
endMonth: Int,
endDay: Int,
endDayOfWeek: Int,
endTime: Int,
dstSavings: Int)
Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. Both startTime and endTime are assumed to be represented in the wall clock time. This constructor is equivalent to:
<code> SimpleTimeZone(rawOffset, ID, startMonth, startDay, startDayOfWeek, startTime, SimpleTimeZone.<code><a docref="java.util.SimpleTimeZone$WALL_TIME">#WALL_TIME</a></code>, endMonth, endDay, endDayOfWeek, endTime, SimpleTimeZone.<code><a docref="java.util.SimpleTimeZone$WALL_TIME">#WALL_TIME</a></code>, dstSavings) </code>
| Parameters | |
|---|---|
rawOffset |
Int: The given base time zone offset from GMT. |
ID |
String!: The time zone ID which is given to this object. |
startMonth |
Int: The daylight saving time starting month. Month is a MONTH field value (0-based. e.g., 0 for January). |
startDay |
Int: The day of the month on which the daylight saving time starts. See the class description for the special cases of this parameter. |
startDayOfWeek |
Int: The daylight saving time starting day-of-week. See the class description for the special cases of this parameter. |
startTime |
Int: The daylight saving time starting time in local wall clock time, which is local standard time in this case. |
endMonth |
Int: The daylight saving time ending month. Month is a MONTH field value (0-based. e.g., 9 for October). |
endDay |
Int: The day of the month on which the daylight saving time ends. See the class description for the special cases of this parameter. |
endDayOfWeek |
Int: The daylight saving time ending day-of-week. See the class description for the special cases of this parameter. |
endTime |
Int: The daylight saving ending time in local wall clock time, which is local daylight time in this case. |
dstSavings |
Int: The amount of time in milliseconds saved during daylight saving time. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the month, day, dayOfWeek, or time parameters are out of range for the start or end rule |
SimpleTimeZone
SimpleTimeZone(
rawOffset: Int,
ID: String!,
startMonth: Int,
startDay: Int,
startDayOfWeek: Int,
startTime: Int,
startTimeMode: Int,
endMonth: Int,
endDay: Int,
endDayOfWeek: Int,
endTime: Int,
endTimeMode: Int,
dstSavings: Int)
Constructs a SimpleTimeZone with the given base time zone offset from GMT, time zone ID, and rules for starting and ending the daylight time. This constructor takes the full set of the start and end rules parameters, including modes of startTime and endTime. The mode specifies either wall or standard time or UTC.
| Parameters | |
|---|---|
rawOffset |
Int: The given base time zone offset from GMT. |
ID |
String!: The time zone ID which is given to this object. |
startMonth |
Int: The daylight saving time starting month. Month is a MONTH field value (0-based. e.g., 0 for January). |
startDay |
Int: The day of the month on which the daylight saving time starts. See the class description for the special cases of this parameter. |
startDayOfWeek |
Int: The daylight saving time starting day-of-week. See the class description for the special cases of this parameter. |
startTime |
Int: The daylight saving time starting time in the time mode specified by startTimeMode. |
startTimeMode |
Int: The mode of the start time specified by startTime. |
endMonth |
Int: The daylight saving time ending month. Month is a MONTH field value (0-based. e.g., 9 for October). |
endDay |
Int: The day of the month on which the daylight saving time ends. See the class description for the special cases of this parameter. |
endDayOfWeek |
Int: The daylight saving time ending day-of-week. See the class description for the special cases of this parameter. |
endTime |
Int: The daylight saving ending time in time mode specified by endTimeMode. |
endTimeMode |
Int: The mode of the end time specified by endTime |
dstSavings |
Int: The amount of time in milliseconds saved during daylight saving time. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the month, day, dayOfWeek, time more, or time parameters are out of range for the start or end rule, or if a time mode value is invalid. |
See Also
Public methods
clone
open fun clone(): Any
Returns a clone of this SimpleTimeZone instance.
| Return | |
|---|---|
Any |
a clone of this instance. |
| Exceptions | |
|---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can |