Android APIs
public abstract class

CountDownTimer

extends Object
java.lang.Object
   ↳ android.os.CountDownTimer

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CountDownTimer (long millisInFuture, long countDownInterval)

Added in API level 1

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

Public Methods

public final void cancel ()

Added in API level 1

Cancel the countdown.

public abstract void onFinish ()

Added in API level 1

Callback fired when the time is up.

public abstract void onTick (long millisUntilFinished)

Added in API level 1

Callback fired on regular interval.

Parameters
millisUntilFinished The amount of time until finished.

public final CountDownTimer start ()

Added in API level 1

Start the countdown.

Returns
CountDownTimer