// Copyright (C) 2008-2009 Christian M. Zmasek
// Copyright (C) 2008-2009 Burnham Institute for Medical Research
// All rights reserved
-//
+//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
-//
+//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// 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
*/
+ @Override
public boolean hasNext() {
return !getQueue().isEmpty();
}
/**
* Returns the next PhylogenyNode.
- *
+ *
* @return the next PhylogenyNode
* @throws NoSuchElementException
* if iteration is complete
*/
+ @Override
public PhylogenyNode next() throws NoSuchElementException {
if ( !hasNext() ) {
throw new NoSuchElementException( "Attempt to call \"next()\" on iterator which has no more next elements." );
/**
* Not supported.
- *
+ *
*/
+ @Override
public void remove() {
throw new UnsupportedOperationException();
}
/**
* Resets the iterator.
*/
+ @Override
public void reset() {
getQueue().clear();
getQueue().enqueue( getRoot() );