net.markenwerk.commons.iterators

Class ConvertingIterator<From,To>

java.lang.Object

net.markenwerk.commons.iterators.ConvertingIterator<From,To>

Type Parameters:

From - The type to convert values from.

To - The type to convert values to.

All Implemented Interfaces:

Iterator<To>

public final class ConvertingIterator<From,To>
extends Object
implements Iterator<To>

A ConvertingIterator is an Iterator that can be wrapped around a given Iterator and converts all values with a given Converter.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ConvertingIterator(Iterator<? extends From> iterator, Converter<? super From,? extends To> converter) Creates a new ConvertingIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
To	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

ConvertingIterator

public ConvertingIterator(Iterator<? extends From> iterator,
                          Converter<? super From,? extends To> converter)
                   throws IllegalArgumentException

Creates a new ConvertingIterator.

Parameters:

iterator - The Iterator to be used.

converter - The Converter to be used.

Throws:

IllegalArgumentException - If the given Iterator is null or the given Converter is null.

Method Detail

hasNext

public boolean hasNext()
                throws NoSuchElementException

Specified by:

hasNext in interface Iterator<To>

Throws:

NoSuchElementException

next

public To next()
        throws NoSuchElementException

Specified by:

next in interface Iterator<To>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException,
                   UnsupportedOperationException

Specified by:

remove in interface Iterator<To>

Throws:

IllegalStateException

UnsupportedOperationException