freenet.support

Class RandomArrayIterator<E>

java.lang.Object

freenet.support.RandomArrayIterator<E>

All Implemented Interfaces:

java.util.Iterator<E>

public class RandomArrayIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>

Reusable read-only iterator with randomized array iteration order. This iterator iterates over the underlying array, yielding its elements in an (optionally) randomized order. Instances can be reused by resetting them to their original position, optionally yielding a new random permutation of the array elements. Storage requirements are linear in the size of the underlying array, all instance operations finish in constant time. Instances of this class are not thread-safe.

Constructor Summary

Constructors

Constructor and Description
RandomArrayIterator(E[] array) Creates a new iterator for the given array.
RandomArrayIterator(E[] array, java.util.Random random) Creates a new randomized iterator for the given array.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
E	next()
void	remove()
void	reset(java.util.Random random) Resets this iterator.

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

RandomArrayIterator

public RandomArrayIterator(E[] array,
                           java.util.Random random)

Creates a new randomized iterator for the given array.

Parameters:

array - The underlying array

random - Random source for the iteration order

RandomArrayIterator

public RandomArrayIterator(E[] array)

Creates a new iterator for the given array. Initially, the array is iterated in the original ordering, reset(Random) the iterator to get a new random iteration ordering.

Parameters:

array - The underlying array

Method Detail

reset

public void reset(java.util.Random random)

Resets this iterator. If a random source is given, the next sequence of calls to next() will iterate over the array in a new random order. If it is null, the iteration order remains unaltered.

Parameters:

random - Random source for the next run, or null to repeat the previous run

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public E next()

Specified by:

next in interface java.util.Iterator<E>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E>