uk.ac.leeds.ccg.andyt.grids.core
Class AbstractIterator

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.grids.core.AbstractIterator
All Implemented Interfaces:
java.util.Iterator
Direct Known Subclasses:
Grid2DSquareCellDoubleChunk64CellMapIterator, Grid2DSquareCellDoubleChunkArrayIterator, Grid2DSquareCellDoubleChunkJAIIterator, Grid2DSquareCellDoubleChunkMapIterator, Grid2DSquareCellDoubleChunkRAFIterator, Grid2DSquareCellDoubleIterator, Grid2DSquareCellIntChunk64CellMapIterator, Grid2DSquareCellIntChunkArrayIterator, Grid2DSquareCellIntChunkJAIIterator, Grid2DSquareCellIntChunkMapIterator, Grid2DSquareCellIntChunkRAFIterator, Grid2DSquareCellIntIterator

public abstract class AbstractIterator
extends java.lang.Object
implements java.util.Iterator

A basic wrapper for the interface.


Constructor Summary
AbstractIterator()
           
 
Method Summary
abstract  boolean hasNext()
          Returns true if the iteration has more elements.
abstract  java.lang.Object next()
          Returns the next element in the iteration.
abstract  void remove()
          Removes from the underlying collection the last element returned by the iterator (optional operation).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractIterator

public AbstractIterator()
Method Detail

hasNext

public abstract 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 java.util.Iterator
Returns:
true if the iterator has more elements.

next

public abstract java.lang.Object next()
Returns the next element in the iteration.

Specified by:
next in interface java.util.Iterator
Returns:
the next element in the iteration.
Throws:
NoSuchElementException - iteration has no more elements.

remove

public abstract 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 java.util.Iterator
Throws:
java.lang.UnsupportedOperationException - if the remove operation is not supported by this Iterator.
java.lang.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.