File	Doc	Category	Size	Date	Package
TimerMBean.java	API Doc	Java SE 6 API	16116	Tue Jun 10 00:26:20 BST 2008	javax.management.timer

TimerMBean

Fields Summary

Constructors Summary

Methods Summary
public java.lang.Integer	addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period, long nbOccurences, boolean fixedRate) Creates a new timer notification with the specified type, message and userData and inserts it into the list of notifications with a given date, period and number of occurrences. If the timer notification to be inserted has a date that is before the current date, the method behaves as if the specified date were the current date. For once-off notifications, the notification is delivered immediately. For periodic notifications, the first notification is delivered immediately and the subsequent ones are spaced as specified by the period parameter. Note that once the timer notification has been added into the list of notifications, its associated date, period and number of occurrences cannot be updated. In the case of a periodic notification, the value of parameter fixedRate is used to specify the execution scheme, as specified in {@link java.util.Timer}. param type The timer notification type. param message The timer notification detailed message. param userData The timer notification user data object. param date The date when the notification occurs. param period The period of the timer notification (in milliseconds). param nbOccurences The total number the timer notification will be emitted. param fixedRate If true and if the notification is periodic, the notification is scheduled with a fixed-rate execution scheme. If false and if the notification is periodic, the notification is scheduled with a fixed-delay execution scheme. Ignored if the notification is not periodic. return The identifier of the new created timer notification. exception java.lang.IllegalArgumentException The date is {@code null} or the period or the number of occurrences is negative. see #addNotification(String, String, Object, Date, long, long)
public java.lang.Integer	addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period, long nbOccurences) Creates a new timer notification with the specified type, message and userData and inserts it into the list of notifications with a given date, period and number of occurrences. If the timer notification to be inserted has a date that is before the current date, the method behaves as if the specified date were the current date. For once-off notifications, the notification is delivered immediately. For periodic notifications, the first notification is delivered immediately and the subsequent ones are spaced as specified by the period parameter. Note that once the timer notification has been added into the list of notifications, its associated date, period and number of occurrences cannot be updated. In the case of a periodic notification, uses a fixed-delay execution scheme, as specified in {@link java.util.Timer}. In order to use a fixed-rate execution scheme, use {@link #addNotification(String, String, Object, Date, long, long, boolean)} instead. param type The timer notification type. param message The timer notification detailed message. param userData The timer notification user data object. param date The date when the notification occurs. param period The period of the timer notification (in milliseconds). param nbOccurences The total number the timer notification will be emitted. return The identifier of the new created timer notification. exception java.lang.IllegalArgumentException The date is {@code null} or the period or the number of occurrences is negative. see #addNotification(String, String, Object, Date, long, long, boolean)
public java.lang.Integer	addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period) Creates a new timer notification with the specified type, message and userData and inserts it into the list of notifications with a given date and period and a null number of occurrences. The timer notification will repeat continuously using the timer period using a fixed-delay execution scheme, as specified in {@link java.util.Timer}. In order to use a fixed-rate execution scheme, use {@link #addNotification(String, String, Object, Date, long, long, boolean)} instead. If the timer notification to be inserted has a date that is before the current date, the method behaves as if the specified date were the current date. The first notification is delivered immediately and the subsequent ones are spaced as specified by the period parameter. param type The timer notification type. param message The timer notification detailed message. param userData The timer notification user data object. param date The date when the notification occurs. param period The period of the timer notification (in milliseconds). return The identifier of the new created timer notification. exception java.lang.IllegalArgumentException The date is {@code null} or the period is negative.
public java.lang.Integer	addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date) Creates a new timer notification with the specified type, message and userData and inserts it into the list of notifications with a given date and a null period and number of occurrences. The timer notification will be handled once at the specified date. If the timer notification to be inserted has a date that is before the current date, the method behaves as if the specified date were the current date and the notification is delivered immediately. param type The timer notification type. param message The timer notification detailed message. param userData The timer notification user data object. param date The date when the notification occurs. return The identifier of the new created timer notification. exception java.lang.IllegalArgumentException The date is {@code null}.
public java.util.Vector	getAllNotificationIDs() Gets all timer notification identifiers registered into the list of notifications. return A vector of Integer objects containing all the timer notification identifiers. The vector is empty if there is no timer notification registered for this timer MBean.
public java.util.Date	getDate(java.lang.Integer id) Gets a copy of the date associated to a timer notification. param id The timer notification identifier. return A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public java.lang.Boolean	getFixedRate(java.lang.Integer id) Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate. param id The timer notification identifier. return A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.
public int	getNbNotifications() Gets the number of timer notifications registered into the list of notifications. return The number of timer notifications.
public java.lang.Long	getNbOccurences(java.lang.Integer id) Gets a copy of the remaining number of occurrences associated to a timer notification. param id The timer notification identifier. return A copy of the remaining number of occurrences or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public java.util.Vector	getNotificationIDs(java.lang.String type) Gets all the identifiers of timer notifications corresponding to the specified type. param type The timer notification type. return A vector of Integer objects containing all the identifiers of timer notifications with the specified type. The vector is empty if there is no timer notifications registered for this timer MBean with the specified type.
public java.lang.String	getNotificationMessage(java.lang.Integer id) Gets the timer notification detailed message corresponding to the specified identifier. param id The timer notification identifier. return The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public java.lang.String	getNotificationType(java.lang.Integer id) Gets the timer notification type corresponding to the specified identifier. param id The timer notification identifier. return The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public java.lang.Object	getNotificationUserData(java.lang.Integer id) Gets the timer notification user data object corresponding to the specified identifier. param id The timer notification identifier. return The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public java.lang.Long	getPeriod(java.lang.Integer id) Gets a copy of the period (in milliseconds) associated to a timer notification. param id The timer notification identifier. return A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean.
public boolean	getSendPastNotifications() Gets the flag indicating whether or not the timer sends past notifications. return The past notifications sending on/off flag value. see #setSendPastNotifications
public boolean	isActive() Tests whether the timer MBean is active. A timer MBean is marked active when the {@link #start start} method is called. It becomes inactive when the {@link #stop stop} method is called. return true if the timer MBean is active, false otherwise.
public boolean	isEmpty() Tests whether the list of timer notifications is empty. return true if the list of timer notifications is empty, false otherwise.
public void	removeAllNotifications() Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.
public void	removeNotification(java.lang.Integer id) Removes the timer notification corresponding to the specified identifier from the list of notifications. param id The timer notification identifier. exception InstanceNotFoundException The specified identifier does not correspond to any timer notification in the list of notifications of this timer MBean.
public void	removeNotifications(java.lang.String type) Removes all the timer notifications corresponding to the specified type from the list of notifications. param type The timer notification type. exception InstanceNotFoundException The specified type does not correspond to any timer notification in the list of notifications of this timer MBean.
public void	setSendPastNotifications(boolean value) Sets the flag indicating whether the timer sends past notifications or not. param value The past notifications sending on/off flag value. see #getSendPastNotifications
public void	start() Starts the timer. If there is one or more timer notifications before the time in the list of notifications, the notification is sent according to the sendPastNotifications flag and then, updated according to its period and remaining number of occurrences. If the timer notification date remains earlier than the current date, this notification is just removed from the list of notifications.
public void	stop() Stops the timer.