com.hcl.domino.data

Interface DominoDateTime

All Superinterfaces:

Cloneable, Comparable<DominoDateTime>, DominoTimeType, IAdaptable, Temporal, TemporalAccessor

public interface DominoDateTime
extends IAdaptable, Temporal, Cloneable, DominoTimeType, Comparable<DominoDateTime>

Represents a Domino date/time value. As a Temporal representation, these values have the following characteristics:

• An instance may represent either a date, a time, or a date/time pair with an optional UTC offset.
• They can store times to a resolution of 10ms.
• Time-zone information is stored as an offset only, not as a descriptive zone name, similar to OffsetDateTime.
• Time zone offsets must be in 15-minute increments.

Implementations of this class are expected to be immutable.

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
DominoDateTime	clone()
boolean	hasDate()
boolean	hasTime()
boolean	isValid() Determines whether the underlying date/time value is invalid.
LocalDate	toLocalDate() Converts the value to a LocalDate object if applicable
LocalTime	toLocalTime() Converts the value to a LocalTime object if applicable
OffsetDateTime	toOffsetDateTime() Converts the value to a OffsetDateTime object if applicable
Optional<Temporal>	toTemporal() Converts the value to a standard JDK Temporal implementation based on the internal value.

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Methods inherited from interface java.time.temporal.Temporal

isSupported, minus, minus, plus, plus, until, with, with

Methods inherited from interface java.time.temporal.TemporalAccessor

get, getLong, isSupported, query, range

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

hasDate

boolean hasDate()

Returns:

if this value has a date component

hasTime

boolean hasTime()

Returns:

if this value has a time component

clone

DominoDateTime clone()

toTemporal

Optional<Temporal> toTemporal()

Converts the value to a standard JDK Temporal implementation based on the internal value. Expected to be one of:

• OffsetDateTime
• LocalDate
• LocalTime

Returns:

an Optional describing a new Temporal instance representing the same value as this object, or an empty one if the date/time value is invalid

toOffsetDateTime

OffsetDateTime toOffsetDateTime()

Converts the value to a OffsetDateTime object if applicable

Returns:

a new OffsetDateTime object representing the same value as this object

Throws:

DateTimeException - if unable to convert to an OffsetDateTime

toLocalDate

LocalDate toLocalDate()

Converts the value to a LocalDate object if applicable

Returns:

a new LocalDate object representing the same value as this object

Throws:

DateTimeException - if unable to convert to an LocalDate

toLocalTime

LocalTime toLocalTime()

Converts the value to a LocalTime object if applicable

Returns:

a new LocalTime object representing the same value as this object

Throws:

DateTimeException - if unable to convert to an LocalTime

isValid

boolean isValid()

Determines whether the underlying date/time value is invalid. For example, retrieving the creation date of a document with an arbitrarily-set UNID may result in an unexpressable time.

Returns:

true if the time value is valid and can be expressed properly; false otherwise