org.openimaj.util.iterator

Class IterableIterator<T>

java.lang.Object

org.openimaj.util.iterator.IterableIterator<T>

Type Parameters:

T - Type of object being iterated over.

All Implemented Interfaces:

Iterable<T>

public class IterableIterator<T>
extends Object
implements Iterable<T>

Wrapper to allow an Iterator as an Iterable so it can be used in an a foreach loop. The iterator is consumed by the loop and so must only be used once. Normal usage is as follows:

 for (T t : IterableIterator.in(iterator)) {
        // ...
 }
 

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
static <T> Iterable<T>	in(Iterator<T> iterator) Wrapper to allow an Iterator as an Iterable so it can be used in a foreach loop.
Iterator<T>	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

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

in

public static <T> Iterable<T> in(Iterator<T> iterator)

Wrapper to allow an Iterator as an Iterable so it can be used in a foreach loop. The iterator is consumed by the loop and so must only be used once. Normal usage is as follows:

 for (T t : IterableIterator.in(iterator)) {
        // ...
 }
 

Type Parameters:

T - Type of object being iterated over.

Parameters:

iterator - an iterator

Returns:

an iterable wrapper which will traverse the iterator once