com.docomostar.util
インタフェース TimeKeeper

既知の実装クラスの一覧:

Timer

public interface TimeKeeper

タイマのインタフェースを定義します。 このインタフェースは、 タイマを実装するクラスが持つべきインタフェースを規定します。

タイマの実装は、 指定された時間が経過した時点でタイマイベントを発生し、 そのイベントを、何らかの方法でアプリケーションに通知します。 このタイマイベント発生時間間隔の指定方法や、イベントの通知方法は、 このインタフェースでは定義しません。

なお、アプリケーション開発者が指定した通りの時間間隔では、 タイマイベントを発生できない実装も存在するため、 このインタフェースではそのような機種依存情報を取得するためのメソッドを用意しています。 はじめに、以下の2つの用語を定義します。

(タイマイベント発生時間間隔の)プログラマ指定値:

アプリケーション開発者がメソッドの引数として指定した、 タイマイベント発生時間間隔。 このインタフェースの実装クラスでは、 Timer.setTime(int time) の time 引数に指定する値が該当します。

(タイマイベント発生時間間隔の)実装サポート値:

実装がサポートしているタイマイベント発生時間間隔。 言い換えると、上記 time 引数に実装サポート値を指定した場合のみ、 プログラマ指定値通りの時間間隔でタイマイベントが発生します。

このインタフェースでは、 実装サポート値の集合を等差数列としてモデル化しています。

ワンショットタイマの場合、 初項はgetMinTimeInterval()、 公差はgetResolution()で表します。 すなわち、実装サポート値の集合は、

 { Ti | Ti = getMinTimeInterval() + getResolution() * i }  (i = 0, 1, 2, ...)
 

となります。

また、リピートタイマの場合、 原則として初項、公差ともにgetResolution()で表します。 すなわち、実装サポート値の集合は、

 { Ti | Ti = getResolution() * (i + 1) }  (i = 0, 1, 2, ...)
 

となります。
ただし、リピートタイマを開始してから1回目のイベントが発生するまでの間隔については、 指定した間隔と異なる場合があります。詳しくは Timer.setTime(int)を参照してください。

実装サポート値以外の値をタイマイベント発生時間間隔として指定した場合の振る舞いは、 このインタフェースでは定義しません。各実装クラスの説明を参照して下さい。

導入されたバージョン:

Star-1.0

メソッドの概要

void	dispose() タイマを破棄します。
int	getMinTimeInterval() ワンショットタイマがサポートしているイベント発生時間間隔の中で最小のものを取得します。
int	getResolution() タイマの解像度を取得します。
void	start() タイマを開始します。
void	stop() タイマを停止します。

メソッドの詳細

getResolution

int getResolution()

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

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

戻り値:

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

getMinTimeInterval

int getMinTimeInterval()

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

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

戻り値:

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

start

void start()

タイマを開始します。

stop

void stop()

タイマを停止します。

dispose

void dispose()

タイマを破棄します。