// 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;
import org.forester.phylogeny.Phylogeny;
import org.forester.phylogeny.PhylogenyNode;
-/*
- * @author Christian Zmasek
- */
public class ExternalForwardIterator implements PhylogenyNodeIterator {
private PhylogenyNode _current_node;
/**
* Constructor for ExternalForwardIterator.
- *
+ *
* @param tree
* the tree on which to iterate over all external nodes.
*/
public ExternalForwardIterator( final Phylogeny phylogeny ) throws IllegalArgumentException {
if ( phylogeny.isEmpty() ) {
- throw new IllegalArgumentException( "Attempt to use ExternalForwardIterator on an empty phylogeny." );
+ throw new IllegalArgumentException( "attempt to use ExternalForwardIterator on an empty phylogeny" );
}
PhylogenyNode n = phylogeny.getRoot();
while ( !n.isExternal() ) {
/*
* (non-Javadoc)
- *
+ *
* @see java.util.Iterator#hasNext()
*/
+ @Override
public boolean hasNext() {
return getCurrentNode() != null;
}
/*
* (non-Javadoc)
- *
+ *
* @see java.util.Iterator#next()
*/
+ @Override
public PhylogenyNode next() throws NoSuchElementException {
if ( !hasNext() ) {
- throw new NoSuchElementException( "Attempt to call \"next()\" on iterator which has no more next elements." );
+ throw new NoSuchElementException( "attempt to call \"next()\" on iterator which has no more next elements" );
}
final PhylogenyNode n = getCurrentNode();
if ( n == getLastExtNode() ) {
/**
* Not supported.
- *
+ *
*/
+ @Override
public void remove() {
throw new UnsupportedOperationException();
}
/**
* DOCUMENT ME!
*/
+ @Override
public void reset() {
setCurrentNode( getFirstExtNode() );
}