com.docomostar.util
クラス Timer

Object
  com.docomostar.util.Timer

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

TimeKeeper

public final class Timer
extends Object
implements TimeKeeper

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

時間のスコープはアプリケーション単位です。

タイマは、開始時にネイティブのリソースを確保して、停止時に解放します。

アプリケーションがサスペンドした場合、タイマは停止します。 すなわち、stop メソッドが呼ばれたのと同じ状態になります。

ミニマムスペック:

• ミニマムスペックでは、タイマのリソースは 10 個サポートしています。

導入されたバージョン:

Star-1.0

コンストラクタの概要

Timer()
タイマオブジェクトを生成します。

メソッドの概要

void	dispose() タイマを破棄します。
int	getMinTimeInterval() ワンショットタイマがサポートしているイベント発生時間間隔の中で最小のものを取得します。
int	getResolution() タイマの解像度を取得します。
void	setListener(TimerListener listener) タイマイベントを受け取るリスナオブジェクトを設定します。
void	setRepeat(boolean b) タイマイベントを繰り返し発生させるかどうかを設定します。
void	setTime(int time) タイマイベント発生時間間隔を設定します。
void	start() タイマを開始します。
void	stop() タイマを停止します。

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

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

コンストラクタの詳細

Timer

public Timer()

タイマオブジェクトを生成します。 このコンストラクタでは、繰り返しなし(ワンショットタイマ), 設定時間 0ms、 リスナ登録なしに初期化します。

メソッドの詳細

getResolution

public int getResolution()

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

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

なお、タイマの解像度は、実装によって異なります。

定義:

インタフェース TimeKeeper 内の getResolution

戻り値:

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

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

getMinTimeInterval

public int getMinTimeInterval()

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

ワンショットタイマがサポートしているイベント発生時間間隔の中で最小のものを取得します。
リピートタイマの一回目のイベント発生時間間隔の最小値は、このメソッドから取得できる値となります。

なお、取得できる値は実装によって異なります。

定義:

インタフェース TimeKeeper 内の getMinTimeInterval

戻り値:

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

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

start

public void start()

タイマを開始します。

定義:

インタフェース TimeKeeper 内の start

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

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

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

stop

public void stop()

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

定義:

インタフェース TimeKeeper 内の stop

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

dispose

public void dispose()

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

定義:

インタフェース TimeKeeper 内の dispose

setRepeat

public void setRepeat(boolean b)

タイマイベントを繰り返し発生させるかどうかを設定します。 デフォルトでは一度だけ発生させるように設定されます。

パラメータ:

b - 繰り返し発生させる場合は true を、一度だけ発生させる場合は false を指定します。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

UIException -
(ILLEGAL_STATE)
startメソッドが呼び出された後にこのメソッドを呼び出そうとした場合に発生します。

setTime

public void setTime(int time)

タイマイベント発生時間間隔を設定します。

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

またリピートタイマにおいて、引数がgetMinTimeInterval()より小さい場合、 一回目のタイマイベント発生時間間隔のみgetMinTimeInterval()となります。

パラメータ:

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

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。

UIException -
(ILLEGAL_STATE)
startメソッドが呼び出された後にこのメソッドを呼び出そうとした場合に発生します。

IllegalArgumentException -
引数のtimeが負の値の場合に発生します。

setListener

public void setListener(TimerListener listener)

タイマイベントを受け取るリスナオブジェクトを設定します。 タイマイベントが発生すると、指定されたリスナオブジェクトの timeExpired メソッドが呼び出されます。 リスナは一つだけしか設定できません。 複数指定された場合は最後に設定されたものだけが有効になります。

タイマを開始した後にリスナを設定した場合は、リスナを設定した次のタイマイベントからそのリスナに通知されます。

パラメータ:

listener - リスナオブジェクトを指定します。リスナオブジェクトとして null を指定するとリスナの登録を解除します。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose されているタイマに対して呼ばれた場合に発生します。