SimpleTimeZone

STANDARD_TIME

static val STANDARD_TIME: Int

Constant for a mode of start or end time specified as standard time.

Value: 1

UTC_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: 2

WALL_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: 0

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.

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>

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>

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.

clone

open fun clone(): Any

Returns a clone of this SimpleTimeZone instance.

equals

open fun equals(other: Any?): Boolean

Compares the equality of two SimpleTimeZone objects.

getDSTSavings

open fun getDSTSavings(): Int

Returns the amount of time in milliseconds that the clock is advanced during daylight saving time.

getOffset

open fun getOffset(date: Long): Int

Returns the offset of this time zone from UTC at the given time. If daylight saving time is in effect at the given time, the offset value is adjusted with the amount of daylight saving.

getOffset

open fun getOffset(
    era: Int, 
    year: Int, 
    month: Int, 
    day: Int, 
    dayOfWeek: Int, 
    millis: Int
): 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. This method assumes that the start and end month are distinct. It also uses a default GregorianCalendar object as its underlying calendar, such as for determining leap years. Do not use the result of this method with a calendar other than a default GregorianCalendar.

Note: In general, clients should use Calendar.get(ZONE_OFFSET) + Calendar.get(DST_OFFSET) instead of calling this method.

getRawOffset

open fun getRawOffset(): Int

Gets the GMT offset for this time zone.

hasSameRules

open fun hasSameRules(other: TimeZone!): Boolean

Returns true if this zone has the same rules and offset as another zone.

hashCode

open fun hashCode(): Int

Generates the hash code for the SimpleDateFormat object.

inDaylightTime

open fun inDaylightTime(date: Date!): Boolean

Queries if the given date is in daylight saving time.

observesDaylightTime

open fun observesDaylightTime(): Boolean

Returns true if this SimpleTimeZone observes Daylight Saving Time. This method is equivalent to useDaylightTime().

setDSTSavings

open fun setDSTSavings(millisSavedDuringDST: Int): Unit

Sets the amount of time in milliseconds that the clock is advanced during daylight saving time.

setEndRule

open fun setEndRule(
    endMonth: Int, 
    endDay: Int, 
    endDayOfWeek: Int, 
    endTime: Int
): Unit

Sets the daylight saving time end rule. For example, if daylight saving time ends on the last Sunday in October at 2 am in wall clock time, you can set the end rule by calling: setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2*60*60*1000);

setEndRule

open fun setEndRule(
    endMonth: Int, 
    endDay: Int, 
    endTime: Int
): Unit

Sets the daylight saving time end rule to a fixed date within a month. This method is equivalent to:

<code>setEndRule(endMonth, endDay, 0, endTime)</code>

setEndRule

open fun setEndRule(
    endMonth: Int, 
    endDay: Int, 
    endDayOfWeek: Int, 
    endTime: Int, 
    after: Boolean
): Unit

Sets the daylight saving time end rule to a weekday before or after the given date within a month, e.g., the first Monday on or after the 8th.

setRawOffset

open fun setRawOffset(offsetMillis: Int): Unit

Sets the base time zone offset to GMT. This is the offset to add to UTC to get local time.

setStartRule

open fun setStartRule(
    startMonth: Int, 
    startDay: Int, 
    startDayOfWeek: Int, 
    startTime: Int
): Unit

Sets the daylight saving time start rule. For example, if daylight saving time starts on the first Sunday in April at 2 am in local wall clock time, you can set the start rule by calling:

<code>setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2*60*60*1000);</code>

setStartRule

open fun setStartRule(
    startMonth: Int, 
    startDay: Int, 
    startTime: Int
): Unit

Sets the daylight saving time start rule to a fixed date within a month. This method is equivalent to:

<code>setStartRule(startMonth, startDay, 0, startTime)</code>

setStartRule

open fun setStartRule(
    startMonth: Int, 
    startDay: Int, 
    startDayOfWeek: Int, 
    startTime: Int, 
    after: Boolean
): Unit

Sets the daylight saving time start rule to a weekday before or after the given date within a month, e.g., the first Monday on or after the 8th.

setStartYear

open fun setStartYear(year: Int): Unit

Sets the daylight saving time starting year.

toString

open fun toString(): String

Returns a string representation of this time zone.

useDaylightTime

open fun useDaylightTime(): Boolean

Queries if this time zone uses daylight saving time.