net.markenwerk.commons.iterators

Class ProtectingBidirectionalIterator<Payload>

java.lang.Object

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

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, BidirectionalIterator<Payload>, ProtectedBidirectionalIterator<Payload>, ProtectedIterator<Payload>

public final class ProtectingBidirectionalIterator<Payload>
extends AbstractProtectedBidirectionalIterator<Payload>

A ProtectingBidirectionalIterator is an AbstractProtectedIterator that can be wrapped around a given BidirectionalIterator and guarantees that every call to AbstractProtectedIterator.remove() throws an UnsupportedOperationException and doesn't alter the underlying Iterator.

Since:

3.1.1

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ProtectingBidirectionalIterator(BidirectionalIterator<? extends Payload> iterator) Creates a new ProtectingBidirectionalIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
boolean	hasPrevious() Returns whether this BidirectionalIterator has a previous element.
Payload	next()
Payload	previous() Returns the previous element.

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 net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ProtectingBidirectionalIterator

public ProtectingBidirectionalIterator(BidirectionalIterator<? extends Payload> iterator)
                                throws IllegalArgumentException

Creates a new ProtectingBidirectionalIterator.

Parameters:

iterator - The BidirectionalIterator to iterate over.

Throws:

IllegalArgumentException - If the given BidirectionalIterator is null .

Method Detail

hasNext

public boolean hasNext()

next

public Payload next()
             throws NoSuchElementException

Throws:

NoSuchElementException

hasPrevious

public boolean hasPrevious()

Description copied from interface: BidirectionalIterator

Returns whether this BidirectionalIterator has a previous element.

Returns:

Whether this BidirectionalIterator has a previous element.

previous

public Payload previous()
                 throws NoSuchElementException

Description copied from interface: BidirectionalIterator

Returns the previous element.

Returns:

The previous element in the iteration.

Throws:

NoSuchElementException - If this BidirectionalIterator has no previous element.