/*
 * Copyright (c) 1999, 2007, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package javax.management.timer;

/**
 * This class provides definitions of the notifications sent by timer MBeans.
 * <BR>It defines a timer notification identifier which allows to retrieve a timer notification
 * from the list of notifications of a timer MBean.
 * <P>
 * The timer notifications are created and handled by the timer MBean.
 *
 * @since 1.5
 */
public class TimerNotification extends javax.management.Notification {


 /* Serial version */
 private static final long serialVersionUID = 1798492029603825750L;

 /*
 * ------------------------------------------
 * PRIVATE VARIABLES
 * ------------------------------------------
 */

 /**
 * @serial Timer notification identifier.
 * This identifier is used to retrieve a timer notification from the timer list of notifications.
 */
 private Integer notificationID;


 /*
 * ------------------------------------------
 * CONSTRUCTORS
 * ------------------------------------------
 */

 /**
 * Creates a timer notification object.
 *
 * @param type The notification type.
 * @param source The notification producer.
 * @param sequenceNumber The notification sequence number within the source object.
 * @param timeStamp The notification emission date.
 * @param msg The notification message.
 * @param id The notification identifier.
 *
 */
 public TimerNotification(String type, Object source, long sequenceNumber, long timeStamp, String msg, Integer id) {

 super(type, source, sequenceNumber, timeStamp, msg);
 this.notificationID = id;
 }

 /*
 * ------------------------------------------
 * PUBLIC METHODS
 * ------------------------------------------
 */

 // GETTERS AND SETTERS
 //--------------------

 /**
 * Gets the identifier of this timer notification.
 *
 * @return The identifier.
 */
 public Integer getNotificationID() {
 return notificationID;
 }

 /*
 * ------------------------------------------
 * PACKAGE METHODS
 * ------------------------------------------
 */

 /**
 * Creates and returns a copy of this object.
 *
 */
 Object cloneTimerNotification() {

 TimerNotification clone = new TimerNotification(this.getType(), this.getSource(), this.getSequenceNumber(),
 this.getTimeStamp(), this.getMessage(), notificationID);
 clone.setUserData(this.getUserData());
 return clone;
 }
}