com.helger.commons.filter.collections

Class FilterIterator<ELEMENTTYPE>

java.lang.Object

com.helger.commons.filter.collections.FilterIterator<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type to iterate

All Implemented Interfaces:

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

public final 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, IFilter<ELEMENTTYPE> aFilter) Constructor.
FilterIterator(Iterable<? extends ELEMENTTYPE> aBaseCont, IFilter<ELEMENTTYPE> aFilter) Constructor.
FilterIterator(Iterator<? extends ELEMENTTYPE> aBaseIter, IFilter<ELEMENTTYPE> aFilter) Constructor.

Method Summary

Modifier and Type	Method and Description
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

FilterIterator

public FilterIterator(@Nonnull
                      IIterableIterator<? extends ELEMENTTYPE> aBaseIter,
                      @Nonnull
                      IFilter<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
                      IFilter<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
                      IFilter<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

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENTTYPE>

next

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