Source for javax.management.remote.TargetedNotification

   1: /* TargetedNotificaton.java -- Wrapper for a notification and identifier pair.
   2:    Copyright (C) 2008 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management.remote;
  39: 
  40: import java.io.Serializable;
  41: 
  42: import javax.management.Notification;
  43: 
  44: /**
  45:  * Wraps a notification with an identifier that specifies
  46:  * the listener which received it.
  47:  *
  48:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  49:  * @since 1.5
  50:  */
  51: public class TargetedNotification
  52:   implements Serializable
  53: {
  54: 
  55:   /**
  56:    * Compatible with JDK 1.6
  57:    */
  58:   private static final long serialVersionUID = 7676132089779300926L;
  59: 
  60:   /**
  61:    * The notification that was recieved by the listener.
  62:    */
  63:   private Notification notif;
  64: 
  65:   /**
  66:    * The identifier for the listener that received the notification;
  67:    */
  68:   private Integer id;
  69: 
  70:   /**
  71:    * Constructs a new {@link TargetedNotification} which connects
  72:    * the supplied notification with the specified identifier.  The
  73:    * identifier matches one of those returned by a previous call
  74:    * to add a new notification listener.
  75:    *
  76:    * @param notif the notification.
  77:    * @param id the identifier of the listener that received the
  78:    *           notification.
  79:    * @throws IllegalArgumentException if either argument is
  80:    *                                  <code>null</code>.
  81:    */
  82:   public TargetedNotification(Notification notif, Integer id)
  83:   {
  84:     if (notif == null)
  85:       throw new IllegalArgumentException("The notification is null.");
  86:     if (id == null)
  87:       throw new IllegalArgumentException("The identifier is null.");
  88:     this.notif = notif;
  89:     this.id = id;
  90:   }
  91: 
  92:   /**
  93:    * Returns the notification.
  94:    *
  95:    * @return the notification.
  96:    */
  97:   public Notification getNotification()
  98:   {
  99:     return notif;
 100:   }
 101: 
 102:   /**
 103:    * Returns the identifier for the listener
 104:    * which received the notification.
 105:    *
 106:    * @return the identifier.
 107:    */
 108:   public Integer getListenerID()
 109:   {
 110:     return id;
 111:   }
 112: 
 113:   /**
 114:    * Returns a textual representation of the object.
 115:    *
 116:    * @return a textual representation.
 117:    */
 118:   public String toString()
 119:   {
 120:     return getClass().getName() +
 121:       "[notif=" + notif +
 122:       ",id=" + id +
 123:       "]";
 124:   }
 125: 
 126: }