no.digipost.time

Interface TimeControllable

All Known Implementing Classes:

ControllableClock

public interface TimeControllable

The clock mutation operations, e.g. offered by a ControllableClock. This interface can for instance be used to easily expose time manipulation through another API, but you do not want to expose a Clock instance.

Method Summary

Modifier and Type	Method and Description
no.digipost.time.ClockSnapshot	clockSnapshot() Resolves a ClockSnapshot.
default void	freeze() Signal that the clock should freeze at the instant it is currently at.
default void	freezeAt(Instant instant) Freeze the clock at given instant.
default void	freezeAt(Instant instant, ZoneId zone) Freeze the clock at given instant and zone.
default void	freezeAt(LocalDateTime offsetDateTime) Freeze the clock at given date and time.
default void	freezeAt(OffsetDateTime offsetDateTime) Freeze the clock at given date and time.
default void	freezeAt(ZonedDateTime zonedDateTime) Freeze the clock at given date and time.
default void	set(Instant instant) Set the time to the given instant.
default void	set(Instant instant, ZoneId zone) Set the time of the clock to the given instant and zone.
default void	set(LocalDateTime localDateTime) Set the time to the given local date and time.
default void	set(OffsetDateTime offsetDateTime) Set the time to the given offset date and time.
void	set(UnaryOperator<Clock> createNewClock) Set a new clock to resolve the time from.
default void	set(ZonedDateTime zonedDateTime) Set the time to the given zoned date and time.
default void	setToSystemClock() Set the time to freely progressing system time.
default void	setToSystemClock(ZoneId zoneId) Set the time to freely progressing system time with the given zone.
default void	timePasses(Duration amountOfTime) Signal that time is passing a given amount of time.
default void	timePasses(TemporalAmount amountOfTime) Signal that time is passing a given amount of time.

Method Detail

set

void set(UnaryOperator<Clock> createNewClock)

Set a new clock to resolve the time from.

Parameters:

createNewClock - function which is given the current clock, which may be used to create a new clock.

timePasses

default void timePasses(Duration amountOfTime)

Signal that time is passing a given amount of time.

Parameters:

amountOfTime - the amount of time which are passing.

timePasses

default void timePasses(TemporalAmount amountOfTime)

Signal that time is passing a given amount of time.

Parameters:

amountOfTime - the amount of time which are passing.

freezeAt

default void freezeAt(Instant instant,
                      ZoneId zone)

Freeze the clock at given instant and zone.

freezeAt

default void freezeAt(Instant instant)

Freeze the clock at given instant.

freezeAt

default void freezeAt(ZonedDateTime zonedDateTime)

Freeze the clock at given date and time.

freezeAt

default void freezeAt(OffsetDateTime offsetDateTime)

Freeze the clock at given date and time.

freezeAt

default void freezeAt(LocalDateTime offsetDateTime)

Freeze the clock at given date and time.

freeze

default void freeze()

Signal that the clock should freeze at the instant it is currently at.

setToSystemClock

default void setToSystemClock(ZoneId zoneId)

Set the time to freely progressing system time with the given zone.

See Also:

Clock.system(ZoneId)

setToSystemClock

default void setToSystemClock()

Set the time to freely progressing system time.

See Also:

Clock.system(ZoneId)

set

default void set(Instant instant,
                 ZoneId zone)

Set the time of the clock to the given instant and zone.

Parameters:

instant - the instant to set.

zone - the zone to set.

set

default void set(Instant instant)

Set the time to the given instant.

Parameters:

instant - the instant to set.

set

default void set(ZonedDateTime zonedDateTime)

Set the time to the given zoned date and time.

Parameters:

zonedDateTime - the date and time to set.

set

default void set(OffsetDateTime offsetDateTime)

Set the time to the given offset date and time.

Parameters:

offsetDateTime - the date and time to set.

set

default void set(LocalDateTime localDateTime)

Set the time to the given local date and time.

Parameters:

localDateTime - the date and time to set.

clockSnapshot

no.digipost.time.ClockSnapshot clockSnapshot()

Resolves a ClockSnapshot. The method is not part of the public API of Digg.

Returns:

a ClockSnapshot