io.spine.core

Interface WithTime

All Known Subinterfaces:

Signal<I,M,C>

public interface WithTime

An object with associated point in time.

Method Summary

Modifier and Type	Method and Description
default java.time.Instant	instant() Obtains the associated time point as Instant.
default boolean	isAfter(com.google.protobuf.Timestamp bound) Verifies if associated time is after the passed point in time.
default boolean	isBefore(com.google.protobuf.Timestamp bound) Verifies if the associated time is before the passed point in time.
default boolean	isBetween(com.google.protobuf.Timestamp periodStart, com.google.protobuf.Timestamp periodEnd) Verifies if the associated time point is within the passed period of time.
default java.time.LocalDate	localDate() Obtains the local date of the WithTime.instant() associated time point}.
default java.time.LocalDateTime	localDateTime() Obtains the local date and time of the WithTime.instant() associated time point}.
com.google.protobuf.Timestamp	timestamp() Obtains the point in time associated with the object.

Method Detail

timestamp

com.google.protobuf.Timestamp timestamp()

Obtains the point in time associated with the object.

isAfter

default boolean isAfter(com.google.protobuf.Timestamp bound)

Verifies if associated time is after the passed point in time.

isBefore

default boolean isBefore(com.google.protobuf.Timestamp bound)

Verifies if the associated time is before the passed point in time.

isBetween

default boolean isBetween(com.google.protobuf.Timestamp periodStart,
                          com.google.protobuf.Timestamp periodEnd)

Verifies if the associated time point is within the passed period of time.

Parameters:

periodStart - lower bound, exclusive

periodEnd - higher bound, inclusive

Returns:

true if the time point of the command creation lies in between the given two

instant

default java.time.Instant instant()

Obtains the associated time point as Instant.

See Also:

WithTime.timestamp()

localDate

default java.time.LocalDate localDate()

Obtains the local date of the WithTime.instant() associated time point}.

localDateTime

default java.time.LocalDateTime localDateTime()

Obtains the local date and time of the WithTime.instant() associated time point}.