org.helenus.commons.collections.iterators

Class SnapshotIterator<T>

java.lang.Object

org.helenus.commons.collections.iterators.SnapshotIterator<T>

Type Parameters:

T - the type of elements iterated by the iterator

All Implemented Interfaces:

Serializable, Iterator<T>, ResettableIterator<T>

public class SnapshotIterator<T>
extends Object
implements ResettableIterator<T>, Serializable

The SnapshotIterator class provides support for creating a snapshot from another iterator; preserving the order of returned elements.

Note: An instance of this class can be properly serialized even if the iterator object passed to its constructor is not serializable as long as its elements are serializable. If the elements are of type Map.Entry, then they will be cloned and made serializable as long as the associated keys and values are serializable.

The implementation provided here takes a snapshot of all elements returned by the given iterator by iterating them and then releasing the iterator.

Since:

1.0

Version:

1 - Jan 15, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

See Also:

Serialized Form

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors

Constructor and Description
SnapshotIterator(Iterable<T> i) Instantiates a new SnapshotIterator object.
SnapshotIterator(Iterator<T> i) Instantiates a new SnapshotIterator object.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
T	next()
void	remove()
void	reset()

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

SnapshotIterator

public SnapshotIterator(Iterator<T> i)

Instantiates a new SnapshotIterator object.

Parameters:

i - the iterator to create a snapshot for

Throws:

NullPointerException - if i is null

SnapshotIterator

public SnapshotIterator(Iterable<T> i)

Instantiates a new SnapshotIterator object.

Parameters:

i - the iterable object to snapshot it's iterator

Throws:

NullPointerException - if i is null

Method Detail

reset

public void reset()

Specified by:

reset in interface ResettableIterator<T>

See Also:

ResettableIterator.reset()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

See Also:

Iterator.hasNext()

next

public T next()

Specified by:

next in interface Iterator<T>

See Also:

Iterator.next()

remove

public void remove()

Specified by:

remove in interface Iterator<T>

Throws:

UnsupportedOperationException - always thrown

See Also:

Iterator.remove()