jdsl.core.api
Interface LocatorIterator

All Superinterfaces:

ObjectIterator

All Known Implementing Classes:

ArrayLocatorIterator

public interface LocatorIterator

extends ObjectIterator

Iterator over a set of locators. No order of the locators 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 locator to be considered. With each call to next(), the iterator skips over another locator and returns the locator skipped over, until the iterator is positioned after the last locator. Note that NoSuchElementException indicates two different failure states: when the iterator is positioned before the first locator, locator(), key(), and element() fail; when the iterator is positioned after the last locator, next() fails.

Version:

JDSL 2.1.1

Author:

Mark Handy

Method Summary

Object	element() Shortcut for locator().element().
Object	key() Shortcut for locator().key()
Locator	locator()
Locator	nextLocator()

Methods inherited from interface jdsl.core.api.ObjectIterator

hasNext, nextObject, object, reset

Method Detail

nextLocator

public Locator nextLocator()
                    throws NoSuchElementException

Returns:

Next locator to consider

Throws:

NoSuchElementException - if iterator has moved past the last locator

locator

public Locator locator()
                throws NoSuchElementException

Returns:

The locator returned by the most recent next()

Throws:

NoSuchElementException - When the iterator is in its initial, before-the-first-locator state

key

public Object key()
           throws NoSuchElementException

Shortcut for locator().key()

Returns:

Key of the locator that would be returned by locator()

Throws:

NoSuchElementException - When the iterator is in its initial, before-the-first-locator state

element

public Object element()
               throws NoSuchElementException

Shortcut for locator().element(). Same as the inherited object() method.

Returns:

Element of the locator that would be returned by locator()

Throws:

NoSuchElementException - When the iterator is in its initial, before-the-first-locator state