org.apache.commons.functor.core.collection
Class FilteredIterator<T>

java.lang.Object
  org.apache.commons.functor.core.collection.FilteredIterator<T>

All Implemented Interfaces:

java.util.Iterator<T>

public final class FilteredIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

Iterator that filters another Iterator by only passing through those elements that are matched by a specified UnaryPredicate.

Version:

$Revision: 666345 $ $Date: 2008-06-10 17:13:44 -0500 (Tue, 10 Jun 2008) $

Author:

Rodney Waldhoff

Constructor Summary

FilteredIterator(java.util.Iterator<? extends T> iterator, UnaryPredicate<? super T> predicate)
Create a new FilteredIterator.

Method Summary

boolean	equals(java.lang.Object obj)
static <T> java.util.Iterator<T>	filter(java.util.Iterator<? extends T> iter, UnaryPredicate<? super T> pred) Get a filtered Iterator instance applying pred to iter.
int	hashCode()
boolean	hasNext()
T	next()
void	remove()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilteredIterator

public FilteredIterator(java.util.Iterator<? extends T> iterator,
                        UnaryPredicate<? super T> predicate)

Create a new FilteredIterator.

Parameters:

iterator - to filter

predicate - to apply

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

See Also:

Iterator.hasNext()

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

See Also:

Iterator.next()

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<T>

See Also:

Iterator.remove()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

filter

public static <T> java.util.Iterator<T> filter(java.util.Iterator<? extends T> iter,
                                               UnaryPredicate<? super T> pred)

Get a filtered Iterator instance applying pred to iter.

Parameters:

iter - to filter

pred - to apply

Returns:

Iterator