jdsl.map.api
Interface FaceIterator

All Superinterfaces:

ObjectIterator, PositionIterator

All Known Implementing Classes:

FaceIteratorAdapter

public interface FaceIterator

extends PositionIterator

Iterator over a set of faces. No order of the faces is required by this interface, although order may be promised or required by users of the interface. Conceptually, the iterator starts out positioned before the first face to be considered. With each call to nextFace(), the iterator skips over another face and returns the face skipped over, until the iterator is positioned beyond the last face. Note that NoSuchElementException indicates two different failure states: when the iterator is positioned before the first face, face() and element() fail; when the iterator is positioned after the last face, nextFace() fails.

Version:

$Id: FaceIterator.java,v 1.1 1999/08/23 01:59:09 mdh Exp $

Author:

Mark Handy

Method Summary

Face	face()
Face	nextFace()

Methods inherited from interface jdsl.core.api.PositionIterator

element, nextPosition, position

Methods inherited from interface jdsl.core.api.ObjectIterator

hasNext, nextObject, object, reset

Method Detail

nextFace

public Face nextFace()
              throws java.util.NoSuchElementException

Returns:

Next face to consider

Throws:

java.util.NoSuchElementException - if iterator has moved past the last face to be seen

face

public Face face()
          throws java.util.NoSuchElementException

Returns:

The face returned by the most recent successful nextFace()

Throws:

java.util.NoSuchElementException - When the iterator is in its initial, before-the-first-face state