net.markenwerk.commons.iterators

Class ProtectingIterator<Payload>

java.lang.Object

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

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 AbstractProtectedIterator<Payload>

A ProtectingIterator is an AbstractProtectedIterator that can be wrapped around a given Iterator and guarantees that every call to AbstractProtectedIterator.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.

Method Summary

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

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

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.

Parameters:

iterator - The Iterator to iterate over.

Throws:

IllegalArgumentException - If the given Iterator is null.

Method Detail

hasNext

public boolean hasNext()

next

public Payload next()
             throws NoSuchElementException

Throws:

NoSuchElementException