org.ontoware.aifbcommons.collection
Interface ClosableIterator<E>

All Superinterfaces:

java.util.Iterator<E>

public interface ClosableIterator<E>
extends java.util.Iterator<E>

An closabel iterator over a collection. Iterator takes the place of Enumeration in the Java collections framework.

Author:

Josh Bloch, adapter by Max Voelkel

See Also:

Collection, ListIterator, Enumeration

Method Summary

void	close() The uderlying implementation frees resources.
boolean	hasNext() Returns true if the iteration has more elements.
E	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).

Method Detail

hasNext

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<E>

Returns:

true if the iterator has more elements.

next

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

Returns:

the next element in the iteration.

Throws:

NoSuchElementException - iteration has no more elements.

remove

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<E>

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.

close

void close()

The uderlying implementation frees resources. For some it is absolutely necessary to call this method.