ZoneOffsetTransitionRule | API reference | Android Developers (original) (raw)

class ZoneOffsetTransitionRule : Serializable

A rule expressing how to create a transition.

This class allows rules for identifying future transitions to be expressed. A rule might be written in many forms:

the 16th March
the Sunday on or after the 16th March
the Sunday on or before the 16th March
the last Sunday in February

These different rule types can be expressed and queried.

Summary

Nested classes
TimeDefinition A definition of the way a local time can be converted to the actual transition date-time.

Public methods
ZoneOffsetTransition!	createTransition(year: Int) Creates a transition instance for the specified year.
Boolean	equals(other: Any?) Checks if this object equals another.
Int	getDayOfMonthIndicator() Gets the indicator of the day-of-month of the transition.
DayOfWeek!	getDayOfWeek() Gets the day-of-week of the transition.
LocalTime!	getLocalTime() Gets the local time of day of the transition which must be checked with isMidnightEndOfDay().
Month!	getMonth() Gets the month of the transition.
ZoneOffset!	getOffsetAfter() Gets the offset after the transition.
ZoneOffset!	getOffsetBefore() Gets the offset before the transition.
ZoneOffset!	getStandardOffset() Gets the standard offset in force at the transition.
ZoneOffsetTransitionRule.TimeDefinition!	getTimeDefinition() Gets the time definition, specifying how to convert the time to an instant.
Int	hashCode() Returns a suitable hash code.
Boolean	isMidnightEndOfDay() Is the transition local time midnight at the end of day.
static ZoneOffsetTransitionRule!	of(month: Month!, dayOfMonthIndicator: Int, dayOfWeek: DayOfWeek!, time: LocalTime!, timeEndOfDay: Boolean, timeDefinition: ZoneOffsetTransitionRule.TimeDefinition!, standardOffset: ZoneOffset!, offsetBefore: ZoneOffset!, offsetAfter: ZoneOffset!) Obtains an instance defining the yearly rule to create transitions between two offsets.
String	toString() Returns a string describing this object.

Public methods

createTransition

fun createTransition(year: Int): ZoneOffsetTransition!

Creates a transition instance for the specified year.

Calculations are performed using the ISO-8601 chronology.

Parameters
year	Int: the year to create a transition for, not null

Return
ZoneOffsetTransition!	the transition instance, not null

equals

fun equals(other: Any?): Boolean

Checks if this object equals another.

The entire state of the object is compared.

Parameters
obj	the reference object with which to compare.
otherRule	the other object to compare to, null returns false

Return
Boolean	true if equal

getDayOfMonthIndicator

fun getDayOfMonthIndicator(): Int

Gets the indicator of the day-of-month of the transition.

If the rule defines an exact date then the day is the month of that date.

If the rule defines a week where the transition might occur, then the day defines either the start of the end of the transition week.

If the value is positive, then it represents a normal day-of-month, and is the earliest possible date that the transition can be. The date may refer to 29th February which should be treated as 1st March in non-leap years.

If the value is negative, then it represents the number of days back from the end of the month where -1 is the last day of the month. In this case, the day identified is the latest possible date that the transition can be.

Return
Int	the day-of-month indicator, from -28 to 31 excluding 0

getDayOfWeek

fun getDayOfWeek(): DayOfWeek!

Gets the day-of-week of the transition.

If the rule defines an exact date then this returns null.

If the rule defines a week where the cutover might occur, then this method returns the day-of-week that the month-day will be adjusted to. If the day is positive then the adjustment is later. If the day is negative then the adjustment is earlier.

Return
DayOfWeek!	the day-of-week that the transition occurs, null if the rule defines an exact date

getLocalTime

fun getLocalTime(): LocalTime!

Gets the local time of day of the transition which must be checked with [isMidnightEndOfDay()](#isMidnightEndOfDay%28%29).

The time is converted into an instant using the time definition.

Return
LocalTime!	the local time of day of the transition, not null

getMonth

fun getMonth(): Month!

Gets the month of the transition.

If the rule defines an exact date then the month is the month of that date.

If the rule defines a week where the transition might occur, then the month if the month of either the earliest or latest possible date of the cutover.

Return
Month!	the month of the transition, not null

getOffsetAfter

fun getOffsetAfter(): ZoneOffset!

Gets the offset after the transition.

Return
ZoneOffset!	the offset after, not null

getOffsetBefore

fun getOffsetBefore(): ZoneOffset!

Gets the offset before the transition.

Return
ZoneOffset!	the offset before, not null

getStandardOffset

fun getStandardOffset(): ZoneOffset!

Gets the standard offset in force at the transition.

Return
ZoneOffset!	the standard offset, not null

hashCode

fun hashCode(): Int

Returns a suitable hash code.

Return
Int	the hash code

isMidnightEndOfDay

fun isMidnightEndOfDay(): Boolean

Is the transition local time midnight at the end of day.

The transition may be represented as occurring at 24:00.

Return
Boolean	whether a local time of midnight is at the start or end of the day

of

static fun of(
    month: Month!,
    dayOfMonthIndicator: Int,
    dayOfWeek: DayOfWeek!,
    time: LocalTime!,
    timeEndOfDay: Boolean,
    timeDefinition: ZoneOffsetTransitionRule.TimeDefinition!,
    standardOffset: ZoneOffset!,
    offsetBefore: ZoneOffset!,
    offsetAfter: ZoneOffset!
): ZoneOffsetTransitionRule!

Obtains an instance defining the yearly rule to create transitions between two offsets.

Applications should normally obtain an instance from [ZoneRules](/reference/kotlin/java/time/zone/ZoneRules). This factory is only intended for use when creating [ZoneRules](/reference/kotlin/java/time/zone/ZoneRules).

Parameters
month	Month!: the month of the month-day of the first day of the cutover week, not null
dayOfMonthIndicator	Int: the day of the month-day of the cutover week, positive if the week is that day or later, negative if the week is that day or earlier, counting from the last day of the month, from -28 to 31 excluding 0
dayOfWeek	DayOfWeek!: the required day-of-week, null if the month-day should not be changed
time	LocalTime!: the cutover time in the 'before' offset, not null
timeEndOfDay	Boolean: whether the time is midnight at the end of day
timeDefinition	ZoneOffsetTransitionRule.TimeDefinition!: how to interpret the cutover
standardOffset	ZoneOffset!: the standard offset in force at the cutover, not null
offsetBefore	ZoneOffset!: the offset before the cutover, not null
offsetAfter	ZoneOffset!: the offset after the cutover, not null

Return
ZoneOffsetTransitionRule!	the rule, not null

Exceptions
java.lang.IllegalArgumentException	if time.getNano() returns non-zero value

toString

fun toString(): String

Returns a string describing this object.

Return
String	a string for debugging, not null