モジュール java.management
パッケージ javax.management.timer

インタフェースTimerMBean

既知のすべての実装クラス:
Timer
public interface TimerMBean
タイマーMBeanの管理インタフェースを公開します。
導入されたバージョン:
1.5

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    Integer addNotification​(String type, String message, Object userData, Date date)
    指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔null、およびオカレンス数とともに通知リストに挿入します。
    Integer addNotification​(String type, String message, Object userData, Date date, long period)
    指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔null、およびオカレンス数とともに通知リストに挿入します。
    Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences)
    指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔、およびオカレンス数とともに通知リストに挿入します。
    Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate)
    指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔、およびオカレンス数とともに通知リストに挿入します。
    Vector<Integer> getAllNotificationIDs()
    通知リストに登録されているすべてのタイマー通知識別子を取得します。
    Date getDate​(Integer id)
    タイマー通知に関連付けられている日付のコピーを取得します。
    Boolean getFixedRate​(Integer id)
    定期通知をfixed-delayで実行するかfixed-rateで実行するかを示すフラグのコピーを取得します。
    int getNbNotifications()
    通知リストに登録されているタイマー通知の数を取得します。
    Long getNbOccurences​(Integer id)
    タイマー通知に関連付けられている残りの発行数のコピーを取得します。
    Vector<Integer> getNotificationIDs​(String type)
    指定されたタイプに対応するすべてのタイマー通知識別子を取得します。
    String getNotificationMessage​(Integer id)
    指定された識別子に対応するタイマー通知の詳細メッセージを取得します。
    String getNotificationType​(Integer id)
    指定された識別子に対応するタイマー通知タイプを取得します。
    Object getNotificationUserData​(Integer id)
    指定された識別子に対応するタイマー通知のユーザー・データ・オブジェクトを取得します。
    Long getPeriod​(Integer id)
    タイマー通知に関連付けられている間隔(ミリ秒)のコピーを取得します。
    boolean getSendPastNotifications()
    タイマーが過去の通知を送信するかどうかを示すフラグを取得します。
    boolean isActive()
    タイマーMBeanがアクティブかどうかをテストします。
    boolean isEmpty()
    タイマー通知のリストが空かどうかを判定します。
    void removeAllNotifications()
    通知リストからすべてのタイマー通知を削除し、タイマー通知識別子を更新するためのカウンタをリセットします。
    void removeNotification​(Integer id)
    指定された識別子に対応するタイマー通知を通知リストから削除します。
    void removeNotifications​(String type)
    指定されたタイプに対応するすべてのタイマー通知を通知リストから削除します。
    void setSendPastNotifications​(boolean value)
    タイマーが過去の通知を送信するかどうかを示すフラグを設定します。
    void start()
    タイマーを起動します。
    void stop()
    タイマーを停止します。

  • メソッドの詳細

    • start

      void start()
      タイマーを起動します。

      通知リスト内に、その時間より前に発行されたタイマー通知が1つ以上ある場合、この通知はsendPastNotificationsフラグに従って送信され、間隔と残りの発行数に従って更新されます。 タイマー通知の日付が現在の日付より前の場合、この通知は通知リストから削除されます。

    • stop

      void stop()
      タイマーを停止します。

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException
      指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔、およびオカレンス数とともに通知リストに挿入します。

      挿入されるタイマー通知の日付が現在の日付より前の場合、このメソッドは、指定された日付が現在の日付であるとして動作します。
      1回だけの通知は、ただちに配信されます。
      定期的な通知の場合、最初の通知はただちに配信され、以降の通知は間隔パラメータで指定された間隔で配信されます。

      タイマー通知が通知リストに追加されたあと、関連付けられている日付、間隔、および発行数を更新することはできません。

      定期通知の場合、Timerに指定されているように、fixedRateパラメータの値が実行スキームの指定に使用されます。

      パラメータ:
      type - タイマー通知タイプ。
      message - タイマー通知の詳細メッセージ。
      userData - タイマー通知のユーザー・データ・オブジェクト。
      date - 通知が発行される日付。
      period - タイマー通知の間隔(ミリ秒)。
      nbOccurences - 発行されるタイマー通知の合計数。
      fixedRate - trueであり、定期通知である場合、fixed-rate実行スキームでスケジュールされる。 falseであり、定期通知である場合、fixed-delay実行スキームでスケジュールされる。 定期通知でない場合は無視される。
      戻り値:
      新しく作成されたタイマー通知の識別子。
      例外:
      IllegalArgumentException - 日付がnullであるか、間隔または発行数が負の値の場合。
      関連項目:
      addNotification(String, String, Object, Date, long, long)

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException
      指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔、およびオカレンス数とともに通知リストに挿入します。

      挿入されるタイマー通知の日付が現在の日付より前の場合、このメソッドは、指定された日付が現在の日付であるとして動作します。
      1回だけの通知は、ただちに配信されます。
      定期的な通知の場合、最初の通知はただちに配信され、以降の通知は間隔パラメータで指定された間隔で配信されます。

      タイマー通知が通知リストに追加されたあと、関連付けられている日付、間隔、および発行数を更新することはできません。

      定期通知の場合、Timerに指定されているようにfixed-delay実行スキームを使用します。 fixed-rate実行スキームを使用するには、代わりにaddNotification(String, String, Object, Date, long, long, boolean)を使用します。

      パラメータ:
      type - タイマー通知タイプ。
      message - タイマー通知の詳細メッセージ。
      userData - タイマー通知のユーザー・データ・オブジェクト。
      date - 通知が発行される日付。
      period - タイマー通知の間隔(ミリ秒)。
      nbOccurences - 発行されるタイマー通知の合計数。
      戻り値:
      新しく作成されたタイマー通知の識別子。
      例外:
      IllegalArgumentException - 日付がnullであるか、間隔または発行数が負の値の場合。
      関連項目:
      addNotification(String, String, Object, Date, long, long, boolean)

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date, long period) throws IllegalArgumentException
      指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔null、およびオカレンス数とともに通知リストに挿入します。

      タイマー通知は、Timerに指定されているように、fixed-delay実行スキームを使用するタイマー間隔で連続的に繰り返されます。 fixed-rate実行スキームを使用するには、代わりにaddNotification(String, String, Object, Date, long, long, boolean)を使用します。

      挿入されるタイマー通知の日付が現在の日付より前の場合、このメソッドは、指定された日付が現在の日付であるとして動作します。 最初の通知はただちに配信され、以降の通知は間隔パラメータで指定された間隔で配信されます。

      パラメータ:
      type - タイマー通知タイプ。
      message - タイマー通知の詳細メッセージ。
      userData - タイマー通知のユーザー・データ・オブジェクト。
      date - 通知が発行される日付。
      period - タイマー通知の間隔(ミリ秒)。
      戻り値:
      新しく作成されたタイマー通知の識別子。
      例外:
      IllegalArgumentException - 日付がnullであるか、間隔が負の値の場合。

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date) throws IllegalArgumentException
      指定されたtype、message、およびuserDataで新しいタイマー通知を作成し、これを指定の日付、間隔null、およびオカレンス数とともに通知リストに挿入します。

      タイマー通知は指定された日付にまとめて処理されます。

      挿入されるタイマー通知の日付が現在の日付より前の場合、このメソッドは、指定された日付が現在の日付であるとして動作します。通知はただちに配信されます。

      パラメータ:
      type - タイマー通知タイプ。
      message - タイマー通知の詳細メッセージ。
      userData - タイマー通知のユーザー・データ・オブジェクト。
      date - 通知が発行される日付。
      戻り値:
      新しく作成されたタイマー通知の識別子。
      例外:
      IllegalArgumentException - 日付がnullである場合。

    • removeNotification

      void removeNotification​(Integer id) throws InstanceNotFoundException
      指定された識別子に対応するタイマー通知を通知リストから削除します。
      パラメータ:
      id - タイマー通知識別子。
      例外:
      InstanceNotFoundException - このタイマーMBeanの通知リスト内に、指定された識別子に対応するタイマー通知が存在しない。

    • removeNotifications

      void removeNotifications​(String type) throws InstanceNotFoundException
      指定されたタイプに対応するすべてのタイマー通知を通知リストから削除します。
      パラメータ:
      type - タイマー通知タイプ。
      例外:
      InstanceNotFoundException - このタイマーMBeanの通知リスト内に、指定されたタイプに対応するタイマー通知が存在しない。

    • removeAllNotifications

      void removeAllNotifications()
      通知リストからすべてのタイマー通知を削除し、タイマー通知識別子を更新するためのカウンタをリセットします。

    • getNbNotifications

      int getNbNotifications()
      通知リストに登録されているタイマー通知の数を取得します。
      戻り値:
      タイマー通知の数。

    • getAllNotificationIDs

      Vector<Integer> getAllNotificationIDs()
      通知リストに登録されているすべてのタイマー通知識別子を取得します。
      戻り値:
      すべてのタイマー通知識別子を含むIntegerオブジェクトのベクトル。
      このタイマーMBeanにタイマー通知が登録されていない場合は空。

    • getNotificationIDs

      Vector<Integer> getNotificationIDs​(String type)
      指定されたタイプに対応するすべてのタイマー通知識別子を取得します。
      パラメータ:
      type - タイマー通知タイプ。
      戻り値:
      指定されたtypeのすべてのタイマー通知識別子を含むIntegerオブジェクトのベクトル。
      このタイマーMBeanに指定されたtypeのタイマー通知が登録されていない場合は空。

    • getNotificationType

      String getNotificationType​(Integer id)
      指定された識別子に対応するタイマー通知タイプを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      タイマー通知タイプ。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getNotificationMessage

      String getNotificationMessage​(Integer id)
      指定された識別子に対応するタイマー通知の詳細メッセージを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      タイマー通知の詳細メッセージ。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getNotificationUserData

      Object getNotificationUserData​(Integer id)
      指定された識別子に対応するタイマー通知のユーザー・データ・オブジェクトを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      タイマー通知のユーザー・データ・オブジェクト。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getDate

      Date getDate​(Integer id)
      タイマー通知に関連付けられている日付のコピーを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      日付のコピー。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getPeriod

      Long getPeriod​(Integer id)
      タイマー通知に関連付けられている間隔(ミリ秒)のコピーを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      間隔のコピー。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getNbOccurences

      Long getNbOccurences​(Integer id)
      タイマー通知に関連付けられている残りの発行数のコピーを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      残りの発行数のコピー。識別子がこのタイマーMBeanに登録されたタイマー通知に対応していない場合はnull。

    • getFixedRate

      Boolean getFixedRate​(Integer id)
      定期通知をfixed-delayで実行するかfixed-rateで実行するかを示すフラグのコピーを取得します。
      パラメータ:
      id - タイマー通知識別子。
      戻り値:
      定期通知をfixed-delayで実行するかfixed-rateで実行するかを示すフラグのコピー。

    • getSendPastNotifications

      boolean getSendPastNotifications()
      タイマーが過去の通知を送信するかどうかを示すフラグを取得します。
      戻り値:
      過去の通知を送信するかどうかを指定するフラグ値。
      関連項目:
      setSendPastNotifications(boolean)

    • setSendPastNotifications

      void setSendPastNotifications​(boolean value)
      タイマーが過去の通知を送信するかどうかを示すフラグを設定します。
      パラメータ:
      value - 過去の通知を送信するかどうかを指定するフラグ値。
      関連項目:
      getSendPastNotifications()

    • isActive

      boolean isActive()
      タイマーMBeanがアクティブかどうかをテストします。 タイマーMBeanは、startメソッドが呼び出されるとアクティブになります。 stopメソッドが呼び出されると非アクティブになります。
      戻り値:
      タイマーMBeanがアクティブな場合はtrue、そうでない場合はfalse。

    • isEmpty

      boolean isEmpty()
      タイマー通知のリストが空かどうかを判定します。
      戻り値:
      タイマー通知のリストが空の場合はtrue、そうでない場合はfalse。