Package repast.simphony.util.collections

Class IteratorOverIterables<T>

java.lang.Object
repast.simphony.util.collections.IteratorOverIterables<T>
All Implemented Interfaces:
Iterator<T>
public abstract class IteratorOverIterables<T> extends Object implements Iterator<T>
Abstract base class for creating an Iterator that wraps object that returns multiple iterables. The iterator will iterate over all the objects returned by each iterable.
Version:
$Revision$ $Date$
Author:
Nick Collier

  • Field Details

    • nextIter

      protected Iterator<T> nextIter

    • nextObj

      protected T nextObj

  • Constructor Details

    • IteratorOverIterables

      public IteratorOverIterables()

  • Method Details

    • getNextObj

      protected T getNextObj()

    • init

      protected void init()
      Initializes the iterator. This needs to be called in the constructor of the implementing subclass.

    • getNext

      protected abstract Iterable<T> getNext()
      Gets the next Iterable from which to retrieve the next object.
      Returns:
      the next Iterable from which to retrieve the next object.

    • hasNext

      public boolean hasNext()
      Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)
      Specified by:
      hasNext in interface Iterator<T>
      Returns:
      true if the iterator has more elements.

    • next

      public T next()
      Returns the next element in the iteration. Calling this method repeatedly until the hasNext() method returns false will return each element in the underlying collection exactly once.
      Specified by:
      next in interface Iterator<T>
      Returns:
      the next element in the iteration.
      Throws:
      NoSuchElementException - iteration has no more elements.

    • remove

      public void remove()
      Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
      Specified by:
      remove in interface Iterator<T>
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this Iterator.
      IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.