001    /* java.beans.beancontext.BeanContextEvent
002       Copyright (C) 1999 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010     
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package java.beans.beancontext;
040    
041    import java.util.EventObject;
042    
043    /**
044     * Generic superclass for events fired by <code>BeanContext</code>s.
045     *
046     * @author John Keiser
047     * @since 1.2
048     */
049    
050    public abstract class BeanContextEvent extends EventObject
051    {
052      private static final long serialVersionUID = 7267998073569045052L;
053      
054      /**
055       * The <code>BeanContext</code> that most recently passed this
056       * event on.
057       */
058      protected BeanContext propagatedFrom;
059    
060      /**
061       * Create a new event, from the specified <code>BeanContext</code>.
062       * <code>propagatedFrom</code> will be initialized to
063       * <code>null</code>.
064       *
065       * @param source the source of the event.
066       */
067      protected BeanContextEvent(BeanContext source)
068      {
069        super(source);
070      }
071    
072      /**
073       * Get the <code>BeanContext</code> that originated this event.
074       * @return the originator of this event.
075       */
076      public BeanContext getBeanContext()
077      {
078        return (BeanContext)getSource();
079      }
080    
081      /**
082       * Get the most recent propagator of this event.
083       * If this value is <code>null</code>, you have received the event
084       * straight from the source.
085       *
086       * @return the most recent propagator of this event.
087       */
088      public BeanContext getPropagatedFrom()
089      {
090        return propagatedFrom;
091      }
092    
093      /**
094       * Tell whether this event has been propagated.
095       * @return <code>true</code> iff <code>getPropagatedFrom() != null</code>.
096       */
097      public boolean isPropagated()
098      {
099        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    }