com.helger.commons.collection.iterate

Class IterableIterator<ELEMENTTYPE>

java.lang.Object

com.helger.commons.collection.iterate.IterableIterator<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type of elements to iterate.

All Implemented Interfaces:

IIterableIterator<ELEMENTTYPE>, Iterable<ELEMENTTYPE>, Iterator<ELEMENTTYPE>

Direct Known Subclasses:

FileSystemIterator

public class IterableIterator<ELEMENTTYPE>
extends Object
implements IIterableIterator<ELEMENTTYPE>

This class is used for simpler iteration over an Iterator via the new "for" syntax.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IterableIterator(ELEMENTTYPE[] aCont)
protected	IterableIterator(Iterable<ELEMENTTYPE> aCont)
protected	IterableIterator(Iterator<ELEMENTTYPE> aIter)

Method Summary

Modifier and Type	Method and Description
static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE>	create(ELEMENTTYPE[] aCont)
static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE>	create(Iterable<ELEMENTTYPE> aCont)
static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE>	create(Iterator<ELEMENTTYPE> aIter)
static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE>	createEmpty()
boolean	hasNext()
Iterator<ELEMENTTYPE>	iterator()
ELEMENTTYPE	next()
void	remove()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IterableIterator

protected IterableIterator(@Nonnull
                           ELEMENTTYPE[] aCont)

IterableIterator

protected IterableIterator(@Nonnull
                           Iterable<ELEMENTTYPE> aCont)

IterableIterator

protected IterableIterator(@Nonnull
                           Iterator<ELEMENTTYPE> aIter)

Method Detail

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENTTYPE>

next

@Nullable
public final ELEMENTTYPE next()

Description copied from interface: IIterableIterator

Specified by:

next in interface IIterableIterator<ELEMENTTYPE>

Specified by:

next in interface Iterator<ELEMENTTYPE>

Returns:

The next element. No constraint whether the element can be null or non-null.

remove

public final void remove()

Specified by:

remove in interface Iterator<ELEMENTTYPE>

iterator

@Nonnull
public final Iterator<ELEMENTTYPE> iterator()

Specified by:

iterator in interface Iterable<ELEMENTTYPE>

toString

public String toString()

Overrides:

toString in class Object

createEmpty

@Nonnull
public static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE> createEmpty()

create

@Nonnull
public static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE> create(@Nonnull
                                                                            ELEMENTTYPE[] aCont)

create

@Nonnull
public static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE> create(@Nonnull
                                                                            Iterable<ELEMENTTYPE> aCont)

create

@Nonnull
public static <ELEMENTTYPE> IIterableIterator<ELEMENTTYPE> create(@Nonnull
                                                                            Iterator<ELEMENTTYPE> aIter)