// $Id: ChildGenerator.java 15579 2008-08-18 21:41:39Z tfmorris $
// Copyright (c) 2008 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.util;
import java.util.Iterator;
/**
* Interface used in {@link org.argouml.cognitive.ListSet} to compute transitive
* closures. it is based on the GEF interface of the same name by Jason Robbins
* {@link org.tigris.gef.util.ChildGenerator}, but uses an Iterator instead of
* an Enumeration for better compatibility with Collections.
* <p>
* The iterator method is given a unique name to allow it to be used in
* combination with other interfaces of a similar style, but if a class only
* implements this interface, it may want to implement {@link Iterable} for
* greater usage convenience and make this the default iterator.
*
* @author Tom Morris
*/
public interface ChildGenerator {
/**
* Get an Iterator which iterates through the children of the given object
*
* @param parent the parent of the children to be iterated through
* @return an iterator for the children of the given parent
*/
public Iterator childIterator(Object parent);
}