Timer JDK 1.6)

Methods

publicsynchronized Integer addNotification (String type, String message, Object userData, Date date) throws IllegalArgumentException [Specified in TimerMBean]

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.
Returns: The identifier of the new created timer notification.
Parameters:
- type - The timer notification type.
- message - The timer notification detailed message.
- userData - The timer notification user data object.
- date - The date when the notification occurs.
Throws:
- java.lang.IllegalArgumentException - The date is {@code null}.

publicsynchronized Integer addNotification (String type, String message, Object userData, Date date, long period) throws IllegalArgumentException [Specified in TimerMBean]

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 Timer. In order to use a fixed-rate execution scheme, use Timer.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.
Returns: The identifier of the new created timer notification.
Parameters:
- type - The timer notification type.
- message - The timer notification detailed message.
- userData - The timer notification user data object.
- date - The date when the notification occurs.
- period - The period of the timer notification (in milliseconds).
Throws:
- java.lang.IllegalArgumentException - The date is {@code null} or the period is negative.

publicsynchronized Integer addNotification (String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException [Specified in TimerMBean]

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

publicsynchronized Integer addNotification (String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException [Specified in TimerMBean]

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, the value of parameter fixedRate is used to specify the execution scheme, as specified in Timer.
Returns: The identifier of the new created timer notification.
Parameters:
- type - The timer notification type.
- message - The timer notification detailed message.
- userData - The timer notification user data object.
- date - The date when the notification occurs.
- period - The period of the timer notification (in milliseconds).
- nbOccurences - The total number the timer notification will be emitted.
- 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.
Throws:
- java.lang.IllegalArgumentException - The date is {@code null} or the period or the number of occurrences is negative.
See Also: Timer.addNotification(String, String, Object, Date, long, long),

public void addNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) [Inherited From NotificationBroadcasterSupport]

Adds a listener.

pack-private void debug (String func, String info)

pack-private void debug (String clz, String func, String info)

publicsynchronized Vector<Integer> getAllNotificationIDs () [Specified in TimerMBean]

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

Gets all timer notification identifiers registered into the list of notifications.
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.

public Date getDate (Integer id) [Specified in TimerMBean]

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

public Boolean getFixedRate (Integer id) [Specified in TimerMBean]

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

public int getNbNotifications () [Specified in TimerMBean]

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

public Long getNbOccurences (Integer id) [Specified in TimerMBean]

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

publicsynchronized Vector<Integer> getNotificationIDs (String type) [Specified in TimerMBean]

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

Gets all the identifiers of timer notifications corresponding to the specified type.
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.
Parameters:
- type - The timer notification type.

publicsynchronized MBeanNotificationInfo getNotificationInfo () [Overrides NotificationBroadcasterSupport]

public String getNotificationMessage (Integer id) [Specified in TimerMBean]

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

public String getNotificationType (Integer id) [Specified in TimerMBean]

Gets the timer notification type corresponding to the specified identifier.

public Object getNotificationUserData (Integer id) [Specified in TimerMBean]

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

public Long getPeriod (Integer id) [Specified in TimerMBean]

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

public boolean getSendPastNotifications () [Specified in TimerMBean]

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

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

The default value of the past notifications sending on/off flag is false.
Returns: The past notifications sending on/off flag value.
See Also: Timer.setSendPastNotifications(boolean),

protected void handleNotification (NotificationListener listener, Notification notif, Object handback) [Inherited From NotificationBroadcasterSupport]

This method is called by sendNotification for each listener in order to send the notification to that listener.

This method is called by sendNotification for each listener in order to send the notification to that listener. It can be overridden in subclasses to change the behavior of notification delivery, for instance to deliver the notification in a separate thread.

The default implementation of this method is equivalent to

 listener.handleNotification(notif, handback);

Parameters:
- listener - the listener to which the notification is being delivered.
- notif - the notification being delivered to the listener.
- handback - the handback object that was supplied when the listener was added.

public boolean isActive () [Specified in TimerMBean]

Tests whether the timer MBean is active.

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.

The default value of the active on/off flag is false.
Returns: true if the timer MBean is active, false otherwise.

pack-private boolean isDebugOn ()

public boolean isEmpty () [Specified in TimerMBean]

Tests whether the list of timer notifications is empty.

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

pack-private boolean isTraceOn ()

@SuppressWarnings (value="deprecation")

pack-private void notifyAlarmClock (TimerAlarmClockNotification notification)

This method is called by the timer each time the TimerAlarmClock has exceeded its timeout.

public void postDeregister () [Specified in MBeanRegistration]

Allows the timer MBean to perform any operations needed after having been unregistered by the MBean server.

public void postRegister (Boolean registrationDone) [Specified in MBeanRegistration]

Allows the timer MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

public void preDeregister () throws Exception [Specified in MBeanRegistration]

Allows the timer MBean to perform any operations it needs before being unregistered by the MBean server.

public ObjectName preRegister (MBeanServer server, ObjectName name) throws Exception [Specified in MBeanRegistration]

Allows the timer MBean to perform any operations it needs before being registered in the MBean server.

publicsynchronized void removeAllNotifications () [Specified in TimerMBean]

Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.

publicsynchronized void removeNotification (Integer id) throws InstanceNotFoundException [Specified in TimerMBean]

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

public void removeNotificationListener (NotificationListener listener) throws ListenerNotFoundException [Inherited From NotificationBroadcasterSupport]

public void removeNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException [Inherited From NotificationBroadcasterSupport]

publicsynchronized void removeNotifications (String type) throws InstanceNotFoundException [Specified in TimerMBean]

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

pack-private void sendNotification (Date timeStamp, TimerNotification notification)

This method is used by the timer MBean to update and send a timer notification to all the listeners registered for this kind of notification.

public void sendNotification (Notification notification) [Inherited From NotificationBroadcasterSupport]

Sends a notification.

Sends a notification.

If an Executor was specified in the constructor, it will be given one
task per selected listener to deliver the notification to that listener.
Parameters:
- notification - The notification to send.

public void setSendPastNotifications (boolean value) [Specified in TimerMBean]

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

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

The default value of the past notifications sending on/off flag is false.
Parameters:
- value - The past notifications sending on/off flag value.
See Also: Timer.getSendPastNotifications(),

publicsynchronized void start () [Specified in TimerMBean]

Starts the timer.

publicsynchronized void stop () [Specified in TimerMBean]

Stops the timer.

pack-private void trace (String func, String info)

pack-private void trace (String clz, String func, String info)