当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

TimerMBean (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

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	getAllNotificationIDs()           获得所有在通知的列表中注册的计时器通知标识符。
Date	getDate(Integer id)           获得与计时器通知关联的日期的一个副本。
Boolean	getFixedRate(Integer id)           获得此种标志的一个副本，该标志指示是以固定延迟 方式执行定期通知，还是以固定速率 方式执行。
int	getNbNotifications()           获得在通知的列表中注册的计时器通知数。
Long	getNbOccurences(Integer id)           获得与计时器通知关联的剩余出现数量的一个副本。
Vector	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()

启动计时器。

如果有一个或多个计时器通知早于通知列表中的时间，则将根据 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 的新计时器通知，并将其插入到带有给定日期、时段和出现数量的通知列表中。

如果要插入的计时器通知其日期早于当前的日期，则该方法具有把指定的日期当做当前日期的行为。
对于“一次性”通知，将立即发出该通知。
对于定期通知，将立即发出第一个通知，而后续通知将根据 period 参数指定的间隔提供。

注意，一旦将计时器通知添加到通知列表中，将不能更新其相关的日期、时段和出现数量。

如果是定期通知，则参数 fixedRate 的值将用来指定执行方案，如在 Timer 中指定的那样。

参数：

type - 计时器通知类型。

message - 计时器通知详细消息。

userData - 计时器通知用户数据对象。

date - 发出通知时的日期。

period - 计时器通知的时段（以毫秒为单位）。

nbOccurences - 将发出的计时器通知的总数。

fixedRate - 如果为 true 并且通知是定期的，则使用固定速率 执行方案安排该通知。如果为 false 并且通知是定期的，则使用固定延迟 执行方案安排通知。如果通知不是定期的，则将被忽略。

返回：

新创建的计时器通知的标识符。

抛出：

IllegalArgumentException - 如果 period 或出现的数量为负数

另请参见：

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 的新计时器通知，并将其插入到带有给定日期、时段和出现数量的通知列表中。

如果要插入的计时器通知其日期早于当前的日期，则该方法具有把指定的日期当做当前日期的行为。
对于“一次性”通知，将立即发出该通知。
对于定期通知，将立即发出第一个通知，而后续通知将根据 period 参数指定的间隔提供。

注意，一旦将计时器通知添加到通知列表中，将不能更新其相关的日期、时段和出现数量。

如果是定期通知，则使用固定延迟 执行方案，如在 Timer 中指定的那样。为了使用固定速率 执行方案，要使用 addNotification(String, String, Object, Date, long, long, boolean)。

参数：

type - 计时器通知类型。

message - 计时器通知详细消息。

userData - 计时器通知用户数据对象。

date - 发出通知时的日期。

period - 计时器通知的时段（以毫秒为单位）。

nbOccurences - 将发出的计时器通知的总数。

返回：

新创建的计时器通知的标识符。

抛出：

IllegalArgumentException - 如果 period 或出现的数量为负数

另请参见：

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 中指定的那样。为了使用固定速率 执行方案，要使用 addNotification(String, String, Object, Date, long, long, boolean)。

如果要插入的计时器通知其日期早于当前的日期，则该方法具有把指定的日期当做当前日期的行为。将立即发出第一个通知，而后续通知将根据 period 参数指定的间隔提供。

参数：

type - 计时器通知类型。

message - 计时器通知详细消息。

userData - 计时器通知用户数据对象。

date - 发出通知时的日期。

period - 计时器通知的时段（以毫秒为单位）。

返回：

新创建的计时器通知的标识符。

抛出：

IllegalArgumentException - 如果 period 为负数或者通知日期早于当前日期。

---

addNotification

Integer addNotification(String type,
                        String message,
                        Object userData,
                        Date date)
                        throws IllegalArgumentException

创建具有指定 type、message 和 userData 的新计时器通知，并将其插入到带有给定日期以及 null 时段和出现数量的通知列表中。

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

如果要插入的计时器通知其日期早于当前的日期，则该方法具有把指定的日期当做当前日期的行为，并且将立即发出通知。

参数：

type - 计时器通知类型。

message - 计时器通知详细消息。

userData - 计时器通知用户数据对象。

date - 发出通知时的日期。

返回：

新创建的计时器通知的标识符。

抛出：

IllegalArgumentException - 如果通知日期早于当前日期。

---

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 getAllNotificationIDs()

获得所有在通知的列表中注册的计时器通知标识符。

返回：

一个包含所有计时器通知标识符的 Integer 对象的向量。
如果不存在向此计时器 MBean 注册的计时器通知，则该向量为空。

---

getNotificationIDs

Vector 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(boolean)

---

setSendPastNotifications

void setSendPastNotifications(boolean value)

设置指示计时器是否发送过期通知的标志。

参数：

value - 过期通知发送开/关标志值。

另请参见：

getSendPastNotifications()

---

isActive

boolean isActive()

测试计时器 MBean 是否处于激活状态。当调用 start 方法时，计时器 MBean 被标记为激活。当调用 stop 方法时，该标记变为非激活。

返回：

如果计时器 MBean 处于激活状态，则返回 true；否则返回 false。

---

isEmpty

boolean isEmpty()

测试计时器通知列表是否为空。

返回：

如果计时器通知列表为空，则返回 true，否则返回 false。

---

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。