001/*
002 * Copyright (C) 2008 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.testing;
018
019import static com.google.common.base.Preconditions.checkArgument;
020
021import com.google.common.annotations.GwtCompatible;
022import com.google.common.base.Ticker;
023import com.google.errorprone.annotations.CanIgnoreReturnValue;
024import java.util.concurrent.TimeUnit;
025import java.util.concurrent.atomic.AtomicLong;
026
027/**
028 * A Ticker whose value can be advanced programmatically in test.
029 *
030 * <p>The ticker can be configured so that the time is incremented whenever {@link #read} is called:
031 * see {@link #setAutoIncrementStep}.
032 *
033 * <p>This class is thread-safe.
034 *
035 * @author Jige Yu
036 * @since 10.0
037 */
038@ElementTypesAreNonnullByDefault
039@GwtCompatible
040public class FakeTicker extends Ticker {
041
042  private final AtomicLong nanos = new AtomicLong();
043  private volatile long autoIncrementStepNanos;
044
045  /** Advances the ticker value by {@code time} in {@code timeUnit}. */
046  @SuppressWarnings("GoodTime") // should accept a java.time.Duration
047  @CanIgnoreReturnValue
048  public FakeTicker advance(long time, TimeUnit timeUnit) {
049    return advance(timeUnit.toNanos(time));
050  }
051
052  /** Advances the ticker value by {@code nanoseconds}. */
053  @SuppressWarnings("GoodTime") // should accept a java.time.Duration
054  @CanIgnoreReturnValue
055  public FakeTicker advance(long nanoseconds) {
056    nanos.addAndGet(nanoseconds);
057    return this;
058  }
059
060  /**
061   * Sets the increment applied to the ticker whenever it is queried.
062   *
063   * <p>The default behavior is to auto increment by zero. i.e: The ticker is left unchanged when
064   * queried.
065   */
066  @SuppressWarnings("GoodTime") // should accept a java.time.Duration
067  @CanIgnoreReturnValue
068  public FakeTicker setAutoIncrementStep(long autoIncrementStep, TimeUnit timeUnit) {
069    checkArgument(autoIncrementStep >= 0, "May not auto-increment by a negative amount");
070    this.autoIncrementStepNanos = timeUnit.toNanos(autoIncrementStep);
071    return this;
072  }
073
074  @Override
075  public long read() {
076    return nanos.getAndAdd(autoIncrementStepNanos);
077  }
078}