net.markenwerk.commons.iterables

Class ConvertingIterable<From,To>

java.lang.Object

net.markenwerk.commons.iterables.ConvertingIterable<From,To>

Type Parameters:

From - The type to convert values from.

To - The type to convert values to.

All Implemented Interfaces:

Iterable<To>

public final class ConvertingIterable<From,To>
extends Object
implements Iterable<To>

A ConvertingIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that 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
ConvertingIterable(Iterable<? extends From> iterable, Converter<? super From,? extends To> converter) Creates a new ConvertingIterable.

Method Summary

Modifier and Type	Method and Description
ConvertingIterator<From,To>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ConvertingIterable

public ConvertingIterable(Iterable<? extends From> iterable,
                          Converter<? super From,? extends To> converter)
                   throws IllegalArgumentException

Creates a new ConvertingIterable.

Parameters:

iterable - The Iterable to iterate over.

converter - The Converter to be used.

Throws:

IllegalArgumentException - If the given Iterable is null or if the given Converter is null.

Method Detail

iterator

public ConvertingIterator<From,To> iterator()

Specified by:

iterator in interface Iterable<To>