PreorderTreeIterator

java.lang.Object

org.forester.phylogeny.iterators.PreorderTreeIterator

All Implemented Interfaces:: Iterator<PhylogenyNode>, PhylogenyNodeIterator

public final class PreorderTreeIterator extends Object implements PhylogenyNodeIterator

Constructor Summary

Constructors

Constructor

Description

PreorderTreeIterator(Phylogeny tree)

PreorderTreeIterator(PhylogenyNode node)
Method Summary

Modifier and Type

Method

Description

final boolean

hasNext()

final PhylogenyNode

next()

Advances the Iterator by one.

final void

remove()

Not supported.

final void

reset()

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
- PreorderTreeIterator
  
  public PreorderTreeIterator(Phylogeny tree) throws IllegalArgumentException
  
  Parameters:
  
  tree - Phylogeny for which a Iterator is to be constructed.
  
  Throws:
  
  IllegalArgumentException
- PreorderTreeIterator
  
  public PreorderTreeIterator(PhylogenyNode node) throws IllegalArgumentException
  
  Throws:
  
  IllegalArgumentException
Method Details
- hasNext
  
  public final boolean hasNext()
  
  Specified by:
  
  hasNext in interface Iterator<PhylogenyNode>
  
  Specified by:
  
  hasNext in interface PhylogenyNodeIterator
- next
  
  public final PhylogenyNode next() throws NoSuchElementException
  
  Advances the Iterator by one.
  
  Specified by:
  
  next in interface Iterator<PhylogenyNode>
  
  Specified by:
  
  next in interface PhylogenyNodeIterator
  
  Throws:
  
  NoSuchElementException
- remove
  
  public final void remove()
  
  Not supported.
  
  Specified by:
  
  remove in interface Iterator<PhylogenyNode>
- reset
  
  public final void reset()
  
  Specified by:
  
  reset in interface PhylogenyNodeIterator