Package uk.gov.gchq.koryphe.impl.function

Class IterableFilter<I_ITEM>

java.lang.Object

uk.gov.gchq.koryphe.function.KorypheFunction<Iterable<I_ITEM>,Iterable<I_ITEM>>

uk.gov.gchq.koryphe.impl.function.IterableFilter<I_ITEM>

All Implemented Interfaces:

Function<Iterable<I_ITEM>,Iterable<I_ITEM>>

public class IterableFilter<I_ITEM>
extends KorypheFunction<Iterable<I_ITEM>,Iterable<I_ITEM>>

A IterableFilter is a Function that filters items from an Iterable based on a Predicate. If the predicate returns false then an item is not valid and is removed.

Constructor Summary

Constructors

Constructor	Description
IterableFilter()
IterableFilter(Predicate predicate)

Method Summary

Modifier and Type	Method	Description
Iterable<I_ITEM>	apply(Iterable<I_ITEM> items)
boolean	equals(Object o)
Predicate<I_ITEM>	getPredicate()
int	hashCode()
IterableFilter<I_ITEM>	predicate(Predicate predicate)
IterableFilter<I_ITEM>	setPredicate(Predicate<I_ITEM> predicate)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

IterableFilter

public IterableFilter()

IterableFilter

public IterableFilter(Predicate predicate)

Method Detail

apply

public Iterable<I_ITEM> apply(Iterable<I_ITEM> items)

getPredicate

public Predicate<I_ITEM> getPredicate()

predicate

public IterableFilter<I_ITEM> predicate(Predicate predicate)

setPredicate

public IterableFilter<I_ITEM> setPredicate(Predicate<I_ITEM> predicate)

equals

public boolean equals(Object o)

Overrides:

equals in class KorypheFunction<Iterable<I_ITEM>,Iterable<I_ITEM>>

hashCode

public int hashCode()

Overrides:

hashCode in class KorypheFunction<Iterable<I_ITEM>,Iterable<I_ITEM>>