in progress...

[jalview.git] / forester / java / src / org / forester / phylogeny / iterators / LevelOrderTreeIterator.java

diff --git a/forester/java/src/org/forester/phylogeny/iterators/LevelOrderTreeIterator.java b/forester/java/src/org/forester/phylogeny/iterators/LevelOrderTreeIterator.java
index 1b1450f..8285274 100644 (file)
--- a/forester/java/src/org/forester/phylogeny/iterators/LevelOrderTreeIterator.java
+++ b/forester/java/src/org/forester/phylogeny/iterators/LevelOrderTreeIterator.java
@@ -5,7 +5,7 @@
 // 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
@@ -15,13 +15,13 @@
 // 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;
 
@@ -33,12 +33,12 @@ import org.forester.phylogeny.PhylogenyNode;
 
 /*
  * 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 {
@@ -53,7 +53,7 @@ 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
@@ -69,7 +69,7 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
     /**
      * 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
      */
@@ -83,7 +83,7 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
     // ---------------
     /**
      * Returns the queue upon which this iterator is based.
-     * 
+     *
      */
     private Queue getQueue() {
         return _queue;
@@ -91,7 +91,7 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
 
     /**
      * Returns the root of the phylogeny this iterators parses over.
-     * 
+     *
      * @return the root of the phylogeny this iterators parses over.
      */
     private PhylogenyNode getRoot() {
@@ -103,21 +103,23 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
     /**
      * 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." );
@@ -131,8 +133,9 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
 
     /**
      * Not supported.
-     * 
+     *
      */
+    @Override
     public void remove() {
         throw new UnsupportedOperationException();
     }
@@ -140,6 +143,7 @@ public class LevelOrderTreeIterator implements PhylogenyNodeIterator {
     /**
      * Resets the iterator.
      */
+    @Override
     public void reset() {
         getQueue().clear();
         getQueue().enqueue( getRoot() );