/* java.beans.beancontext.BeanContextMembershipEvent
   Copyright (C) 1999, 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.beans.beancontext;

import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;

/**
 * Event fired when children are added to or removed from a <code>BeanContext</code>.
 * Whether they were added or removed depends entirely on which method
 * of the listener interface was called.
 *
 * @author John Keiser
 * @since 1.2
 * @see java.beans.beancontext.BeanContextMembershipListener
 */
public class BeanContextMembershipEvent extends BeanContextEvent {
	/**
	 * The children that were added or removed.
	 */
	protected Collection children;

	/**
	 * Create a new membership event.
	 * @param context the event source.
	 * @param children the children added to or removed from the source.
	 */
	public BeanContextMembershipEvent(BeanContext context, Collection children) {
		super(context);
		this.children = children;
	}

	/**
	 * Create a new membership event.
	 * @param context the event source.
	 * @param children the children added to or removed from the source.
	 */
	public BeanContextMembershipEvent(BeanContext context, Object[] children) {
		super(context);
		this.children = Arrays.asList(children);
	}

	/**
	 * The number of children removed or added.
	 * @return the number of children removed or added.
	 */
	public int size() {
		return children.size();
	}

	/**
	 * An iterator that will step through all the children.
	 * @return an iterator over all the children.
	 */
	public Iterator iterator() {
		return children.iterator();
	}

	/**
	 * An array of the children.
	 * @return an array of the children.
	 */
	public Object[] toArray() {
		return children.toArray();
	}

	/**
	 * Tell whether the <code>Object</code> is one of the children added or removed.
	 * @param child the child to check.
	 * @return whether the <code>Object</code> is added or removed.
	 */
	public boolean contains(Object child) {
		return children.contains(child);
	}
}