org.apache.commons.functor.generator
Class FilteredGenerator<E>

java.lang.Object
  org.apache.commons.functor.generator.BaseGenerator<E>
      org.apache.commons.functor.generator.FilteredGenerator<E>

All Implemented Interfaces:

Generator<E>

public class FilteredGenerator<E>
extends BaseGenerator<E>

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

Version:

$Revision: 1156795 $ $Date: 2011-08-11 22:08:30 +0200 (Thu, 11 Aug 2011) $

Constructor Summary

FilteredGenerator(Generator<? extends E> wrapped, UnaryPredicate<? super E> pred)
Create a new FilteredGenerator.

Method Summary

boolean	equals(Object obj)
protected Generator<? extends E>	getWrappedGenerator() Get the generator that is being wrapped.
int	hashCode()
void	run(UnaryProcedure<? super E> proc) Generators must implement this method.

Methods inherited from class org.apache.commons.functor.generator.BaseGenerator

isStopped, stop, to, to, toCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredGenerator

public FilteredGenerator(Generator<? extends E> wrapped,
                         UnaryPredicate<? super E> pred)

Create a new FilteredGenerator.

Parameters:

wrapped - Generator to wrap

pred - filtering UnaryPredicate

Method Detail

run

public void run(UnaryProcedure<? super E> proc)

Generators must implement this method.

Parameters:

proc - UnaryProcedure to run

getWrappedGenerator

protected Generator<? extends E> getWrappedGenerator()

Get the generator that is being wrapped.

Overrides:

getWrappedGenerator in class BaseGenerator<E>

Returns:

Generator

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object