javax.time.calendar.zone

Class ZoneOffsetInfo

java.lang.Object

javax.time.calendar.zone.ZoneOffsetInfo

public final class ZoneOffsetInfo
extends Object

Information about the valid offsets applicable for a local date-time.

The mapping from a local date-time to an offset is not straightforward. There are three cases:

• Normal. Where there is a single offset for the local date-time.
• Gap. Where there is a gap in the local time-line typically caused by the spring cutover to daylight savings. There are no valid offsets within the gap
• Overlap. Where there is a gap in the local time-line typically caused by the autumn cutover from daylight savings. There are two valid offsets during the overlap.

When using this class, it is vital to check the isTransition() method to handle the gap and overlap. Alternatively use one of the general methods getEstimatedOffset() or isValidOffset(ZoneOffset).

OffsetInfo is immutable and thread-safe.

Author:

Stephen Colebourne

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherInfo) Checks if this object equals another.
ZoneOffset	getEstimatedOffset() Gets an estimated offset for the local date-time.
LocalDateTime	getLocalDateTime() Gets the local date-time that this info is applicable to.
ZoneOffset	getOffset() Gets the offset applicable at this point on the local time-line.
ZoneOffsetTransition	getTransition() Gets information about the transition occurring on the local time-line.
int	hashCode() A suitable hash code for this object.
boolean	isTransition() Is a transition occurring on the local time-line.
boolean	isValidOffset(ZoneOffset offset) Checks if the specified offset is valid for this date-time.
static ZoneOffsetInfo	of(LocalDateTime dateTime, ZoneOffset offset, ZoneOffsetTransition transition) Creates an instance representing a simple single offset or a transition.
String	toString() Returns a string describing this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static ZoneOffsetInfo of(LocalDateTime dateTime,
                                ZoneOffset offset,
                                ZoneOffsetTransition transition)

Creates an instance representing a simple single offset or a transition.

Applications should normally obtain an instance from ZoneRules. This constructor is intended for use by implementors of ZoneRules.

One, and only one, of the offset or transition parameters must be specified.

Parameters:

dateTime - the local date-time that this info applies to, not null

offset - the offset applicable at the date-time

transition - the details of the transition including the offset before and after

getLocalDateTime

public LocalDateTime getLocalDateTime()

Gets the local date-time that this info is applicable to.

Returns:

the date-time that this is the information for, not null

isTransition

public boolean isTransition()

Is a transition occurring on the local time-line.

A transition may be a gap or overlap and is normally caused by daylight savings cutover.

Returns:

true if there is a transition occurring on the local time-line, false if there is a single valid offset

getOffset

public ZoneOffset getOffset()

Gets the offset applicable at this point on the local time-line.

This method is intended for use when isTransition() returns false.

Returns:

the offset applicable when there is not a transition on the local-time line, null if it is a transition

getTransition

public ZoneOffsetTransition getTransition()

Gets information about the transition occurring on the local time-line.

This method is intended for use when isTransition() returns true

Returns:

the transition on the local-time line, null if not a transition

getEstimatedOffset

public ZoneOffset getEstimatedOffset()

Gets an estimated offset for the local date-time.

This returns an offset that applies at the local date-time or just after. During a gap the offset after the gap will be returned. During an overlap the offset after the transition will be returned.

Returns:

a suitable estimated offset, never null

isValidOffset

public boolean isValidOffset(ZoneOffset offset)

Checks if the specified offset is valid for this date-time.

The date-time will typically have a single valid offset. During a gap, there will be no valid offsets. During an overlap, there will be two valid offsets. This method returns true if the specified offset is one of the valid offsets.

Parameters:

offset - the offset to check, null returns false

Returns:

true if the offset is one of those allowed by the date-time

equals

public boolean equals(Object otherInfo)

Checks if this object equals another.

The entire state of the object is compared.

Overrides:

equals in class Object

Parameters:

otherInfo - the other object to compare to, null returns false

Returns:

true if equal

hashCode

public int hashCode()

A suitable hash code for this object.

Overrides:

hashCode in class Object

Returns:

the hash code

toString

public String toString()

Returns a string describing this object.

Overrides:

toString in class Object

Returns:

a string for debugging, never null