ControllableClock (Digipost Digg 0.21 API)

java.lang.Object
- java.time.Clock
- - no.digipost.time.ControllableClock

All Implemented Interfaces:

Serializable
```
public final class ControllableClock
extends Clock
implements 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

All Methods Static Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`static ControllableClock`	`control(Clock clock)` Create a controllable clock based on an existing clock.
`<X extends Exception> void`	`doWithTimeAdjusted(Consumer<ClockAdjuster> 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)`
`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.
`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<ClockAdjuster> 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()`
`default LocalDateTime`	`localDateTime()` Gets the current `LocalDateTime` resolved for the zone of the clock.
`default OffsetDateTime`	`offsetDateTime()` Gets the current `OffsetDateTime` resolved for the zone of the clock.
`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.
`String`	`toString()`
`ControllableClock`	`withZone(ZoneId zone)`
`default 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

- 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
  - doWithTimeAdjusted
```
public <X extends Exception> void doWithTimeAdjusted(Consumer<ClockAdjuster> 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<ClockAdjuster> 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: ClockAdjuster
    
    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.
  - 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
  - timePasses
```
public void timePasses(Duration amountOfTime)
```
    Description copied from interface: ClockAdjuster
    
    Signal that time is passing a given amount of time.
    
    Specified by:
    
    timePasses in interface ClockAdjuster
    
    Parameters:
    
    amountOfTime - the amount of time which are passing.
  - timePasses
```
public void timePasses(TemporalAmount amountOfTime)
```
    Description copied from interface: ClockAdjuster
    
    Signal that time is passing a given amount of time.
    
    Specified by:
    
    timePasses in interface ClockAdjuster
    
    Parameters:
    
    amountOfTime - the amount of time which are passing.
  - freezeAt
```
public void freezeAt(Instant instant,
                     ZoneId zone)
```
    Description copied from interface: ClockAdjuster
    
    Freeze the clock at given instant and zone.
    
    Specified by:
    
    freezeAt in interface ClockAdjuster
  - freezeAt
```
public void freezeAt(Instant instant)
```
    Description copied from interface: ClockAdjuster
    
    Freeze the clock at given instant.
    
    Specified by:
    
    freezeAt in interface ClockAdjuster
  - freezeAt
```
public void freezeAt(ZonedDateTime zonedDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Freeze the clock at given date and time.
    
    Specified by:
    
    freezeAt in interface ClockAdjuster
  - freezeAt
```
public void freezeAt(OffsetDateTime offsetDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Freeze the clock at given date and time.
    
    Specified by:
    
    freezeAt in interface ClockAdjuster
  - freezeAt
```
public void freezeAt(LocalDateTime offsetDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Freeze the clock at given date and time.
    
    Specified by:
    
    freezeAt in interface ClockAdjuster
  - freeze
```
public void freeze()
```
    Description copied from interface: ClockAdjuster
    
    Signal that the clock should freeze at the instant it is currently at.
    
    Specified by:
    
    freeze in interface ClockAdjuster
  - setToSystemClock
```
public void setToSystemClock(ZoneId zoneId)
```
    Description copied from interface: ClockAdjuster
    
    Set the time to freely progressing system time with the given zone.
    
    Specified by:
    
    setToSystemClock in interface ClockAdjuster
    
    See Also:
    
    Clock.system(ZoneId)
  - setToSystemClock
```
public void setToSystemClock()
```
    Description copied from interface: ClockAdjuster
    
    Set the time to freely progressing system time.
    
    Specified by:
    
    setToSystemClock in interface ClockAdjuster
    
    See Also:
    
    Clock.system(ZoneId)
  - set
```
public void set(Instant instant,
                ZoneId zone)
```
    Description copied from interface: ClockAdjuster
    
    Set the time of the clock to the given instant and zone.
    
    Specified by:
    
    set in interface ClockAdjuster
    
    Parameters:
    
    instant - the instant to set.
    
    zone - the zone to set.
  - set
```
public void set(Instant instant)
```
    Description copied from interface: ClockAdjuster
    
    Set the time to the given instant.
    
    Specified by:
    
    set in interface ClockAdjuster
    
    Parameters:
    
    instant - the instant to set.
  - set
```
public void set(ZonedDateTime zonedDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Set the time to the given zoned date and time.
    
    Specified by:
    
    set in interface ClockAdjuster
    
    Parameters:
    
    zonedDateTime - the date and time to set.
  - set
```
public void set(OffsetDateTime offsetDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Set the time to the given offset date and time.
    
    Specified by:
    
    set in interface ClockAdjuster
    
    Parameters:
    
    offsetDateTime - the date and time to set.
  - set
```
public void set(LocalDateTime localDateTime)
```
    Description copied from interface: ClockAdjuster
    
    Set the time to the given local date and time.
    
    Specified by:
    
    set in interface ClockAdjuster
    
    Parameters:
    
    localDateTime - the date and time to set.
  - 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.
  - offsetDateTime
```
public OffsetDateTime offsetDateTime()
```
    Gets the current OffsetDateTime resolved for the zone of the clock.
    
    Returns:
    
    the current time as a date and time with zone offset.

Class ControllableClock

Method Summary

Methods inherited from class java.time.Clock

Methods inherited from class java.lang.Object

Method Detail

freezedAt

freezedAt

freezedAt

freezedAt

control

withZone

instant

getZone

doWithTimeAdjusted

getWithTimeAdjusted

set

toString

equals

hashCode

timePasses

timePasses

freezeAt

freezeAt

freezeAt

freezeAt

freezeAt

freeze

setToSystemClock

setToSystemClock

set

set

set

set

set

zonedDateTime

localDateTime

offsetDateTime