ZoneOffsetTransition
class ZoneOffsetTransition : Comparable<ZoneOffsetTransition!>, Serializable
| kotlin.Any | |
| ↳ | java.time.zone.ZoneOffsetTransition |
A transition between two offsets caused by a discontinuity in the local time-line.
A transition between two offsets is normally the result of a daylight savings cutover. The discontinuity is normally a gap in spring and an overlap in autumn. ZoneOffsetTransition models the transition between the two offsets.
Gaps occur where there are local date-times that simply do not exist. An example would be when the offset changes from +03:00 to +04:00. This might be described as 'the clocks will move forward one hour tonight at 1am'.
Overlaps occur where there are local date-times that exist twice. An example would be when the offset changes from +04:00 to +03:00. This might be described as 'the clocks will move back one hour tonight at 2am'.
Summary
| Public methods | |
|---|---|
| Int |
compareTo(other: ZoneOffsetTransition!)Compares this transition to another based on the transition instant. |
| Boolean |
Checks if this object equals another. |
| LocalDateTime! |
Gets the local transition date-time, as would be expressed with the 'after' offset. |
| LocalDateTime! |
Gets the local transition date-time, as would be expressed with the 'before' offset. |
| Duration! |
Gets the duration of the transition. |
| Instant! |
Gets the transition instant. |
| ZoneOffset! |
Gets the offset after the transition. |
| ZoneOffset! |
Gets the offset before the transition. |
| Int |
hashCode()Returns a suitable hash code. |
| Boolean |
isGap()Does this transition represent a gap in the local time-line. |
| Boolean |
Does this transition represent an overlap in the local time-line. |
| Boolean |
isValidOffset(offset: ZoneOffset!)Checks if the specified offset is valid during this transition. |
| static ZoneOffsetTransition! |
of(transition: LocalDateTime!, offsetBefore: ZoneOffset!, offsetAfter: ZoneOffset!)Obtains an instance defining a transition between two offsets. |
| Long |
Gets the transition instant as an epoch second. |
| String |
toString()Returns a string describing this object. |
Public methods
compareTo
fun compareTo(other: ZoneOffsetTransition!): Int
Compares this transition to another based on the transition instant.
This compares the instants of each transition. The offsets are ignored, making this order inconsistent with equals.
| Parameters | |
|---|---|
o |
the object to be compared. |
transition |
the transition to compare to, not null |
| Return | |
|---|---|
Int |
the comparator value, negative if less, positive if greater |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
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. |
other |
Any?: the other object to compare to, null returns false |
| Return | |
|---|---|
Boolean |
true if equal |
getDateTimeAfter
fun getDateTimeAfter(): LocalDateTime!
Gets the local transition date-time, as would be expressed with the 'after' offset.
This is the first date-time after the discontinuity, when the new offset applies.
The combination of the 'before' date-time and offset represents the same instant as the 'after' date-time and offset.
| Return | |
|---|---|
LocalDateTime! |
the transition date-time expressed with the after offset, not null |
getDateTimeBefore
fun getDateTimeBefore(): LocalDateTime!
Gets the local transition date-time, as would be expressed with the 'before' offset.
This is the date-time where the discontinuity begins expressed with the 'before' offset. At this instant, the 'after' offset is actually used, therefore the combination of this date-time and the 'before' offset will never occur.
The combination of the 'before' date-time and offset represents the same instant as the 'after' date-time and offset.
| Return | |
|---|---|
LocalDateTime! |
the transition date-time expressed with the before offset, not null |
getDuration
fun getDuration(): Duration!
Gets the duration of the transition.
In most cases, the transition duration is one hour, however this is not always the case. The duration will be positive for a gap and negative for an overlap. Time-zones are second-based, so the nanosecond part of the duration will be zero.
| Return | |
|---|---|
Duration! |
the duration of the transition, positive for gaps, negative for overlaps |
getInstant
fun getInstant(): Instant!
Gets the transition instant.
This is the instant of the discontinuity, which is defined as the first instant that the 'after' offset applies.
The methods getInstant(), getDateTimeBefore() and getDateTimeAfter() all represent the same instant.
| Return | |
|---|---|
Instant! |
the transition instant, not null |
getOffsetAfter
fun getOffsetAfter(): ZoneOffset!
Gets the offset after the transition.
This is the offset in use on and after the instant of the transition.
| Return | |
|---|---|
ZoneOffset! |
the offset after the transition, not null |
getOffsetBefore
fun getOffsetBefore(): ZoneOffset!
Gets the offset before the transition.
This is the offset in use before the instant of the transition.
| Return | |
|---|---|
ZoneOffset! |
the offset before the transition, not null |
hashCode
fun hashCode(): Int
Returns a suitable hash code.
| Return | |
|---|---|
Int |
the hash code |
isGap
fun isGap(): Boolean
Does this transition represent a gap in the local time-line.
Gaps occur where there are local date-times that simply do not exist. An example would be when the offset changes from +01:00 to +02:00. This might be described as 'the clocks will move forward one hour tonight at 1am'.
| Return | |
|---|---|
Boolean |
true if this transition is a gap, false if it is an overlap |
isOverlap
fun isOverlap(): Boolean
Does this transition represent an overlap in the local time-line.
Overlaps occur where there are local date-times that exist twice. An example would be when the offset changes from +02:00 to +01:00. This might be described as 'the clocks will move back one hour tonight at 2am'.
| Return | |
|---|---|
Boolean |
true if this transition is an overlap, false if it is a gap |
isValidOffset
fun isValidOffset(offset: ZoneOffset!): Boolean
Checks if the specified offset is valid during this transition.
This checks to see if the given offset will be valid at some point in the transition. A gap will always return false. An overlap will return true if the offset is either the before or after offset.
| Parameters | |
|---|---|
offset |
ZoneOffset!: the offset to check, null returns false |
| Return | |
|---|---|
Boolean |
true if the offset is valid during the transition |
of
static fun of(
transition: LocalDateTime!,
offsetBefore: ZoneOffset!,
offsetAfter: ZoneOffset!
): ZoneOffsetTransition!
Obtains an instance defining a transition between two offsets.
Applications should normally obtain an instance from ZoneRules. This factory is only intended for use when creating ZoneRules.
| Parameters | |
|---|---|
transition |
LocalDateTime!: the transition date-time at the transition, which never actually occurs, expressed local to the before offset, not null |
offsetBefore |
ZoneOffset!: the offset before the transition, not null |
offsetAfter |
ZoneOffset!: the offset at and after the transition, not null |
| Return | |
|---|---|
ZoneOffsetTransition! |
the transition, not null |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if offsetBefore and offsetAfter are equal, or transition.getNano() returns non-zero value |
toEpochSecond
fun toEpochSecond(): Long
Gets the transition instant as an epoch second.
| Return | |
|---|---|
Long |
the transition epoch second |
toString
fun toString(): String
Returns a string describing this object.
| Return | |
|---|---|
String |
a string for debugging, not null |