com.nttdocomo.ui
クラス ShortTimer

Object
  com.nttdocomo.ui.ShortTimer

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

TimeKeeper

public final class ShortTimer

extends Object

implements TimeKeeper

短時間タイマクラスです。 ワンショットタイマとインターバルタイマをサポートしています。 タイマイベントを受け取るリスナとして Canvas オブジェクトを登録することができます。 タイマイベントが発生すると、キャンバスの低レベルイベントハンドラメソッドが呼び出されます。

時間のスコープはフレーム単位で、フレームが切り替わるとタイマも自動的に停止します。 一度停止した後、再度そのフレームに切り替わってもタイマは自動的に再開しません。 また、短時間タイマに関連付けられているキャンバスがスクリーンに表示されていないときに、 startメソッドが呼ばれた場合、startメソッドはなにもしません。

短時間タイマのオブジェクトに登録されているキャンバス上にダイアログが 表示されている場合は、そのダイアログが表示されている間、 そのキャンバスにはタイマイベントは通知されません。
[DoJa-3.0 (505i) 以降]
ただしタイマ自体は動作しており、start()、stop()メソッドは有効に動作します。

短時間タイマは、オブジェクトの生成時にネイティブのリソースを確保して、 dispose メソッドが呼ばれるまで解放されません。
[DoJa-2.0 以降]
アプリケーションがサスペンドした場合、短時間タイマは停止します。 すなわち、stop メソッドが呼ばれたのと同じ状態になります。

ミニマムスペック:

• [DoJa-2.0 以降] ミニマムスペックでは、短時間タイマのリソースは、全ての Canvas の合計で 5 個サポートしています。

関連項目:

Timer

コンストラクタの概要

protected

ShortTimer() アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの概要

void	dispose() タイマを破棄します。
int	getMinTimeInterval() サポートしているタイマイベント発生時間間隔の中で最小のものを取得します。
int	getResolution() タイマの解像度を取得します。
static ShortTimer	getShortTimer(Canvas canvas, int id, int time, boolean repeat) 短時間タイマオブジェクトを取得します。
void	start() タイマを開始します。
void	stop() タイマを停止します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ShortTimer

protected ShortTimer()

アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの詳細

getShortTimer

public static ShortTimer getShortTimer(Canvas canvas,
                                       int id,
                                       int time,
                                       boolean repeat)

短時間タイマオブジェクトを取得します。

引数 time には 0 以上の任意の値を指定することができますが、 実装サポート値以外の値を指定した場合には、 指定した値より大きく、かつ、 一番近い実装サポート値が指定されたものとして扱われます。

[DoJa-1.0 のみ]
同一のキャンバスオブジェクトで同一の識別子 ID を指定して短時間タイマオブジェクトを生成した場合の振舞は機種依存です。
[DoJa-2.0 以降]
同一のキャンバスオブジェクトで同一の識別子 ID を指定して短時間タイマオブジェクトを生成した場合は、例外が発生します。

パラメータ:

canvas - タイマイベントを通知するキャンバスオブジェクトを指定します。

id - タイマIDを指定します。

time - タイマイベント発生時間間隔をミリ秒単位で指定します。

repeat - 繰り返しタイマイベントを発生させる場合は true を、一度だけ発生させる場合は false を指定します。

戻り値:

短時間タイマオブジェクトを返します。

例外:

NullPointerException - 引数 canvas に null が指定された場合に発生します。

IllegalArgumentException - 引数 time に負の値が指定された場合に発生します。

UIException - [DoJa-2.0 以降] 同一キャンバスで取得済みのタイマと同一のIDを指定してタイマを生成しようとした場合に発生します(BUSY_RESOURCE)。

UIException - ネイティブのリソースが確保できなかった場合に投げられます(NO_RESOURCES)。

getResolution

public int getResolution()

インタフェース TimeKeeper の記述:

タイマの解像度を取得します。

タイマイベント発生時間間隔の実装サポート値は、 等差数列によってモデル化できますが、 その数列の公差をタイマの解像度と定義します。 詳細については TimeKeeper インタフェースの説明 を参照して下さい。
なお、タイマの解像度は、実装によって異なります。

定義:

インタフェース TimeKeeper 内の getResolution

戻り値:

タイマの解像度をミリ秒単位で返します。

getMinTimeInterval

public int getMinTimeInterval()

インタフェース TimeKeeper の記述:

サポートしているタイマイベント発生時間間隔の中で最小のものを取得します。

タイマイベント発生時間間隔の実装サポート値は、 等差数列によってモデル化できますが、 その数列の初項の値を取得します。 詳細については TimeKeeper インタフェースの説明 を参照して下さい。
なお、取得できる値は実装によって異なります。

定義:

インタフェース TimeKeeper 内の getMinTimeInterval

戻り値:

サポートしているタイマイベント発生時間間隔の中で最小の値を、 ミリ秒単位で返します。

start

public void start()

タイマを開始します。

定義:

インタフェース TimeKeeper 内の start

例外:

UIException - インターバルタイマで start メソッドが呼び出された後に start メソッドを使用しようとした場合、 または、ワンショットタイマで start メソッドが呼び出された後でタイマ通知がくる前に start メソッドを使用しようとした場合に発生します(ILLEGAL_STATE)。

UIException - ネイティブのリソースが確保できずタイマの開始に失敗した場合に投げられます(NO_RESOURCES)。

stop

public void stop()

タイマを停止します。 タイマが停止しているときにこのメソッドが呼ばれた場合はなにもしません。

定義:

インタフェース TimeKeeper 内の stop

dispose

public void dispose()

タイマを破棄します。 このメソッドを呼び出した後に dispose 以外のメソッドを呼び出した場合は UIException が発生します(ILLEGAL_STATE)。 このメソッドを呼び出した後に dispose メソッドを呼び出した場合は何もしません。

定義:

インタフェース TimeKeeper 内の dispose