libjava/java/beans/beancontext/BeanContextChild.java

   1 /* java.beans.beancontext.BeanContextChild
   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.beans.PropertyChangeListener;
  42 import java.beans.VetoableChangeListener;
  43 import java.beans.PropertyVetoException;
  44
  45 /**
  46  * Beans implement this to get information about the execution environment and its services and to be placed in the hierarchy.
  47  * <P>
  48  *
  49  * The difference between a <code>BeanContext</code> and a
  50  * <code>BeanContextChild</code>, mainly, is that a
  51  * <code>BeanContext</code> may be a parent.
  52  * <P>
  53  *
  54  * <code>BeanContextChild</code> instances will be serialized at some
  55  * point in their life, but you need to make sure your bean context does
  56  * not contain a serializable reference (directly or indirectly) to the
  57  * parent <code>BeanContext</code>, to any of the other
  58  * <code>BeanContext</code>s in the tree, or to any resources obtained
  59  * via the <code>BeanContextServices</code> interface.  One way to do this
  60  * is to mark any fields that contain such references as
  61  * <code>transient</code>.  Another way is to use a custom serializer.
  62  * <P>
  63  *
  64  * If you do not do this, when the <code>BeanContext</code> is serialized,
  65  * all the other <code>BeanContext</code>s and other unnecessary things
  66  * will be serialized along with it.
  67  * <P>
  68  *
  69  * Before dying, a <code>BeanContextChild</code> should call
  70  * <code>getBeanContext().remove(this)</code> to detach from the
  71  * hierarchy and exit cleanly.
  72  *
  73  * @author John Keiser
  74  * @since JDK1.2
  75  * @see java.beans.beancontext.BeanContext
  76  */
  77
  78 public interface BeanContextChild {
  79         /**
  80          * Set the parent <code>BeanContext</code>.
  81          * <P>
  82          *
  83          * This method is called from <code>BeanContext.add()</code> and
  84          * should not be called directly.
  85          * <P>
  86          *
  87          * When this Object is being added to a new BeanContext or moved
  88          * from an old one, a non-null value will be passed in.
  89          * <P>
  90          *
  91          * When this Object is being removed from the current
  92          * <code>BeanContext</code>, <code>setBeanContext()</code> will
  93          * receive the parameter <code>null</code>.
  94          * <P>
  95          *
  96          * When being removed from the current <code>BeanContext</code>,
  97          * it is the <code>BeanContextChild</code>'s responsibility to
  98          * release all services it has obtained.
  99          * <P>
 100          *
 101          * This change should generate <code>PropertyChangeEvent</code>
 102          * and <code>VetoableChangeEvent</code>s with the property name
 103          * "beanContext".  If the change is vetoed, it must re-throw the
 104          * exception and not change anything.  In this way, the parent
 105          * <code>BeanContextChild</code>, who has registered himself with
 106          * you, will have a chance to remove this child from its
 107          * collection.
 108          * <P>
 109          *
 110          * If the Bean does not wish to change the parent or be removed
 111          * from one, it may throw the <code>PropertyVetoException</code>.
 112          * If you veto a <code>setBeanContext(null)</code> call, then you
 113          * should try your hardest to remedy whatever problem is keeping
 114          * you from being removed from the <code>BeanContext</code> so
 115          * that you can <em>not</em> veto it the next time.
 116          * Otherwise, nasty pathological recursion stuff could occur in
 117          * certain situations.
 118          * <P>
 119          *
 120          * If you do veto the change, you must first back out any changes
 121          * you made prior to the veto.  Best not to make any such changes
 122          * prior to the veto in the first place.
 123          * <P>
 124          *
 125          * This method is called from <code>BeanContext.add()</code> and
 126          * should not be called directly.
 127          *
 128          * @param parent the new parent for the <code>BeanContextChild</code>,
 129          *        or <code>null</code> to signify removal from a tree.
 130          * @exception PropertyVetoException if the
 131          *            <code>BeanContextChild</code> implementor does not
 132          *            wish to have its parent changed.
 133          */
 134         public void setBeanContext(BeanContext parent)
 135                 throws PropertyVetoException;
 136
 137         /**
 138          * Get the parent <code>BeanContext</code>.
 139          * @return the parent <code>BeanContext</code>.
 140          */
 141         public BeanContext getBeanContext();
 142
 143         /**
 144          * Add a listener that will be notified when a specific property changes.
 145          * @param prop the name of the property to listen on
 146          * @param listener the listener to listen on the property.
 147          */
 148         public void addPropertyChangeListener(String prop, PropertyChangeListener listener);
 149
 150         /**
 151          * Remove a listener to a certain property.
 152          * @param prop the name of the property being listened on
 153          * @param listener the listener listening on the property.
 154          */
 155         public void removePropertyChangeListener(String prop, PropertyChangeListener listener);
 156
 157         /**
 158          * Add a listener that will be notified when a specific property
 159          * change is requested (a PropertyVetoException may be thrown) as
 160          * well as after the change is successfully made.
 161          *
 162          * @param prop the name of the property to listen on
 163          * @param listener the listener to listen on the property.
 164          */
 165         public void addVetoableChangeListener(String prop, VetoableChangeListener listener);
 166
 167         /**
 168          * Remove a listener to a certain property.
 169          * @param prop the name of the property being listened on
 170          * @param listener the listener listening on the property.
 171          */
 172         public void removeVetoableChangeListener(String prop, VetoableChangeListener listener);
 173 }