lightbulb_outline Please take our October 2018 developer survey. Start survey
added in API level 1

CountDownTimer

public abstract class CountDownTimer
extends Object

java.lang.Object
   ↳ android.os.CountDownTimer


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:

 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

Public constructors

CountDownTimer

added in API level 1
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

added in API level 1
public final void cancel ()

Cancel the countdown.

onFinish

added in API level 1
public abstract void onFinish ()

Callback fired when the time is up.

onTick

added in API level 1
public abstract void onTick (long millisUntilFinished)

Callback fired on regular interval.

Parameters
millisUntilFinished long: The amount of time until finished.

start

added in API level 1
public final CountDownTimer start ()

Start the countdown.

Returns
CountDownTimer