net.markenwerk.commons.iterators

Class PrefixedIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

public final class PrefixedIterator<Payload>
extends Object
implements Iterator<Payload>

A PrefixedIterator is an Iterator that can be wrapped around a given Iterator and yields some given prefix values before yielding all values yielded by the given Iterator.

Calling AbstractProtectedIterator.remove() calls Iterator.remove() removed on the wrapped Iterator, if, and only iff, the last call to AbstractIndexedIterator.next() didn't return a prefix value.

Since:

2.1.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
PrefixedIterator(Iterator<? extends Payload> iterator, Payload... prefixes) Creates a new PrefixedIterator.

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

PrefixedIterator

public PrefixedIterator(Iterator<? extends Payload> iterator,
                        Payload... prefixes)
                 throws IllegalArgumentException

Creates a new PrefixedIterator.

Parameters:

iterator - The Iterator to iterate over.

prefixes - The prefixes to be yielded.

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()
             throws NoSuchElementException

Specified by:

next in interface Iterator<Payload>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException,
                   UnsupportedOperationException

Specified by:

remove in interface Iterator<Payload>

Throws:

IllegalStateException

UnsupportedOperationException