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

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.utilities.AbstractIterator
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkMapIterator

All Implemented Interfaces:

java.util.Iterator

public class Grid2DSquareCellIntChunkMapIterator
extends AbstractIterator

For iterating through the values in a Grid2DSquareCellIntChunkMap instance. The values are not returned in any particular order.

Constructor Summary

Grid2DSquareCellIntChunkMapIterator()
Creates a new instance of Grid2DSquareIntIterator

Grid2DSquareCellIntChunkMapIterator(Grid2DSquareCellIntChunkMap grid2DSquareCellIntChunkMap)
Creates a new instance of Grid2DSquareIntIterator

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
java.lang.Object	next() Returns the next element in the iteration.
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

Grid2DSquareCellIntChunkMapIterator

public Grid2DSquareCellIntChunkMapIterator()

Creates a new instance of Grid2DSquareIntIterator

Grid2DSquareCellIntChunkMapIterator

public Grid2DSquareCellIntChunkMapIterator(Grid2DSquareCellIntChunkMap grid2DSquareCellIntChunkMap)

Creates a new instance of Grid2DSquareIntIterator

Parameters:

grid2DSquareCellIntChunkMap - The Grid2DSquareCellIntChunkMap to iterate over

Method Detail

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 java.util.Iterator

Specified by:

hasNext in class AbstractIterator

Returns:

true if the iterator has more elements.

next

public java.lang.Object next()

Returns the next element in the iteration.

Specified by:

next in interface java.util.Iterator

Specified by:

next in class AbstractIterator

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - iteration has no more elements.

remove

public void remove()

Description copied from class: AbstractIterator

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

Specified by:

remove in class AbstractIterator