001/* java.beans.beancontext.BeanContextMembershipEvent
002   Copyright (C) 1999, 2004 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010 
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.beans.beancontext;
040
041import java.util.Arrays;
042import java.util.Collection;
043import java.util.Iterator;
044
045/**
046 * Event fired when children are added to or removed from a <code>BeanContext</code>.
047 * Whether they were added or removed depends entirely on which method
048 * of the listener interface was called.
049 *
050 * @author John Keiser
051 * @since 1.2
052 * @see java.beans.beancontext.BeanContextMembershipListener
053 */
054public class BeanContextMembershipEvent extends BeanContextEvent {
055        private static final long serialVersionUID = 3499346510334590959L;
056
057        /**
058         * The children that were added or removed.
059         */
060        protected Collection children;
061
062        /**
063         * Create a new membership event.
064         * @param context the event source.
065         * @param children the children added to or removed from the source.
066         */
067        public BeanContextMembershipEvent(BeanContext context, Collection children) {
068                super(context);
069                this.children = children;
070        }
071
072        /**
073         * Create a new membership event.
074         * @param context the event source.
075         * @param children the children added to or removed from the source.
076         */
077        public BeanContextMembershipEvent(BeanContext context, Object[] children) {
078                super(context);
079                this.children = Arrays.asList(children);
080        }
081
082        /**
083         * The number of children removed or added.
084         * @return the number of children removed or added.
085         */
086        public int size() {
087                return children.size();
088        }
089
090        /**
091         * An iterator that will step through all the children.
092         * @return an iterator over all the children.
093         */
094        public Iterator iterator() {
095                return children.iterator();
096        }
097
098        /**
099         * An array of the children.
100         * @return an array of the children.
101         */
102        public Object[] toArray() {
103                return children.toArray();
104        }
105
106        /**
107         * Tell whether the <code>Object</code> is one of the children added or removed.
108         * @param child the child to check.
109         * @return whether the <code>Object</code> is added or removed.
110         */
111        public boolean contains(Object child) {
112                return children.contains(child);
113        }
114}