java.util
クラス TimerTask

java.lang.Object
  java.util.TimerTask

すべての実装されたインタフェース:

Runnable

public abstract class TimerTask
extends Object
implements Runnable

Timer クラスによってスケジュールされるタスクです。 このクラスは抽象クラスとして宣言されており、タスクはこのクラスのサブクラスで run() メソッドをオーバーライドして実装します。

このクラスは Mobile Information Device Profile に所属しています。 MID Profile を含まない環境では使用できません。

導入されたバージョン:

MIDP-1.0

関連項目:

Timer

TimerTask

protected TimerTask()

タイマータスクのオブジェクトを構築します。

run

public abstract void run()

タイマーによってスケジュールされたタスクが起動される抽象メソッドです。 サブクラスでこのメソッドに対してタスクとして実行する内容を実装します。

定義:

インタフェース Runnable 内の run

cancel

public boolean cancel()

このタスクをキャンセルします。 指定されたタスクはスケジュールから外され、実行されることはなくなります。 このメソッドが呼び出された時に該当するタスクが実行中の場合はタスクの実行自体は停止されませんが、次回のスケジュールからは外されるため再度起動されることはありません。

このメソッドは繰り返し呼び出すことができますが、２度目以降の呼び出しは何も処理を行いません。

戻り値:

タスクがスケジュールに存在し、それを取り除いた場合は true、それ以外の場合は false を返します。

scheduledExecutionTime

public long scheduledExecutionTime()

このタスクを実行するようにスケジュールされた実際の時間を返します。 実行中のタスクがこのメソッドを呼び出した場合はそのタスク自身がスケジュールされた時間を返します。

このメソッドを使用することにより、タスクの実行に遅延が生じているか否かを判定することができます。 例えば時間どおりにタスクが起動されなかった場合はタスクの処理を見送るような記述を、

 public void run()
 {
     if(System.currentTimeMillis() - scheduledExecutionTime() >= 最大許容遅延時間 ) {
         return;  // 遅延許容範囲を超えている場合は処理をしない。
     }
 }

というように記述することができます。

通常、このメソッドは Timer クラスの Timer.schedule(java.util.TimerTask, long) メソッドと組み合わせて使用します。 固定の間隔で呼び出されるスケジュールを行う Timer.scheduleAtFixedRate(java.util.TimerTask, long, long) メソッドと組み合わせて使用することは特定の場合に限られるでしょう。

戻り値:

このタスクがスケジュールされている最近のミリ秒表現による日時を返します。タスクが一度も起動されていない場合に返す値は未定義です。

関連項目:

Date.getTime()