org.openimaj.util.filter

Class FilterUtils

java.lang.Object

org.openimaj.util.filter.FilterUtils

public class FilterUtils
extends Object

Utilities for filtering collections by applying a Predicate.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
static <T> Collection<T>	filter(Collection<? extends T> in, Collection<T> out, Predicate<T> filter) Filter a collection, storing the accepted items in the given output collection.
static <T,Q extends T> ArrayList<Q>	filter(Collection<Q> in, Predicate<T> filter) Filter a collection, returning the accepted items in an ArrayList .
static <T> Iterator<T>	filteredIterator(Iterable<? extends T> iterable, Predicate<T> filter) Create an iterator that filters items from the given Iterable.
static <T> Iterator<T>	filteredIterator(Iterator<? extends T> iterator, Predicate<T> filter) Create an iterator that filters items from the given Iterator.
static <T> Iterator<T>	filteredIterator(T[] array, Predicate<T> filter) Create an iterator that filters items from the given array.

Methods inherited from class java.lang.Object

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

Method Detail

filter

public static <T,Q extends T> ArrayList<Q> filter(Collection<Q> in,
                                                  Predicate<T> filter)

Filter a collection, returning the accepted items in an ArrayList .

Type Parameters:

T - type of object being filtered

Q - type of object accepted by the filter

Parameters:

in - input collection

filter - the filter

Returns:

the list of accepted items

See Also:

Predicate.test(Object)

filter

public static <T> Collection<T> filter(Collection<? extends T> in,
                                       Collection<T> out,
                                       Predicate<T> filter)

Filter a collection, storing the accepted items in the given output collection.

Type Parameters:

T - type of object being filtered

Parameters:

in - input collection

out - output collection

filter - the filter

Returns:

the list of accepted items

See Also:

Predicate.test(Object)

filteredIterator

public static <T> Iterator<T> filteredIterator(Iterable<? extends T> iterable,
                                               Predicate<T> filter)

Create an iterator that filters items from the given Iterable.

Type Parameters:

T - type of object being filtered

Parameters:

iterable - Iterable to filter

filter - the filter

Returns:

the list of accepted items

See Also:

Predicate.test(Object)

filteredIterator

public static <T> Iterator<T> filteredIterator(Iterator<? extends T> iterator,
                                               Predicate<T> filter)

Create an iterator that filters items from the given Iterator.

Type Parameters:

T - type of object being filtered

Parameters:

iterator - Iterator to filter

filter - the filter

Returns:

the list of accepted items

See Also:

Predicate.test(Object)

filteredIterator

public static <T> Iterator<T> filteredIterator(T[] array,
                                               Predicate<T> filter)

Create an iterator that filters items from the given array.

Type Parameters:

T - type of object being filtered

Parameters:

array - to filter

filter - the filter

Returns:

the list of accepted items

See Also:

Predicate.test(Object)