no.digipost.time

Class ControllableClock

java.lang.Object

java.time.Clock

no.digipost.time.ControllableClock

All Implemented Interfaces:

Serializable, TimeControllable

public final class ControllableClock
extends Clock
implements TimeControllable, Serializable

A controllable Clock, typically intended for use in testing. A ControllableClock may either be freely running (as e.g. the system clock) or freezed, and can in all cases be set to a new point in time.

See Also:

TimeControllable.timePasses(TemporalAmount), TimeControllable.set(Instant), TimeControllable.setToSystemClock(), Serialized Form

Method Summary

Modifier and Type	Method and Description
default no.digipost.time.ClockSnapshot	clockSnapshot() Resolves a ClockSnapshot.
static ControllableClock	control(Clock clock) Create a controllable clock based on an existing clock.
<X extends Exception> void	doWithTimeAdjusted(Consumer<TimeControllable> adjustClock, ThrowingConsumer<Instant,X> action) Perform an action with the clock adjusted, and have the clock reset to it's original state after the action has finished.
boolean	equals(Object obj)
static ControllableClock	freezedAt(Instant instant) Create a new controllable clock freezed at a given instant, and with the default time zone.
static ControllableClock	freezedAt(Instant instant, ZoneId zone) Create a new controllable clock freezed at a given Instant, and with a given ZoneId.
static ControllableClock	freezedAt(LocalDateTime dateTime) Create a new controllable clock freezed at the instant resolved from a given LocalDateTime and the default time zone.
static ControllableClock	freezedAt(ZonedDateTime dateTime) Create a new controllable clock freezed at the instant of a given ZonedDateTime.
<T,X extends Exception> T	getWithTimeAdjusted(Consumer<TimeControllable> adjustClock, ThrowingFunction<Instant,T,X> resolveValue) Resolve a value with the clock adjusted, and have the clock reset to it's original state after the operation has finished.
ZoneId	getZone()
int	hashCode()
Instant	instant()
LocalDateTime	localDateTime() Gets the current LocalDateTime resolved for the zone of the clock.
void	set(UnaryOperator<Clock> createNewClock) Set a new clock to resolve the time from.
String	toString()
ControllableClock	withZone(ZoneId zone)
ZonedDateTime	zonedDateTime() Gets the current ZonedDateTime resolved with the zone of the clock.

Methods inherited from class java.time.Clock

fixed, millis, offset, system, systemDefaultZone, systemUTC, tick, tickMinutes, tickSeconds

Methods inherited from class java.lang.Object

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

Methods inherited from interface no.digipost.time.TimeControllable

freeze, freezeAt, freezeAt, freezeAt, freezeAt, freezeAt, set, set, set, set, set, setToSystemClock, setToSystemClock, timePasses, timePasses

Method Detail

freezedAt

public static ControllableClock freezedAt(LocalDateTime dateTime)

Create a new controllable clock freezed at the instant resolved from a given LocalDateTime and the default time zone. The clock will not progress on its own, and will yield the instant it is set to.

Parameters:

dateTime - The date and time to set for the new freezed clock.

Returns:

the new ControllableClock

freezedAt

public static ControllableClock freezedAt(ZonedDateTime dateTime)

Create a new controllable clock freezed at the instant of a given ZonedDateTime. The clock will not progress on its own, and will yield the instant it is set to.

Parameters:

dateTime - The date and time to set for the new freezed clock.

Returns:

the new ControllableClock

freezedAt

public static ControllableClock freezedAt(Instant instant)

Create a new controllable clock freezed at a given instant, and with the default time zone. The clock will not progress on its own, and will yield the instant it is set to.

Parameters:

instant - The instant to set for the new freezed clock.

Returns:

the new ControllableClock

freezedAt

public static ControllableClock freezedAt(Instant instant,
                                          ZoneId zone)

Create a new controllable clock freezed at a given Instant, and with a given ZoneId. The clock will not progress on its own, and will yield a set instant.

Parameters:

instant - The instant to set for the new freezed clock.

zone - The time zone of the new freezed clock.

Returns:

the new ControllableClock

control

public static ControllableClock control(Clock clock)

Create a controllable clock based on an existing clock. The new ControllableClock will have the same behavior (freezed or progressing) and time as the given clock, but may be mutated to yield another instant, or be freezed. The given clock is of course not altered.

Parameters:

clock - The clock to base the new ControllableClock instance on.

Returns:

the new ControllableClock

withZone

public ControllableClock withZone(ZoneId zone)

Specified by:

withZone in class Clock

instant

public Instant instant()

Specified by:

instant in class Clock

getZone

public ZoneId getZone()

Specified by:

getZone in class Clock

zonedDateTime

public ZonedDateTime zonedDateTime()

Gets the current ZonedDateTime resolved with the zone of the clock.

Returns:

the current time as a zoned date and time.

localDateTime

public LocalDateTime localDateTime()

Gets the current LocalDateTime resolved for the zone of the clock.

Returns:

the current time as a local date and time.

doWithTimeAdjusted

public <X extends Exception> void doWithTimeAdjusted(Consumer<TimeControllable> adjustClock,
                                                     ThrowingConsumer<Instant,X> action)
                                              throws X extends Exception

Perform an action with the clock adjusted, and have the clock reset to it's original state after the action has finished.

Type Parameters:

X - Exception the may be thrown from the given action

Parameters:

adjustClock - how to adjust the clock before running the action

action - the action to perform, which is given an instant resolved from the adjusted clock

Throws:

X - if the given action throws an exception

X extends Exception

getWithTimeAdjusted

public <T,X extends Exception> T getWithTimeAdjusted(Consumer<TimeControllable> adjustClock,
                                                     ThrowingFunction<Instant,T,X> resolveValue)
                                              throws X extends Exception

Resolve a value with the clock adjusted, and have the clock reset to it's original state after the operation has finished.

Type Parameters:

T - The returned type

X - Exception the may be thrown from the given function

Parameters:

adjustClock - how to adjust the clock before running the action

resolveValue - the operation which resolves the value, which is given an instant resolved from the adjusted clock

Returns:

the value returned from the given resolveValue function

Throws:

X - if the function throws an exception while resolving the value.

X extends Exception

set

public void set(UnaryOperator<Clock> createNewClock)

Description copied from interface: TimeControllable

Set a new clock to resolve the time from.

Specified by:

set in interface TimeControllable

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Clock

hashCode

public int hashCode()

Overrides:

hashCode in class Clock

clockSnapshot

public no.digipost.time.ClockSnapshot clockSnapshot()

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

Returns:

a ClockSnapshot