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
void	freeze() Signal that time should freeze.
void	set(Instant instant) Set the time to the given instant.
void	set(LocalDateTime localDateTime) Set the time to the given local date and time.
default void	set(ZonedDateTime zonedDateTime) Set the time to the given zoned date and time.
void	setToSystemClock() Set the time to freely progressing system time.
void	timePasses(Duration duration) Signal that time is passing a given amount of time.
void	timePasses(TemporalAmount amountOfTime) Signal that time is passing a given amount of time.

Method Detail

set

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

void set(LocalDateTime localDateTime)

Set the time to the given local date and time.

Parameters:

localDateTime - the date and time to set.

timePasses

void timePasses(TemporalAmount amountOfTime)

Signal that time is passing a given amount of time.

Parameters:

amountOfTime - the amount of time which are passing.

timePasses

void timePasses(Duration duration)

Signal that time is passing a given amount of time.

Parameters:

amountOfTime - the amount of time which are passing.

freeze

void freeze()

Signal that time should freeze.

setToSystemClock

void setToSystemClock()

Set the time to freely progressing system time.

See Also:

Clock.system(ZoneId)