org.josef.util

Class RandomElementIterator<E>

java.lang.Object

org.josef.util.RandomElementIterator<E>

Type Parameters:

E - The element type for this iterator.

All Implemented Interfaces:

Iterator<E>

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

An Iterator that returns elements in random order.

Version:

1.0 $Revision: 5794 $

Author:

Kees Schotanus

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Determines whether more elements exist.
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

RandomElementIterator

public RandomElementIterator(List<E> elements)

Creates this RandomElementIterator using the supplied elements.

Parameters:

elements - The list of elements to return randomly.

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 more elements exist.

Specified by:

hasNext in interface Iterator<E>

Returns:

True when more elements exist, otherwise false.

next

public E next()

Gets the next element.

Specified by:

next in interface Iterator<E>

Returns:

The next element.

Throws:

NoSuchElementException - When this method is called when there are no more elements.

remove

public void remove()

Throws an UnsupportedOperationException.

Specified by:

remove in interface Iterator<E>

Throws:

UnsupportedOperationException - Always.