Module io.aiven.commons.timing
Package io.aiven.commons.timing

Class Timer

java.lang.Object
org.apache.commons.lang3.time.StopWatch
io.aiven.commons.timing.Timer
public class Timer extends org.apache.commons.lang3.time.StopWatch
Calculates elapsed time and flags when expired.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Timer(Duration duration)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort()
    Aborts the timer.
    BackoffConfig
    getBackoffConfig()
    Gets a Backoff Config for this timer.
    boolean
    isExpired()
    Returns true if the timer has expired.
    long
    millisecondsRemaining()
    Gets the maximum duration for this timer.
    void
    reset()
     
    void
    start()
     
    void
    stop()
     

    Methods inherited from class org.apache.commons.lang3.time.StopWatch

    create, createStarted, formatSplitTime, formatTime, getDuration, getMessage, getNanoTime, getSplitDuration, getSplitNanoTime, getSplitTime, getStartInstant, getStartTime, getStopInstant, getStopTime, getTime, getTime, isStarted, isStopped, isSuspended, resume, split, suspend, toSplitString, toString, unsplit

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Timer

      public Timer(Duration duration)
      Constructor.
      Parameters:
      duration - the length of time the timer should run.

  • Method Details

    • millisecondsRemaining

      public long millisecondsRemaining()
      Gets the maximum duration for this timer.
      Returns:
      the maximum duration for the timer.

    • isExpired

      public boolean isExpired()
      Returns true if the timer has expired.
      Returns:
      true if the timer has expired.

    • abort

      public void abort()
      Aborts the timer. Timer will report that it has expired until reset is called.

    • start

      public void start()
      Overrides:
      start in class org.apache.commons.lang3.time.StopWatch

    • stop

      public void stop()
      Overrides:
      stop in class org.apache.commons.lang3.time.StopWatch

    • reset

      public void reset()
      Overrides:
      reset in class org.apache.commons.lang3.time.StopWatch

    • getBackoffConfig

      public BackoffConfig getBackoffConfig()
      Gets a Backoff Config for this timer.
      Returns:
      a backoff Configuration.