libjava/classpath/gnu/classpath/ListenerData.java

   1 /* ListenerData.java - Class to contain data about management bean listeners
   2    Copyright (C) 2006 Free Software Foundation
   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 gnu.classpath;
  39
  40 import javax.management.NotificationFilter;
  41 import javax.management.NotificationListener;
  42
  43 /**
  44  * Container for data on management listeners.  Wraps
  45  * a {@link javax.management.NotificationListener},
  46  * {@link javax.management.NotificationFilter} and
  47  * passback object in one class.
  48  *
  49  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  50  * @since 1.5
  51  */
  52 public class ListenerData
  53 {
  54   /**
  55    * The listener itself.
  56    */
  57   private NotificationListener listener;
  58
  59   /**
  60    * A filter to apply to incoming events.
  61    */
  62   private NotificationFilter filter;
  63
  64   /**
  65    * An object to pass back to the listener on an
  66    * event occurring.
  67    */
  68   private Object passback;
  69
  70   /**
  71    * Constructs a new {@link ListenerData} with the specified
  72    * listener, filter and passback object.
  73    *
  74    * @param listener the listener itself.
  75    * @param filter the filter for incoming events.
  76    * @param passback the object to passback on an incoming event.
  77    */
  78   public ListenerData(NotificationListener listener,
  79                       NotificationFilter filter, Object passback)
  80   {
  81     this.listener = listener;
  82     this.filter = filter;
  83     this.passback = passback;
  84   }
  85
  86   /**
  87    * Returns the listener.
  88    *
  89    * @return the listener.
  90    */
  91   public NotificationListener getListener()
  92   {
  93     return listener;
  94   }
  95
  96   /**
  97    * Returns the filter.
  98    *
  99    * @return the filter.
 100    */
 101   public NotificationFilter getFilter()
 102   {
 103     return filter;
 104   }
 105
 106   /**
 107    * Returns the passback object.
 108    *
 109    * @return the passback object.
 110    */
 111   public Object getPassback()
 112   {
 113     return passback;
 114   }
 115
 116   /**
 117    * Returns true if the supplied object is an instance of
 118    * {@link ListenerData} and has the same listener, filter
 119    * and passback object.
 120    *
 121    * @param obj the object to check.
 122    * @return true if <code>obj</code> is equal to this.
 123    */
 124   public boolean equals(Object obj)
 125   {
 126     if (obj instanceof ListenerData)
 127       {
 128         ListenerData data = (ListenerData) obj;
 129         return (data.getListener() == listener &&
 130                 data.getFilter() == filter &&
 131                 data.getPassback() == passback);
 132       }
 133     return false;
 134   }
 135
 136 }