com.helger.commons.collection.iterate

Class ConvertIterator<SRCTYPE,ELEMENTTYPE>

java.lang.Object

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

Type Parameters:

SRCTYPE - The type of the source iterator

ELEMENTTYPE - The type of this iterator

All Implemented Interfaces:

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

public class ConvertIterator<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
ConvertIterator(IIterableIterator<? extends SRCTYPE> aBaseIter, IConverter<SRCTYPE,ELEMENTTYPE> aConverter) Constructor.
ConvertIterator(Iterable<? extends SRCTYPE> aBaseCont, IConverter<SRCTYPE,ELEMENTTYPE> aConverter) Constructor.
ConvertIterator(Iterator<? extends SRCTYPE> aBaseIter, IConverter<SRCTYPE,ELEMENTTYPE> aConverter) Constructor.

Method Summary

Modifier and Type	Method and Description
IConverter<SRCTYPE,ELEMENTTYPE>	getConverter()
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

ConvertIterator

public ConvertIterator(@Nonnull
                       IIterableIterator<? extends SRCTYPE> aBaseIter,
                       @Nonnull
                       IConverter<SRCTYPE,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.

ConvertIterator

public ConvertIterator(@Nonnull
                       Iterable<? extends SRCTYPE> aBaseCont,
                       @Nonnull
                       IConverter<SRCTYPE,ELEMENTTYPE> aConverter)

Constructor.

Parameters:

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

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

ConvertIterator

public ConvertIterator(@Nonnull
                       Iterator<? extends SRCTYPE> aBaseIter,
                       @Nonnull
                       IConverter<SRCTYPE,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 IConverter<SRCTYPE,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()

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

@UnsupportedOperation
public void remove()

Specified by:

remove in interface Iterator<ELEMENTTYPE>

iterator

@Nonnull
public Iterator<ELEMENTTYPE> iterator()

Specified by:

iterator in interface Iterable<ELEMENTTYPE>

toString

public String toString()

Overrides:

toString in class Object