org.josef.util

Class RoundRobinElementIterator<E>

java.lang.Object

org.josef.util.RoundRobinElementIterator<E>

Type Parameters:

E - The element type for this iterator.

All Implemented Interfaces:

Iterator<E>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
public class RoundRobinElementIterator<E>
extends Object
implements Iterator<E>

An Iterator that returns elements in round robin fashion.
The difference between a normal Iterator and this iterator, is that after all elements have been fetched, the elements can be fetched over and over again.

Version:

1.0 $Revision: 6277 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
RoundRobinElementIterator(List<E> elements) Creates this RoundRobinElementIterator using the supplied elements.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Determines whether there are more elements to get.
E	next() Gets the next element.
void	remove() Throws an UnsupportedOperationException.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

RoundRobinElementIterator

public RoundRobinElementIterator(List<E> elements)

Creates this RoundRobinElementIterator using the supplied elements.

Parameters:

elements - The list of element to return in round-robin fashion.

Throws:

IllegalArgumentException - When the supplied list of elements is empty.

NullPointerException - When the supplied list of elements is null.

Method Detail

hasNext

public boolean hasNext()

Determines whether there are more elements to get.

Specified by:

hasNext in interface Iterator<E>

Returns:

True (always).

next

public E next()

Gets the next element.

Specified by:

next in interface Iterator<E>

Returns:

The next element.

remove

public void remove()

Throws an UnsupportedOperationException.

Specified by:

remove in interface Iterator<E>

Throws:

UnsupportedOperationException - Always.