com.helger.commons.collection.iterate

Class FilterIterator<ELEMENTTYPE>

java.lang.Object

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

Type Parameters:

ELEMENTTYPE - The type to iterate

All Implemented Interfaces:

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

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

A simple filter iterator that takes a base iterator and an additional filter and returns only the items that match the filter.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FilterIterator(IIterableIterator<? extends ELEMENTTYPE> aBaseIter, Predicate<? super ELEMENTTYPE> aFilter) Constructor.
FilterIterator(Iterable<? extends ELEMENTTYPE> aBaseCont, Predicate<? super ELEMENTTYPE> aFilter) Constructor.
FilterIterator(Iterator<? extends ELEMENTTYPE> aBaseIter, Predicate<? super ELEMENTTYPE> aFilter) Constructor.

Method Summary

Modifier and Type	Method and Description
Predicate<? super ELEMENTTYPE>	getFilter()
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, forEachBreakable, forEachByIndex, forEachThrowing, getCount, getCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

FilterIterator

public FilterIterator(@Nonnull
                      IIterableIterator<? extends ELEMENTTYPE> aBaseIter,
                      @Nonnull
                      Predicate<? super ELEMENTTYPE> aFilter)

Constructor.

Parameters:

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

aFilter - The filter to be applied. May not be null.

FilterIterator

public FilterIterator(@Nonnull
                      Iterator<? extends ELEMENTTYPE> aBaseIter,
                      @Nonnull
                      Predicate<? super ELEMENTTYPE> aFilter)

Constructor.

Parameters:

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

aFilter - The filter to be applied. May not be null.

FilterIterator

public FilterIterator(@Nonnull
                      Iterable<? extends ELEMENTTYPE> aBaseCont,
                      @Nonnull
                      Predicate<? super ELEMENTTYPE> aFilter)

Constructor.

Parameters:

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

aFilter - The filter to be applied. May not be null.

Method Detail

getFilter

@Nonnull
public Predicate<? super ELEMENTTYPE> getFilter()

Returns:

The filter 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