OpenJDK 27 · javax.management.timer.TimerMBean · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Integer	Returns: The identifier of the new created timer notification. addNotification(String The timer notification type. type, String The timer notification detailed message. message, Object The timer notification user data object. userData, Date The date when the notification occurs. date, long The period of the timer notification (in milliseconds). period, long The total number the timer notification will be emitted. nbOccurences, boolean 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. 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.
public Integer	Returns: The identifier of the new created timer notification. addNotification(String The timer notification type. type, String The timer notification detailed message. message, Object The timer notification user data object. userData, Date The date when the notification occurs. date, long The period of the timer notification (in milliseconds). period, long The total number the timer notification will be emitted. 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.
public Integer	Returns: The identifier of the new created timer notification. addNotification(String The timer notification type. type, String The timer notification detailed message. message, Object The timer notification user data object. userData, Date The date when the notification occurs. date, long The period of the timer notification (in milliseconds). 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.
public Integer	Returns: The identifier of the new created timer notification. addNotification(String The timer notification type. type, String The timer notification detailed message. message, Object The timer notification user data object. userData, Date The date when the notification occurs. 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.
public Vector<Integer>	Returns: 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. getAllNotificationIDs() Gets all timer notification identifiers registered into the list of notifications.
public Date	Returns: A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean. getDate(Integer The timer notification identifier. id) Gets a copy of the date associated to a timer notification.
public Boolean	Returns: A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate. getFixedRate(Integer The timer notification identifier. id) Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.
public int	Returns: The number of timer notifications. getNbNotifications() Gets the number of timer notifications registered into the list of notifications.
public Long	Returns: 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. getNbOccurences(Integer The timer notification identifier. id) Gets a copy of the remaining number of occurrences associated to a timer notification.
public Vector<Integer>	Returns: 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`. getNotificationIDs(String The timer notification type. type) Gets all the identifiers of timer notifications corresponding to the specified type.
public String	Returns: The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean. getNotificationMessage(Integer The timer notification identifier. id) Gets the timer notification detailed message corresponding to the specified identifier.
public String	Returns: The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean. getNotificationType(Integer The timer notification identifier. id) Gets the timer notification type corresponding to the specified identifier.
public Object	Returns: The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean. getNotificationUserData(Integer The timer notification identifier. id) Gets the timer notification user data object corresponding to the specified identifier.
public Long	Returns: A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean. getPeriod(Integer The timer notification identifier. id) Gets a copy of the period (in milliseconds) associated to a timer notification.
public boolean	Returns: The past notifications sending on/off flag value. getSendPastNotifications() Gets the flag indicating whether or not the timer sends past notifications.
public boolean	Returns: `true` if the timer MBean is active, `false` otherwise. isActive() Tests whether the timer MBean is active.
public boolean	Returns: `true` if the list of timer notifications is empty, `false` otherwise. isEmpty() Tests whether the list of timer notifications is empty.
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(Integer The timer notification identifier. id) Removes the timer notification corresponding to the specified identifier from the list of notifications.
public void	removeNotifications(String The timer notification type. type) Removes all the timer notifications corresponding to the specified type from the list of notifications.
public void	setSendPastNotifications(boolean The past notifications sending on/off flag value. value) Sets the flag indicating whether the timer sends past notifications or not.
public void	start() Starts the timer.
public void	stop() Stops the timer.

Method Detail

addNotification back to summary

addNotification	back to summary
public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException 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 `java.util.Timer`. Parameters type:String The timer notification type. message:String The timer notification detailed message. userData:Object The timer notification user data object. date:Date The date when the notification occurs. period:long The period of the timer notification (in milliseconds). nbOccurences:long The total number the timer notification will be emitted. fixedRate:boolean 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. Returns:Integer The identifier of the new created timer notification. Exceptions IllegalArgumentException: The date is `null` or the period or the number of occurrences is negative. See Also `addNotification(String, String, Object, Date, long, long)`

public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException

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 java.util.Timer.

Parameters

type:String: The timer notification type.
message:String: The timer notification detailed message.
userData:Object: The timer notification user data object.
date:Date: The date when the notification occurs.
period:long: The period of the timer notification (in milliseconds).
nbOccurences:long: The total number the timer notification will be emitted.
fixedRate:boolean: 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.

Returns:Integer

The identifier of the new created timer notification.

Exceptions

IllegalArgumentException:: The date is null or the period or the number of occurrences is negative.

addNotification back to summary

addNotification	back to summary
public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException 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 `java.util.Timer`. In order to use a fixed-rate execution scheme, use `addNotification(String, String, Object, Date, long, long, boolean)` instead. Parameters type:String The timer notification type. message:String The timer notification detailed message. userData:Object The timer notification user data object. date:Date The date when the notification occurs. period:long The period of the timer notification (in milliseconds). nbOccurences:long The total number the timer notification will be emitted. Returns:Integer The identifier of the new created timer notification. Exceptions IllegalArgumentException: The date is `null` or the period or the number of occurrences is negative. See Also `addNotification(String, String, Object, Date, long, long, boolean)`

public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException

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.

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 java.util.Timer. In order to use a fixed-rate execution scheme, use addNotification(String, String, Object, Date, long, long, boolean) instead.

Parameters

type:String: The timer notification type.
message:String: The timer notification detailed message.
userData:Object: The timer notification user data object.
date:Date: The date when the notification occurs.
period:long: The period of the timer notification (in milliseconds).
nbOccurences:long: The total number the timer notification will be emitted.

Returns:Integer

The identifier of the new created timer notification.

Exceptions

IllegalArgumentException:: The date is null or the period or the number of occurrences is negative.

addNotification back to summary

addNotification	back to summary
public Integer addNotification(String type, String message, Object userData, Date date, long period) throws IllegalArgumentException 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 `java.util.Timer`. In order to use a fixed-rate execution scheme, use `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. Parameters type:String The timer notification type. message:String The timer notification detailed message. userData:Object The timer notification user data object. date:Date The date when the notification occurs. period:long The period of the timer notification (in milliseconds). Returns:Integer The identifier of the new created timer notification. Exceptions IllegalArgumentException: The date is `null` or the period is negative.

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

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 java.util.Timer. In order to use a fixed-rate execution scheme, use 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.

Parameters

type:String: The timer notification type.
message:String: The timer notification detailed message.
userData:Object: The timer notification user data object.
date:Date: The date when the notification occurs.
period:long: The period of the timer notification (in milliseconds).

Returns:Integer

The identifier of the new created timer notification.

Exceptions

IllegalArgumentException:: The date is null or the period is negative.

addNotification back to summary

addNotification	back to summary
public Integer addNotification(String type, String message, Object userData, Date date) throws IllegalArgumentException 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. Parameters type:String The timer notification type. message:String The timer notification detailed message. userData:Object The timer notification user data object. date:Date The date when the notification occurs. Returns:Integer The identifier of the new created timer notification. Exceptions IllegalArgumentException: The date is `null`.

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

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.

Parameters

type:String: The timer notification type.
message:String: The timer notification detailed message.
userData:Object: The timer notification user data object.
date:Date: The date when the notification occurs.

Returns:Integer

The identifier of the new created timer notification.

Exceptions

IllegalArgumentException:: The date is null.

getAllNotificationIDs back to summary

getAllNotificationIDs	back to summary
public Vector<Integer> getAllNotificationIDs() Gets all timer notification identifiers registered into the list of notifications. Returns:Vector<Integer> 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 Vector<Integer> getAllNotificationIDs()

Gets all timer notification identifiers registered into the list of notifications.

Returns:Vector<Integer>: 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.

getDate	back to summary
public Date getDate(Integer id) Gets a copy of the date associated to a timer notification. Parameters id:Integer The timer notification identifier. Returns:Date A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getDate

back to summary

public Date getDate(Integer id)

Gets a copy of the date associated to a timer notification.

Parameters

id:Integer: The timer notification identifier.

Returns:Date

A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getFixedRate	back to summary
public Boolean getFixedRate(Integer id) Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate. Parameters id:Integer The timer notification identifier. Returns:Boolean A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.

getFixedRate

back to summary

public Boolean getFixedRate(Integer id)

Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.

Parameters

id:Integer: The timer notification identifier.

Returns:Boolean

A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.

getNbNotifications	back to summary
public int getNbNotifications() Gets the number of timer notifications registered into the list of notifications. Returns:int The number of timer notifications.

getNbNotifications

back to summary

public int getNbNotifications()

Gets the number of timer notifications registered into the list of notifications.

Returns:int: The number of timer notifications.

getNbOccurences	back to summary
public Long getNbOccurences(Integer id) Gets a copy of the remaining number of occurrences associated to a timer notification. Parameters id:Integer The timer notification identifier. Returns:Long 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.

getNbOccurences

back to summary

public Long getNbOccurences(Integer id)

Gets a copy of the remaining number of occurrences associated to a timer notification.

Parameters

id:Integer: The timer notification identifier.

Returns:Long

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.

getNotificationIDs back to summary

getNotificationIDs	back to summary
public Vector<Integer> getNotificationIDs(String type) Gets all the identifiers of timer notifications corresponding to the specified type. Parameters type:String The timer notification type. Returns:Vector<Integer> 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 Vector<Integer> getNotificationIDs(String type)

Gets all the identifiers of timer notifications corresponding to the specified type.

Parameters

type:String: The timer notification type.

Returns:Vector<Integer>

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.

getNotificationMessage	back to summary
public String getNotificationMessage(Integer id) Gets the timer notification detailed message corresponding to the specified identifier. Parameters id:Integer The timer notification identifier. Returns:String The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getNotificationMessage

back to summary

public String getNotificationMessage(Integer id)

Gets the timer notification detailed message corresponding to the specified identifier.

Parameters

id:Integer: The timer notification identifier.

Returns:String

The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getNotificationType	back to summary
public String getNotificationType(Integer id) Gets the timer notification type corresponding to the specified identifier. Parameters id:Integer The timer notification identifier. Returns:String The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getNotificationType

back to summary

public String getNotificationType(Integer id)

Gets the timer notification type corresponding to the specified identifier.

Parameters

id:Integer: The timer notification identifier.

Returns:String

The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getNotificationUserData	back to summary
public Object getNotificationUserData(Integer id) Gets the timer notification user data object corresponding to the specified identifier. Parameters id:Integer The timer notification identifier. Returns:Object The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getNotificationUserData

back to summary

public Object getNotificationUserData(Integer id)

Gets the timer notification user data object corresponding to the specified identifier.

Parameters

id:Integer: The timer notification identifier.

Returns:Object

The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getPeriod	back to summary
public Long getPeriod(Integer id) Gets a copy of the period (in milliseconds) associated to a timer notification. Parameters id:Integer The timer notification identifier. Returns:Long A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getPeriod

back to summary

public Long getPeriod(Integer id)

Gets a copy of the period (in milliseconds) associated to a timer notification.

Parameters

id:Integer: The timer notification identifier.

Returns:Long

A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean.

getSendPastNotifications back to summary

getSendPastNotifications	back to summary
public boolean getSendPastNotifications() Gets the flag indicating whether or not the timer sends past notifications. Returns:boolean The past notifications sending on/off flag value. See Also `setSendPastNotifications`

public boolean getSendPastNotifications()

Gets the flag indicating whether or not the timer sends past notifications.

Returns:boolean: The past notifications sending on/off flag value.
See Also: setSendPastNotifications

isActive back to summary

isActive	back to summary
public boolean isActive() Tests whether the timer MBean is active. A timer MBean is marked active when the `start` method is called. It becomes inactive when the `stop` method is called. Returns:boolean `true` if the timer MBean is active, `false` otherwise.

public boolean isActive()

Tests whether the timer MBean is active. A timer MBean is marked active when the start method is called. It becomes inactive when the stop method is called.

Returns:boolean: true if the timer MBean is active, false otherwise.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Tests whether the list of timer notifications is empty. Returns:boolean `true` if the list of timer notifications is empty, `false` otherwise.

public boolean isEmpty()

Tests whether the list of timer notifications is empty.

Returns:boolean: true if the list of timer notifications is empty, false otherwise.

removeAllNotifications	back to summary
public void removeAllNotifications() Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.

removeNotification	back to summary
public void removeNotification(Integer id) throws InstanceNotFoundException Removes the timer notification corresponding to the specified identifier from the list of notifications. Parameters id:Integer The timer notification identifier. Exceptions InstanceNotFoundException: The specified identifier does not correspond to any timer notification in the list of notifications of this timer MBean.

removeNotification

back to summary

public void removeNotification(Integer id) throws InstanceNotFoundException

Removes the timer notification corresponding to the specified identifier from the list of notifications.

Parameters

id:Integer: The timer notification identifier.

Exceptions

InstanceNotFoundException:: The specified identifier does not correspond to any timer notification in the list of notifications of this timer MBean.

removeNotifications	back to summary
public void removeNotifications(String type) throws InstanceNotFoundException Removes all the timer notifications corresponding to the specified type from the list of notifications. Parameters type:String The timer notification type. Exceptions InstanceNotFoundException: The specified type does not correspond to any timer notification in the list of notifications of this timer MBean.

removeNotifications

back to summary

public void removeNotifications(String type) throws InstanceNotFoundException

Removes all the timer notifications corresponding to the specified type from the list of notifications.

Parameters

type:String: The timer notification type.

Exceptions

InstanceNotFoundException:: The specified type does not correspond to any timer notification in the list of notifications of this timer MBean.

setSendPastNotifications back to summary

setSendPastNotifications	back to summary
public void setSendPastNotifications(boolean value) Sets the flag indicating whether the timer sends past notifications or not. Parameters value:boolean The past notifications sending on/off flag value. See Also `getSendPastNotifications`

public void setSendPastNotifications(boolean value)

Sets the flag indicating whether the timer sends past notifications or not.

Parameters

value:boolean: The past notifications sending on/off flag value.

See Also

getSendPastNotifications

start back to summary

start	back to summary
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 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.

stop	back to summary
public void stop() Stops the timer.

public Interface TimerMBean

Method Summary

Method Detail