NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential

com.docomo_um.util
クラス Timer

java.lang.Object
  上位を拡張 com.docomo_um.util.Timer

public class Timer
extends java.lang.Object

タイマクラスです。

タイマイベントを受け取るにはリスナとしてTimerListenerオブジェクトを登録する必要があります。

関連項目:
TimerListener

コンストラクタの概要
Timer()
          インスタンスを生成します。
 
メソッドの概要
 void dispose()
          タイマを破棄します。
 int getResolution()
          タイマの解像度を取得します。
 void setTimerListener(boolean repeat, int time, TimerListener listener)
          リスナを登録します。
 void start()
          タイマを開始します。
 void stop()
          タイマを停止します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

コンストラクタの詳細

Timer

public Timer()
インスタンスを生成します。

メソッドの詳細

setTimerListener

public void setTimerListener(boolean repeat,
                             int time,
                             TimerListener listener)
                      throws TimerException
リスナを登録します。

このインスタンスに登録できるリスナは1つだけです。 このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。 null を指定すると、リスナの登録を削除します。

パラメータ:
repeat - タイマイベントを繰り返し発生させる場合は true を、一度だけ発生させる場合は falseを指定します。
time - タイマイベント発生時間間隔をmsec単位で指定します。 0以上の任意の値を指定することができますが、実装サポート値以外の値を指定した場合には、指定した値より大きく、かつ、一番近い実装サポート値が指定されたものとして扱われます。
listener - タイマイベントを受け取るリスナを指定します。
例外:
java.lang.IllegalArgumentException - 引数で指定した値が不正の場合に発生します。
java.lang.IllegalStateException - 既にタイマが開始されている場合、もしくはタイマが破棄されている場合に発生します。
TimerException - 内部エラーにより処理が中断した場合に発生します。

getResolution

public int getResolution()
                  throws TimerException
タイマの解像度を取得します。

戻り値:
タイマの解像度をミリ秒単位で返します。
例外:
java.lang.IllegalStateException - 既に破棄されている場合に発生します。
TimerException - 内部エラーにより処理が中断した場合に発生します。

start

public void start()
           throws TimerException
タイマを開始します。

タイマを開始するには、事前にsetTimerListener(boolean, int, TimerListener)を呼び出す必要があります。 呼び出さずにタイマを開始しようとした場合、IllegalStateExceptionが発生します。
システム内で同時に実行できるタイマの個数は通信モジュールの実装に依存します。

例外:
java.lang.IllegalStateException - 既にタイマが開始されている場合、リスナが登録されていない場合、もしくはタイマが破棄されている場合に発生します。
TimerException - 同時に実行できるタイマの個数を超えてタイマを開始しようとした場合、または、内部エラーにより処理が中断した場合に発生します。

stop

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

例外:
java.lang.IllegalStateException - 既に破棄されている場合に発生します。
TimerException - 内部エラーにより処理が中断した場合に発生します。

dispose

public void dispose()
タイマを破棄します。 タイマが破棄されているときにこのメソッドが呼ばれた場合はなにもしません。

タイマ破棄後は全てのメソッドが使用出来なくなります。


Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.