接口 TimerMBean

所有已知的实现类:
Timer

public interface TimerMBean
公开计时器 MBean 的管理接口。
自从:
1.5
  • 方法详情

    • start

      void start()
      启动定时器。

      如果通知列表中时间之前有一个或多个定时器通知,则根据sendPastNotifications标志发送通知,然后根据其周期和剩余出现次数更新。如果计时器通知日期仍然早于当前日期,则该通知只是从通知列表中删除。

    • stop

      void stop()
      停止计时器。
    • addNotification

      Integer  addNotification(String  type, String  message, Object  userData, Date  date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException
      使用指定的 typemessageuserData 创建新的计时器通知,并将其插入到具有给定日期、周期和发生次数的通知列表中。

      如果要插入的计时器通知的日期早于当前日期,则该方法的行为就像指定日期是当前日期一样。
      对于一次性通知,会立即发送通知。
      对于周期性通知,第一个通知会立即发送,后续通知的间隔时间由 period 参数指定。

      请注意,一旦将计时器通知添加到通知列表中,其关联的日期、周期和发生次数将无法更新。

      在定期通知的情况下,参数的值固定利率用于指定执行方案,如 Timer 中所指定。

      参数:
      type - 计时器通知类型。
      message - 计时器通知详细信息。
      userData - 计时器通知用户数据对象。
      date - 通知发生的日期。
      period - 计时器通知的周期(以毫秒为单位)。
      nbOccurences - 计时器通知将发出的总数。
      fixedRate - 如果 true 并且通知是周期性的,则通知会安排在固定利率执行方案。如果 false 并且通知是周期性的,则通知会安排在固定延迟执行方案。如果通知不是定期的,则忽略。
      返回:
      新创建的定时器通知的标识符。
      抛出:
      IllegalArgumentException - 日期为 null 或周期或出现次数为负数。
      参见:
    • addNotification

      Integer  addNotification(String  type, String  message, Object  userData, Date  date, long period, long nbOccurences) throws IllegalArgumentException
      使用指定的 typemessageuserData 创建新的计时器通知,并将其插入到具有给定日期、周期和发生次数的通知列表中。

      如果要插入的计时器通知的日期早于当前日期,则该方法的行为就像指定日期是当前日期一样。
      对于一次性通知,会立即发送通知。
      对于周期性通知,第一个通知会立即发送,后续通知的间隔时间由 period 参数指定。

      请注意,一旦将计时器通知添加到通知列表中,其关联的日期、周期和发生次数将无法更新。

      在定期通知的情况下,使用固定延迟Timer 中指定的执行方案。为了使用固定利率执行方案,请改用 addNotification(String, String, Object, Date, long, long, boolean)

      参数:
      type - 计时器通知类型。
      message - 计时器通知详细信息。
      userData - 计时器通知用户数据对象。
      date - 通知发生的日期。
      period - 计时器通知的周期(以毫秒为单位)。
      nbOccurences - 计时器通知将发出的总数。
      返回:
      新创建的定时器通知的标识符。
      抛出:
      IllegalArgumentException - 日期为 null 或周期或出现次数为负数。
      参见:
    • addNotification

      Integer  addNotification(String  type, String  message, Object  userData, Date  date, long period) throws IllegalArgumentException
      使用指定的 typemessageuserData 创建新的计时器通知,并将其插入到具有给定日期和时间段以及出现次数为空的通知列表中。

      定时器通知将使用定时器周期连续重复固定延迟Timer 中指定的执行方案。为了使用固定利率执行方案,请改用 addNotification(String, String, Object, Date, long, long, boolean)

      如果要插入的计时器通知的日期早于当前日期,则该方法的行为就像指定日期是当前日期一样。第一个通知立即发送,随后的通知间隔由 period 参数指定。

      参数:
      type - 计时器通知类型。
      message - 计时器通知详细信息。
      userData - 计时器通知用户数据对象。
      date - 通知发生的日期。
      period - 计时器通知的周期(以毫秒为单位)。
      返回:
      新创建的定时器通知的标识符。
      抛出:
      IllegalArgumentException - 日期为 null 或周期为负数。
    • addNotification

      Integer  addNotification(String  type, String  message, Object  userData, Date  date) throws IllegalArgumentException
      使用指定的 typemessageuserData 创建一个新的计时器通知,并将其插入到具有给定日期、空周期和出现次数的通知列表中。

      定时器通知将在指定日期处理一次。

      如果要插入的计时器通知的日期早于当前日期,则该方法的行为就像指定的日期是当前日期一样,并且会立即发送通知。

      参数:
      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 - 计时器通知类型。
      返回:
      Integer 对象的向量,包含具有指定 type 的计时器通知的所有标识符。
      如果没有为具有指定 type 的此计时器 MBean 注册的计时器通知,则向量为空。
    • 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)
      获取标志的副本,指示是否在执行定期通知固定延迟固定利率.
      参数:
      id - 计时器通知标识符。
      返回:
      标志的副本,指示是否执行定期通知固定延迟固定利率.
    • getSendPastNotifications

      boolean getSendPastNotifications()
      获取指示计时器是否发送过去通知的标志。
      返回:
      过去的通知发送开/关标志值。
      参见:
    • setSendPastNotifications

      void setSendPastNotifications(boolean value)
      设置指示计时器是否发送过去通知的标志。
      参数:
      value - 过去的通知发送开/关标志值。
      参见:
    • isActive

      boolean isActive()
      测试计时器 MBean 是否处于活动状态。当调用 start 方法时,计时器 MBean 被标记为活动。当调用 stop 方法时,它变为非活动状态。
      返回:
      true 如果计时器 MBean 处于活动状态,false 否则。
    • isEmpty

      boolean isEmpty()
      测试定时器通知列表是否为空。
      返回:
      true 如果计时器通知列表为空,false 否则。