CountDownTimer

Summary: Ctors | Methods | Inherited Methods

public abstract class CountDownTimer
extends Object

Schedule a countdown until a time in the future, with regular notifications on intervals along the way. Example of showing a 30 second countdown in a text field:

Kotlin

 object : CountDownTimer(30000, 1000) {

     override fun onTick(millisUntilFinished: Long) {
         mTextField.setText("seconds remaining: " + millisUntilFinished / 1000)
     }

     override fun onFinish() {
         mTextField.setText("done!")
     }
 }.start()

Java

 new CountDownTimer(30000, 1000) {

     public void onTick(long millisUntilFinished) {
         mTextField.setText("seconds remaining: " + millisUntilFinished / 1000);
     }

     public void onFinish() {
         mTextField.setText("done!");
     }
 }.start();

The calls to onTick(long) are synchronized to this object so that one call to onTick(long) won't ever occur before the previous callback is complete. This is only relevant when the implementation of onTick(long) takes an amount of time to execute that is significant compared to the countdown interval.

Summary

Public constructors
`CountDownTimer(long millisInFuture, long countDownInterval)`

Public methods
`final void`	`cancel()` Cancel the countdown.
`abstract void`	`onFinish()` Callback fired when the time is up.
`abstract void`	`onTick(long millisUntilFinished)` Callback fired on regular interval.
`final CountDownTimer`	`start()` Start the countdown.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

public CountDownTimer (long millisInFuture, 
                long countDownInterval)

Parameters
`millisInFuture`	`long`: The number of millis in the future from the call to `start()` until the countdown is done and `onFinish()` is called.
`countDownInterval`	`long`: The interval along the way to receive `onTick(long)` callbacks.

Public methods

cancel

public final void cancel ()

Cancel the countdown.

onFinish

public abstract void onFinish ()

Callback fired when the time is up.

onTick

public abstract void onTick (long millisUntilFinished)

Callback fired on regular interval.

Parameters
`millisUntilFinished`	`long`: The amount of time until finished.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.