com.helger.commons.collection.iterate

Class MapperIterator<SRCTYPE,ELEMENTTYPE>

java.lang.Object

com.helger.commons.collection.iterate.MapperIterator<SRCTYPE,ELEMENTTYPE>

Type Parameters:

SRCTYPE - The type of the source iterator

ELEMENTTYPE - The type of this iterator

All Implemented Interfaces:

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

public class MapperIterator<SRCTYPE,ELEMENTTYPE>
extends Object
implements IIterableIterator<ELEMENTTYPE>

A simple iterator that changes the object type from a source type to a destination type.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
MapperIterator(IIterableIterator<? extends SRCTYPE> aBaseIter, IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter) Constructor.
MapperIterator(Iterable<? extends SRCTYPE> aBaseCont, IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter) Constructor.
MapperIterator(Iterator<? extends SRCTYPE> aBaseIter, IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter) Constructor.

Method Summary

Modifier and Type	Method and Description
IFunction<? super SRCTYPE,? extends ELEMENTTYPE>	getConverter()
boolean	hasNext()
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 com.helger.commons.collection.iterate.IIterableIterator

iterator, withFilter, withMapper

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEach, forEachBreakable, forEachByIndex, getCount, getCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

MapperIterator

public MapperIterator(@Nonnull
                      IIterableIterator<? extends SRCTYPE> aBaseIter,
                      @Nonnull
                      IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter)

Constructor.

Parameters:

aBaseIter - The base iterable iterator to use. May not be null.

aConverter - The converter to be used. May not be null.

MapperIterator

public MapperIterator(@Nonnull
                      Iterable<? extends SRCTYPE> aBaseCont,
                      @Nonnull
                      IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter)

Constructor.

Parameters:

aBaseCont - The collection to iterate. May not be null.

aConverter - The converter to be used. May not be null.

MapperIterator

public MapperIterator(@Nonnull
                      Iterator<? extends SRCTYPE> aBaseIter,
                      @Nonnull
                      IFunction<? super SRCTYPE,? extends ELEMENTTYPE> aConverter)

Constructor.

Parameters:

aBaseIter - The base iterator to use. May not be null.

aConverter - The converter to be used. May not be null.

Method Detail

getConverter

@Nonnull
public IFunction<? super SRCTYPE,? extends ELEMENTTYPE> getConverter()

Returns:

The converter as specified in the constructor.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENTTYPE>

next

@Nullable
public ELEMENTTYPE next()

Specified by:

next in interface Iterator<ELEMENTTYPE>

remove

public void remove()

Specified by:

remove in interface Iterator<ELEMENTTYPE>

toString

public String toString()

Overrides:

toString in class Object