Method Detail

• start

  public CountdownTimer start()

  starts the timer, either initially or if pause()d; no-op if already running

• pause

  public CountdownTimer pause()

  pauses the timer, if running; no-op if not running

• getStopwatch

  public com.google.common.base.Stopwatch getStopwatch()

  returns underlying stopwatch, which caller can inspect for more details or modify

• getLimit

  public Duration getLimit()

  how much total time this timer should run for

• getDurationElapsed

  public Duration getDurationElapsed()

  return how long the timer has been running (longer than limit if isExpired())

• getDurationRemaining

  public Duration getDurationRemaining()

  returns how much time is left (negative if isExpired())

• isExpired

  public boolean isExpired()

  true iff the timer has been running for the duration specified at creation time

• isRunning

  public boolean isRunning()

  true iff timer is running (even if it is expired)

• newInstanceStarted

  public static CountdownTimer newInstanceStarted(Duration duration)

• newInstancePaused

  public static CountdownTimer newInstancePaused(Duration duration)

• waitForExpiry

  public void waitForExpiry()
                     throws java.lang.InterruptedException

  block (on this object) until completed

  Throws:

  java.lang.InterruptedException

• waitForExpiryUnchecked

  public void waitForExpiryUnchecked()

  as waitForExpiry() but catches and wraps InterruptedException as unchecked RuntimeInterruptedExcedption

• waitOnForExpiry

  public boolean waitOnForExpiry(java.lang.Object waitTarget)
                          throws java.lang.InterruptedException

  block on the given argument until the timer is completed or the object receives a notified; callers must be synchronized on the waitTarget

  Returns:

  true if the object is notified (or receives a spurious wake), false if the duration is expired

  Throws:

  java.lang.InterruptedException

• waitOnForExpiryUnchecked

  public boolean waitOnForExpiryUnchecked(java.lang.Object waitTarget)

  as waitOnForExpiry(Object) but catches and wraps InterruptedException as unchecked RuntimeInterruptedExcedption