ExternalForwardIterator

java.lang.Object

org.forester.phylogeny.iterators.ExternalForwardIterator

All Implemented Interfaces:: Iterator<PhylogenyNode>, PhylogenyNodeIterator

public class ExternalForwardIterator extends Object implements PhylogenyNodeIterator

Constructor Summary

Constructors

Constructor

Description

ExternalForwardIterator(Phylogeny phylogeny)

Constructor for ExternalForwardIterator.
Method Summary

Modifier and Type

Method

Description

boolean

hasNext()

PhylogenyNode

next()

void

remove()

Not supported.

void

reset()

DOCUMENT ME!

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

Constructor Details
- ExternalForwardIterator
  
  public ExternalForwardIterator(Phylogeny phylogeny) throws IllegalArgumentException
  
  Constructor for ExternalForwardIterator.
  
  Parameters:
  
  tree - the tree on which to iterate over all external nodes.
  
  Throws:
  
  IllegalArgumentException
Method Details
- hasNext
  
  public boolean hasNext()
  
  Specified by:
  
  hasNext in interface Iterator<PhylogenyNode>
  
  Specified by:
  
  hasNext in interface PhylogenyNodeIterator
- next
  
  public PhylogenyNode next() throws NoSuchElementException
  
  Specified by:
  
  next in interface Iterator<PhylogenyNode>
  
  Specified by:
  
  next in interface PhylogenyNodeIterator
  
  Throws:
  
  NoSuchElementException
- remove
  
  public void remove()
  
  Not supported.
  
  Specified by:
  
  remove in interface Iterator<PhylogenyNode>
- reset
  
  public void reset()
  
  DOCUMENT ME!
  
  Specified by:
  
  reset in interface PhylogenyNodeIterator