libjava/java/beans/beancontext/BeanContextEvent.java

   1 /* java.beans.beancontext.BeanContextEvent
   2    Copyright (C) 1999 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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
  39 package java.beans.beancontext;
  40
  41 import java.util.EventObject;
  42
  43 /**
  44  * Generic superclass for events fired by <code>BeanContext</code>s.
  45  *
  46  * @author John Keiser
  47  * @since 1.2
  48  */
  49
  50 public abstract class BeanContextEvent extends EventObject
  51 {
  52   private static final long serialVersionUID = 7267998073569045052L;
  53
  54   /**
  55    * The <code>BeanContext</code> that most recently passed this
  56    * event on.
  57    */
  58   protected BeanContext propagatedFrom;
  59
  60   /**
  61    * Create a new event, from the specified <code>BeanContext</code>.
  62    * <code>propagatedFrom</code> will be initialized to
  63    * <code>null</code>.
  64    *
  65    * @param source the source of the event.
  66    */
  67   protected BeanContextEvent(BeanContext source)
  68   {
  69     super(source);
  70   }
  71
  72   /**
  73    * Get the <code>BeanContext</code> that originated this event.
  74    * @return the originator of this event.
  75    */
  76   public BeanContext getBeanContext()
  77   {
  78     return (BeanContext)getSource();
  79   }
  80
  81   /**
  82    * Get the most recent propagator of this event.
  83    * If this value is <code>null</code>, you have received the event
  84    * straight from the source.
  85    *
  86    * @return the most recent propagator of this event.
  87    */
  88   public BeanContext getPropagatedFrom()
  89   {
  90     return propagatedFrom;
  91   }
  92
  93   /**
  94    * Tell whether this event has been propagated.
  95    * @return <code>true</code> iff <code>getPropagatedFrom() != null</code>.
  96    */
  97   public boolean isPropagated()
  98   {
  99     return propagatedFrom != null;
 100   }
 101
 102   /**
 103    * Set the most recent propagator of this event.
 104    * @param propagator the most recent propagator of this event.
 105    */
 106   public void setPropagatedFrom(BeanContext propagator)
 107   {
 108     propagatedFrom = propagator;
 109   }
 110 }