Timer (Jakarta EE Platform API)

```
public interface Timer
```
Timer インターフェースには、Enterprise Bean タイマーサービスを介して作成されたタイマーに関する情報が含まれています。
導入:
EJB 2.1

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`void`	`cancel()` タイマーとそれに関連するすべての期限切れ通知をキャンセルします。
`TimerHandle`	`getHandle()` タイマーの直列化可能なハンドルを取得します。
`SerializableSE`	`getInfo()` 作成時にタイマーに関連付けられた情報を取得します。
`DateSE`	`getNextTimeout()` 次のタイマー満了が発生するようにスケジュールされている時点を取得します。
`ScheduleExpression`	`getSchedule()` このタイマーに対応するスケジュール式を取得します。
`long`	`getTimeRemaining()` 次にスケジュールされているタイマーの期限切れまでに経過するミリ秒数を取得します。
`boolean`	`isCalendarTimer()` このタイマーがカレンダーベースのタイマーかどうかを返します。
`boolean`	`isPersistent()` このタイマーに永続的なセマンティクスがあるかどうかを返します。

- メソッドの詳細
  - cancel
```
void cancel()
     throws IllegalStateExceptionSE,
            NoSuchObjectLocalException,
            EJBException
```
    タイマーとそれに関連するすべての期限切れ通知をキャンセルします。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
  - getTimeRemaining
```
long getTimeRemaining()
               throws IllegalStateExceptionSE,
                      NoSuchObjectLocalException,
                      NoMoreTimeoutsException,
                      EJBException
```
    次にスケジュールされているタイマーの期限切れまでに経過するミリ秒数を取得します。
    戻り値:
    次にスケジュールされているタイマーの有効期限が切れるまでに経過するミリ秒数。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoMoreTimeoutsException - タイマーに将来のタイムアウトがないことを示します
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
  - getNextTimeout
```
DateSE getNextTimeout()
             throws IllegalStateExceptionSE,
                    NoSuchObjectLocalException,
                    NoMoreTimeoutsException,
                    EJBException
```
    次のタイマー満了が発生するようにスケジュールされている時点を取得します。
    戻り値:
    次のタイマー満了が発生するようにスケジュールされている時点。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoMoreTimeoutsException - タイマーに将来のタイムアウトがないことを示します
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
  - getSchedule
```
ScheduleExpression getSchedule()
                        throws IllegalStateExceptionSE,
                               NoSuchObjectLocalException,
                               EJBException
```
    このタイマーに対応するスケジュール式を取得します。タイマーはカレンダーベースのタイマーでなければなりません。自動またはプログラムで作成された可能性があります。
    戻り値:
    タイマーのスケジュール式。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。カレンダーベースのタイマーではないタイマーで呼び出された場合にもスローされます。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
    導入:
    EJB 3.1
  - isPersistent
```
boolean isPersistent()
              throws IllegalStateExceptionSE,
                     NoSuchObjectLocalException,
                     EJBException
```
    このタイマーに永続的なセマンティクスがあるかどうかを返します。
    戻り値:
    タイマーが永続的かどうかを示すブール。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
    導入:
    EJB 3.1
  - isCalendarTimer
```
boolean isCalendarTimer()
                 throws IllegalStateExceptionSE,
                        NoSuchObjectLocalException,
                        EJBException
```
    このタイマーがカレンダーベースのタイマーかどうかを返します。
    戻り値:
    タイマーがカレンダーベースかどうかを示すブール。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
    導入:
    EJB 3.1
  - getInfo
```
SerializableSE getInfo()
              throws IllegalStateExceptionSE,
                     NoSuchObjectLocalException,
                     EJBException
```
    作成時にタイマーに関連付けられた情報を取得します。これは、タイマー作成メソッドに渡された info 文字列、または Schedule アノテーションの info 要素である可能性があります。
    戻り値:
    タイマーの作成時に渡された Serializable オブジェクト、またはタイマーの作成時に渡された info 引数が null の場合は null。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
  - getHandle
```
TimerHandle getHandle()
               throws IllegalStateExceptionSE,
                      NoSuchObjectLocalException,
                      EJBException
```
    タイマーへの直列化可能なハンドルを取得します。このハンドルは、後でタイマー参照を取得するために使用できます。
    戻り値:
    タイマーへのシリアライズ可能なハンドル。
    例外:
    IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。非永続タイマーで呼び出された場合にもスローされます。
    NoSuchObjectLocalException - 期限切れまたはキャンセルされたタイマーで呼び出された場合。
    EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。

インターフェース Timer

メソッドのサマリー

メソッドの詳細

cancel

getTimeRemaining

getNextTimeout

getSchedule

isPersistent

isCalendarTimer

getInfo

getHandle