net.markenwerk.commons.iterables

Class IndexedIterable<Payload>

java.lang.Object

net.markenwerk.commons.iterables.IndexedIterable<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<net.markenwerk.commons.datastructures.Entry<Integer,Payload>>

public final class IndexedIterable<Payload>
extends Object
implements Iterable<net.markenwerk.commons.datastructures.Entry<Integer,Payload>>

An IndexedIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that yield every value yielded by an given Iterator generated by the given Iterable as an Entry whose key is the index of the yielded element.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
IndexedIterable(Iterable<? extends Payload> iterable) Creates a new IndexedIterable.

Method Summary

Modifier and Type	Method and Description
net.markenwerk.commons.iterators.IndexedIterator<Payload>	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

IndexedIterable

public IndexedIterable(Iterable<? extends Payload> iterable)
                throws IllegalArgumentException

Creates a new IndexedIterable.

Parameters:

iterable - The Iterable to iterate over.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public net.markenwerk.commons.iterators.IndexedIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<net.markenwerk.commons.datastructures.Entry<Integer,Payload>>