com.timgroup.clocks.testing.ManualClock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clocks-testing Show documentation
JSR310 clock implementations for use in testing
The newest version!
package com.timgroup.clocks.testing;

import java.time.Clock;
import java.time.Duration;
import java.time.Instant;
import java.time.ZoneId;
import java.time.temporal.TemporalAmount;
import java.time.temporal.TemporalUnit;

import static java.util.Objects.requireNonNull;

/**
 * Clock that only updates in positive increments when called directly.
 */
public final class ManualClock extends Clock {
    private Instant instant;
    private final ZoneId zone;

    public static ManualClock initiallyAt(Clock clock) {
        return new ManualClock(clock.instant(), clock.getZone());
    }

    public static ManualClock createDefault() {
        return initiallyAt(Clock.systemUTC());
    }

    public ManualClock(Instant initialInstant, ZoneId zone) {
        this.instant = requireNonNull(initialInstant);
        this.zone = requireNonNull(zone);
    }

    public void bump(long amountToAdd, TemporalUnit unit) {
        if (amountToAdd < 0) {
            throw new IllegalArgumentException("Duration must be non-negative");
        }
        instant = instant.plus(amountToAdd, unit);
    }

    public void bumpSeconds(int secs) {
        if (secs < 0) {
            throw new IllegalArgumentException("Duration must be non-negative");
        }
        instant = instant.plusSeconds(secs);
    }

    public void bumpMillis(long millis) {
        if (millis < 0) {
            throw new IllegalArgumentException("Duration must be non-negative");
        }
        instant = instant.plusMillis(millis);
    }

    public void bump(TemporalAmount amountToAdd) {
        Instant newInstant = instant.plus(amountToAdd);
        if (newInstant.isBefore(instant)) {
            throw new IllegalArgumentException("Duration must be non-negative");
        }
        instant = newInstant;
    }

    public void bump(Duration duration) {
        if (duration.isNegative()) {
            throw new IllegalArgumentException("Duration must be non-negative");
        }
        instant = instant.plus(duration);
    }

    public void advanceTo(Instant futureInstant) {
        if (futureInstant.isBefore(instant)) {
            throw new IllegalArgumentException("Instant must not be before the current time");
        }
        instant = futureInstant;
    }

    @Override
    public Instant instant() {
        return instant;
    }

    @Override
    public ZoneId getZone() {
        return zone;
    }

    @Override
    public Clock withZone(ZoneId overrideZone) {
        if (overrideZone.equals(zone)) {
            return this;
        }
        return new Clock() {
            @Override
            public Instant instant() {
                return instant;
            }

            @Override
            public ZoneId getZone() {
                return overrideZone;
            }

            @Override
            public Clock withZone(ZoneId z) {
                return ManualClock.this.withZone(z);
            }

            @Override
            public String toString() {
                return ManualClock.this.toString() + "{zone:" + overrideZone + "}";
            }
        };
    }

    @Override
    public String toString() {
        return "ManualClock:" + instant;
    }
}