org.thales.punch.libraries.utils.api

Class RoundRobinIterator<T>

java.lang.Object

org.thales.punch.libraries.utils.api.RoundRobinIterator<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>

public class RoundRobinIterator<T>
extends Object
implements Iterator<T>

A handy infinite round robin iterator. It allows you to iterate over a collection using a round robin strategy, yet remove items temporarily and restore them later on.

This is useful to deal with connection pools.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
static <T> RoundRobinIterator<T>	createDisabled(List<T> collection) Create a round robin iterator that is disabled to start with.
static <T> RoundRobinIterator<T>	createEnabled(List<T> coll) Create a round robin iterator that is enabled at startup.
List<T>	getDisabledItems()
boolean	hasDisabledItems()
boolean	hasNext()
T	next()
void	remove()
void	restore(T v) Mark an item as enabled.

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

Method Detail

createDisabled

public static <T> RoundRobinIterator<T> createDisabled(List<T> collection)

Create a round robin iterator that is disabled to start with. I.e you will have to invoke the restore method on each item.

Type Parameters:

T -

Parameters:

collection - you items

Returns:

a round robin iterator

createEnabled

public static <T> RoundRobinIterator<T> createEnabled(List<T> coll)

Create a round robin iterator that is enabled at startup.

Type Parameters:

T -

Parameters:

collection - you items

Returns:

a round robin iterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

remove

public void remove()

Specified by:

remove in interface Iterator<T>

restore

public void restore(T v)

Mark an item as enabled. This item must have been obtained from your iterator. You cannot add new items after the iterator creation.

Parameters:

v - the item to re-enable

hasDisabledItems

public boolean hasDisabledItems()

Returns:

true if some items are disabled.

getDisabledItems

public List<T> getDisabledItems()