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:

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

Method Summary

Modifier and Type	Method and Description
static ControllableClock	control(Clock clock) Create a controllable clock based on an existing clock.
boolean	equals(Object obj)
void	freeze() Signal that time should freeze.
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.
ZoneId	getZone()
int	hashCode()
Instant	instant()
void	set(Clock newDelegate)
void	set(Instant newInstant) Set the time to the given instant.
void	set(LocalDateTime dateTime) Set the time to the given local date and time.
void	setToSystemClock() Set the time to freely progressing system time.
void	setToSystemClock(ZoneId zoneId)
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.
String	toString()
ControllableClock	withZone(ZoneId zone)

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

set

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

timePasses

public void timePasses(TemporalAmount amountOfTime)

Description copied from interface: TimeControllable

Signal that time is passing a given amount of time.

Specified by:

timePasses in interface TimeControllable

Parameters:

amountOfTime - the amount of time which are passing.

timePasses

public void timePasses(Duration duration)

Description copied from interface: TimeControllable

Signal that time is passing a given amount of time.

Specified by:

timePasses in interface TimeControllable

set

public void set(LocalDateTime dateTime)

Description copied from interface: TimeControllable

Set the time to the given local date and time.

Specified by:

set in interface TimeControllable

Parameters:

dateTime - the date and time to set.

set

public void set(Instant newInstant)

Description copied from interface: TimeControllable

Set the time to the given instant.

Specified by:

set in interface TimeControllable

Parameters:

newInstant - the instant to set.

set

public void set(Clock newDelegate)

freeze

public void freeze()

Description copied from interface: TimeControllable

Signal that time should freeze.

Specified by:

freeze in interface TimeControllable

setToSystemClock

public void setToSystemClock()

Description copied from interface: TimeControllable

Set the time to freely progressing system time.

Specified by:

setToSystemClock in interface TimeControllable

See Also:

Clock.system(ZoneId)

setToSystemClock

public void setToSystemClock(ZoneId zoneId)

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