Package spock.util.time

Class MutableClock

java.lang.Object

java.time.Clock

spock.util.time.MutableClock

public class MutableClock
extends Clock

A mutable implementation of Clock for testing purposes.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
MutableClock()	Initializes a with Instant.now() and ZoneId.systemDefault() and 1 second changeAmount.
MutableClock(Instant instant)	Initializes a with given instant and ZoneId.systemDefault() and 1 second changeAmount.
MutableClock(Instant instant, ZoneId zone)	Initializes a with 1 second changeAmount and given parameters.
MutableClock(Instant instant, ZoneId zone, TemporalAmount changeAmount)
MutableClock(ZonedDateTime zonedDateTime)	Initializes a with instant and zone from ZonedDateTime and 1 second changeAmount.
MutableClock(ZoneId zone)	Initializes a with Instant.now() and given zone and 1 second changeAmount.

Method Summary

Modifier and Type	Method	Description
MutableClock	adjust(TemporalAdjuster adjuster)	Applies the given TemporalAdjuster to the internal time.
ZoneId	getZone()
Instant	instant()
MutableClock	minus(TemporalAmount amount)	Subtracts the given TemporalAmount from the internal time.
MutableClock	modify(BiFunction<Instant,ZoneId,Instant> modification)	Sets the internal time based on the result of the modification.
MutableClock	next()	Adds changeAmount to internal time.
MutableClock	plus(TemporalAmount amount)	Adds the given TemporalAmount to the internal time.
MutableClock	previous()	Subtracts changeAmount from internal time.
void	setChangeAmount(TemporalAmount changeAmount)
void	setInstant(Instant instant)
String	toString()
MutableClock	withZone(ZoneId zone)

Methods inherited from class java.time.Clock

equals, fixed, hashCode, millis, offset, system, systemDefaultZone, systemUTC, tick, tickMillis, tickMinutes, tickSeconds

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableClock

public MutableClock()

Initializes a with Instant.now() and ZoneId.systemDefault() and 1 second changeAmount.

MutableClock

public MutableClock(Instant instant)

Initializes a with given instant and ZoneId.systemDefault() and 1 second changeAmount.

Parameters:

instant - to use

MutableClock

public MutableClock(ZoneId zone)

Initializes a with Instant.now() and given zone and 1 second changeAmount.

Parameters:

zone - to use

MutableClock

public MutableClock(Instant instant,
                    ZoneId zone)

Initializes a with 1 second changeAmount and given parameters.

Parameters:

instant - to use

zone - to use

MutableClock

public MutableClock(Instant instant,
                    ZoneId zone,
                    TemporalAmount changeAmount)

MutableClock

public MutableClock(ZonedDateTime zonedDateTime)

Initializes a with instant and zone from ZonedDateTime and 1 second changeAmount.

Parameters:

zonedDateTime - to use for instant and zone information

Method Detail

getZone

public ZoneId getZone()

Specified by:

getZone in class Clock

withZone

public MutableClock withZone(ZoneId zone)

Specified by:

withZone in class Clock

instant

public Instant instant()

Specified by:

instant in class Clock

setChangeAmount

public void setChangeAmount(TemporalAmount changeAmount)

setInstant

public void setInstant(Instant instant)

modify

public MutableClock modify(BiFunction<Instant,ZoneId,Instant> modification)

Sets the internal time based on the result of the modification.

Parameters:

modification - a function to produce a new Instant

Returns:

this

plus

public MutableClock plus(TemporalAmount amount)

Adds the given TemporalAmount to the internal time.

Parameters:

amount - to add

Returns:

this

minus

public MutableClock minus(TemporalAmount amount)

Subtracts the given TemporalAmount from the internal time.

Parameters:

amount - to subtract

Returns:

this

adjust

public MutableClock adjust(TemporalAdjuster adjuster)

Applies the given TemporalAdjuster to the internal time.

Parameters:

adjuster - the adjuster to use,

Returns:

this

next

public MutableClock next()

Adds changeAmount to internal time.

Returns:

this

previous

public MutableClock previous()

Subtracts changeAmount from internal time.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object