net.markenwerk.commons.iterators

Interface ProtectedIterator<Payload>

Type Parameters:

Payload - The payload type.

All Superinterfaces:

Iterator<Payload>

All Known Subinterfaces:

ProtectedBidirectionalIterator<Payload>

All Known Implementing Classes:

AbstractIndexedIterator, AbstractProtectedBidirectionalIterator, AbstractProtectedIterator, ArrayIterator, BooleanArrayIterator, ByteArrayIterator, CharacterArrayIterator, CountDownIterator, CountUpIterator, DoubleArrayIterator, EmptyIterator, EnumerationIterator, FloatArrayIterator, InfiniteIterator, IntegerArrayIterator, LongArrayIterator, LookAheadIterator, NodeListIterator, ObjectIterator, OptionalIterator, PairIterator, ProtectingBidirectionalIterator, ProtectingIterator, ShortArrayIterator, StringTokenizerIterator, TripleIterator, TupleIterator

public interface ProtectedIterator<Payload>
extends Iterator<Payload>

A ProtectedIterator is an Iterator that guarantees that every call to remove() throws an UnsupportedOperationException and doesn't alter the underlying data structure.

ProtectedIterator is a marker interface.

Since:

1.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Method Summary

Modifier and Type	Method and Description
void	remove() Always throws an UnsupportedOperationException.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Method Detail

remove

void remove()
     throws UnsupportedOperationException

Always throws an UnsupportedOperationException.

Specified by:

remove in interface Iterator<Payload>

Throws:

UnsupportedOperationException - When trying to remove an element from an ProtectedIterator.