net.markenwerk.commons.iterators

Class ProtectingIterator<Payload>

java.lang.Object

net.markenwerk.commons.iterators.ProtectingIterator<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, ProtectedIterator<Payload>

public final class ProtectingIterator<Payload>
extends Object
implements ProtectedIterator<Payload>

An ProtectingIterator is an ProtectedIterator that can be wrapped around a given Iterator and guarantees that every call to Iterator.remove() throws an UnsupportedOperationException and doesn't alter the underlying Iterator.

Since:

1.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ProtectingIterator(Iterator<? extends Payload> iterator) Creates a new ProtectingIterator from the given Iterator and the given Predicate.

Method Summary

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

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

ProtectingIterator

public ProtectingIterator(Iterator<? extends Payload> iterator)
                   throws IllegalArgumentException

Creates a new ProtectingIterator from the given Iterator and the given Predicate.

Parameters:

iterator - The Iterator, around which the new NullFreeIterator will be wrapped.

Throws:

IllegalArgumentException - If the given Iterator is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Payload>

next

public Payload next()

Specified by:

next in interface Iterator<Payload>

remove

public void remove()

Specified by:

remove in interface Iterator<Payload>