// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
//
// Contact: phylosoft @ gmail . com
-// WWW: www.phylosoft.org/forester
+// WWW: https://sites.google.com/site/cmzmasek/home/software/forester
package org.forester.phylogeny.iterators;
/*
* An iterator to iterate a Phylogeny in level order.
- *
+ *
* Created: 10/23/2005 by Christian M. Zmasek. Last modified: 10/23/2005 by
* Christian M. Zmasek.
- *
+ *
* @author Christian M. Zmasek
- *
+ *
* @version 1.000
*/
public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
/**
* Creates a new LevelOrderTreeIterator for iterating over all the nodes of
* Phylogeny phylogeny
- *
+ *
* @param phylogeny
* the Phylogeny to iterate over
* @throws IllegalArgumentException
/**
* Creates a new LevelOrderTreeIterator for iterating over all the child
* nodes of PhylogenyNode node (including node itself).
- *
+ *
* @param node
* the parent of the nodes to iterate over
*/
// ---------------
/**
* Returns the queue upon which this iterator is based.
- *
+ *
*/
private Queue getQueue() {
return _queue;
/**
* Returns the root of the phylogeny this iterators parses over.
- *
+ *
* @return the root of the phylogeny this iterators parses over.
*/
private PhylogenyNode getRoot() {
/**
* Returns true is this iterator has at least one more element, false
* otherwise.
- *
+ *
* @return true is this iterator has at least one more element, false
* otherwise
*/
/**
* Returns the next PhylogenyNode.
- *
+ *
* @return the next PhylogenyNode
* @throws NoSuchElementException
* if iteration is complete
/**
* Not supported.
- *
+ *
*/
@Override
public void remove() {