javax.servlet.sip
インタフェース ServletTimer

public interface ServletTimer

将来のタスクをスケジュールしたいサーブレットアプリケーションのために、TimerServiceによって作成されます。

メソッドの概要

void	cancel() このタイマをキャンセルします。
SipApplicationSession	getApplicationSession() このServletTimerに関連づけられたアプリケーションセッションを返します。
java.io.Serializable	getInfo() 作成時にタイマに関連付けられた情報を獲得します。
long	scheduledExecutionTime() このタイマが実際一番最近に期限切れになる予定時間を返します。

メソッドの詳細

cancel

public void cancel()

このタイマをキャンセルします。
タスクが、一度きりの実行を予定されており、まだ期限切れしていない場合、または、まだ予定されていない場合は、動作しません。
タスクが繰り返しの実行を予定されている場合は、再度終了しません。
このメソッドを、TimerListenerのtimerFiredメソッド内から、繰り返しServletTimerで呼び出すと、
（予定されない限り）タイマが再度作動しないことに注意してください。 このメソッドは、繰り返し呼び出される可能性がある。２番目および後続の呼には影響はない。

getApplicationSession

public SipApplicationSession getApplicationSession()

このServletTimerに関連づけられたアプリケーションセッションを返します。

戻り値:

このServletTimerに関連づけられたアプリケーションセッションを返します

getInfo

public java.io.Serializable getInfo()

作成時にタイマに関連付けられた情報を獲得します。

戻り値:

タイマ作成時に渡されたSerializableオブジェクトを返します。タイマ作成時に渡された情報引数がnullの場合はnullを返します。

scheduledExecutionTime

public long scheduledExecutionTime()

このタイマが実際一番最近に期限切れになる予定時間を返します。
このメソッドは通常、タイマコールバックが予定のアクティビティの実行を保証するため十分にタイムリーであるかを特定するため、TimerListener.timerFired内から呼び出されます。
public void run() { if (System.currentTimeMillis() - scheduledExecutionTime() >= 　　　　MAX_TARDINESS) 　　　　return; // Too late; skip this execution. 　　　　// Perform the task }
このメソッドは通常、固定の遅延実行繰り返しタスクと連携して使用されません。 それらタスクの予定実行時間は、時間のずれを許可せず、また非常に重要でもないためです。

戻り値:

このタイマの一番最近の期限切れ予定時間を、Date.getTimer()によって戻される形式で返します。タイマがまだ一度も切れていない場合は、戻り値は未定義です。