net.emaze.dysfunctional

Class Searches

java.lang.Object

net.emaze.dysfunctional.Searches

public abstract class Searches
extends Object

Author:

rferranti, fdegrassi

Constructor Summary

Constructors

Constructor and Description
Searches()

Method Summary

Modifier and Type	Method and Description
static <C extends Collection<E>,E> C	find(E[] array, C collection, Predicate<E> predicate) Searches the array, adding every value matching the predicate to the passed collection.
static <E> List<E>	find(E[] array, Predicate<E> predicate) Searches the array, yielding every value matching the predicate.
static <C extends Collection<E>,E> C	find(E[] array, Supplier<C> supplier, Predicate<E> predicate) Searches the array, adding every value matching the predicate to the collection yielded by the passed supplier.
static <C extends Collection<E>,E> C	find(Iterable<E> iterable, C collection, Predicate<E> predicate) Searches the iterable, adding every value matching the predicate to the passed collection.
static <E> List<E>	find(Iterable<E> iterable, Predicate<E> predicate) Searches the iterable, yielding every value matching the predicate.
static <C extends Collection<E>,E> C	find(Iterable<E> iterable, Supplier<C> supplier, Predicate<E> predicate) Searches the iterable, adding every value matching the predicate to the collection yielded by the passed supplier.
static <C extends Collection<E>,E> C	find(Iterator<E> iterator, C collection, Predicate<E> predicate) Searches the iterator, consuming it, adding every value matching the predicate to the passed collection.
static <E> List<E>	find(Iterator<E> iterator, Predicate<E> predicate) Searches the iterator, consuming it, yielding every value matching the predicate.
static <C extends Collection<E>,E> C	find(Iterator<E> iterator, Supplier<C> supplier, Predicate<E> predicate) Searches the iterator, consuming it, adding every value matching the predicate to the collection yielded by the passed supplier.
static <E> E	findFirst(E[] array, Predicate<E> predicate) Searches the first matching element returning it.
static <E> E	findFirst(Iterable<E> iterable, Predicate<E> predicate) Searches the first matching element returning it.
static <E> E	findFirst(Iterator<E> iterator, Predicate<E> predicate) Searches the first matching element returning it.
static <E> E	findLast(E[] array, Predicate<E> predicate) Searches the last matching element returning it.
static <E> E	findLast(Iterable<E> iterable, Predicate<E> predicate) Searches the last matching element returning it.
static <E> E	findLast(Iterator<E> iterator, Predicate<E> predicate) Searches the last matching element returning it.
static <E> E	findOne(E[] array, Predicate<E> predicate) Searches the only matching element returning it.
static <E> E	findOne(Iterable<E> iterable, Predicate<E> predicate) Searches the only matching element returning it.
static <E> E	findOne(Iterator<E> iterator, Predicate<E> predicate) Searches the only matching element returning it.
static <C extends Collection<E>,E> C	search(E[] array, C collection, Predicate<E> predicate) Searches the array, adding every value matching the predicate to the passed collection.
static <E> List<E>	search(E[] array, Predicate<E> predicate) Searches the array, adding every value matching the predicate to the passed collection.
static <C extends Collection<E>,E> C	search(E[] array, Supplier<C> supplier, Predicate<E> predicate) Searches the array, adding every value matching the predicate to the collection yielded by the passed supplier.
static <C extends Collection<E>,E> C	search(Iterable<E> iterable, C collection, Predicate<E> predicate) Searches the iterable, adding every value matching the predicate to the passed collection.
static <E> List<E>	search(Iterable<E> iterable, Predicate<E> predicate) Searches the iterable, yielding every value matching the predicate.
static <C extends Collection<E>,E> C	search(Iterable<E> iterable, Supplier<C> supplier, Predicate<E> predicate) Searches the iterable, adding every value matching the predicate to the collection yielded by the passed supplier.
static <C extends Collection<E>,E> C	search(Iterator<E> iterator, C collection, Predicate<E> predicate) Searches the iterator, consuming it, adding every value matching the predicate to the passed collection.
static <E> List<E>	search(Iterator<E> iterator, Predicate<E> predicate) Searches the iterator, consuming it, yielding every value matching the predicate.
static <C extends Collection<E>,E> C	search(Iterator<E> iterator, Supplier<C> supplier, Predicate<E> predicate) Searches the iterator, consuming it, adding every value matching the predicate to the collection yielded by the passed supplier.
static <E> Optional<E>	searchFirst(E[] array, Predicate<E> predicate) Searches the first matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchFirst(Iterable<E> iterable, Predicate<E> predicate) Searches the first matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchFirst(Iterator<E> iterator, Predicate<E> predicate) Searches the first matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchLast(E[] array, Predicate<E> predicate) Searches the last matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchLast(Iterable<E> iterable, Predicate<E> predicate) Searches the last matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchLast(Iterator<E> iterator, Predicate<E> predicate) Searches the last matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchOne(E[] array, Predicate<E> predicate) Searches the only matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchOne(Iterable<E> iterable, Predicate<E> predicate) Searches the only matching element returning just element if found, nothing otherwise.
static <E> Optional<E>	searchOne(Iterator<E> iterator, Predicate<E> predicate) Searches the only matching element returning just element if found, nothing otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

Searches

public Searches()

Method Detail

search

public static <E> List<E> search(Iterator<E> iterator,
                                 Predicate<E> predicate)

Searches the iterator, consuming it, yielding every value matching the predicate.

Type Parameters:

E - the element type

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

search

public static <C extends Collection<E>,E> C search(Iterator<E> iterator,
                                                   C collection,
                                                   Predicate<E> predicate)

Searches the iterator, consuming it, adding every value matching the predicate to the passed collection.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterator - the iterator to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

search

public static <C extends Collection<E>,E> C search(Iterator<E> iterator,
                                                   Supplier<C> supplier,
                                                   Predicate<E> predicate)

Searches the iterator, consuming it, adding every value matching the predicate to the collection yielded by the passed supplier.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterator - the iterator to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

search

public static <E> List<E> search(Iterable<E> iterable,
                                 Predicate<E> predicate)

Searches the iterable, yielding every value matching the predicate.

Type Parameters:

E - the element type

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

search

public static <C extends Collection<E>,E> C search(Iterable<E> iterable,
                                                   C collection,
                                                   Predicate<E> predicate)

Searches the iterable, adding every value matching the predicate to the passed collection.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterable - the iterable to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

search

public static <C extends Collection<E>,E> C search(Iterable<E> iterable,
                                                   Supplier<C> supplier,
                                                   Predicate<E> predicate)

Searches the iterable, adding every value matching the predicate to the collection yielded by the passed supplier.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterable - the iterable to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

search

public static <E> List<E> search(E[] array,
                                 Predicate<E> predicate)

Searches the array, adding every value matching the predicate to the passed collection.

Type Parameters:

E - the element type

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

search

public static <C extends Collection<E>,E> C search(E[] array,
                                                   C collection,
                                                   Predicate<E> predicate)

Searches the array, adding every value matching the predicate to the passed collection.

Type Parameters:

C - the collection type

E - the element type

Parameters:

array - the array to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

search

public static <C extends Collection<E>,E> C search(E[] array,
                                                   Supplier<C> supplier,
                                                   Predicate<E> predicate)

Searches the array, adding every value matching the predicate to the collection yielded by the passed supplier.

Type Parameters:

C - the collection type

E - the element type

Parameters:

array - the array to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

find

public static <E> List<E> find(Iterator<E> iterator,
                               Predicate<E> predicate)

Searches the iterator, consuming it, yielding every value matching the predicate. An IllegalStateException is thrown if no element matches.

Type Parameters:

E - the element type

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(Iterator<E> iterator,
                                                 C collection,
                                                 Predicate<E> predicate)

Searches the iterator, consuming it, adding every value matching the predicate to the passed collection. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterator - the iterator to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(Iterator<E> iterator,
                                                 Supplier<C> supplier,
                                                 Predicate<E> predicate)

Searches the iterator, consuming it, adding every value matching the predicate to the collection yielded by the passed supplier. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterator - the iterator to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <E> List<E> find(Iterable<E> iterable,
                               Predicate<E> predicate)

Searches the iterable, yielding every value matching the predicate. An IllegalStateException is thrown if no element matches.

Type Parameters:

E - the element type

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(Iterable<E> iterable,
                                                 C collection,
                                                 Predicate<E> predicate)

Searches the iterable, adding every value matching the predicate to the passed collection. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterable - the iterable to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(Iterable<E> iterable,
                                                 Supplier<C> supplier,
                                                 Predicate<E> predicate)

Searches the iterable, adding every value matching the predicate to the collection yielded by the passed supplier. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

iterable - the iterable to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <E> List<E> find(E[] array,
                               Predicate<E> predicate)

Searches the array, yielding every value matching the predicate. An IllegalStateException is thrown if no element matches.

Type Parameters:

E - the element type

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

a list containing matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(E[] array,
                                                 C collection,
                                                 Predicate<E> predicate)

Searches the array, adding every value matching the predicate to the passed collection. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

array - the array to be searched

collection - the collection to be filled with matching elements

predicate - the predicate to be applied to each element

Returns:

the passed collection, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

find

public static <C extends Collection<E>,E> C find(E[] array,
                                                 Supplier<C> supplier,
                                                 Predicate<E> predicate)

Searches the array, adding every value matching the predicate to the collection yielded by the passed supplier. An IllegalStateException is thrown if no element matches.

Type Parameters:

C - the collection type

E - the element type

Parameters:

array - the array to be searched

supplier - the supplier of the resulting collection

predicate - the predicate to be applied to each element

Returns:

the collection provided by the passed supplier, filled with matching elements

Throws:

IllegalArgumentException - if no element matches

searchFirst

public static <E> Optional<E> searchFirst(E[] array,
                                          Predicate<E> predicate)

Searches the first matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

searchFirst

public static <E> Optional<E> searchFirst(Iterator<E> iterator,
                                          Predicate<E> predicate)

Searches the first matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

searchFirst

public static <E> Optional<E> searchFirst(Iterable<E> iterable,
                                          Predicate<E> predicate)

Searches the first matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

findFirst

public static <E> E findFirst(Iterator<E> iterator,
                              Predicate<E> predicate)

Searches the first matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalArgumentException - if no element matches

findFirst

public static <E> E findFirst(Iterable<E> iterable,
                              Predicate<E> predicate)

Searches the first matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalArgumentException - if no element matches

findFirst

public static <E> E findFirst(E[] array,
                              Predicate<E> predicate)

Searches the first matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalArgumentException - if no element matches

searchOne

public static <E> Optional<E> searchOne(Iterator<E> iterator,
                                        Predicate<E> predicate)

Searches the only matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

Throws:

IllegalStateException - if more than one element is found

searchOne

public static <E> Optional<E> searchOne(Iterable<E> iterable,
                                        Predicate<E> predicate)

Searches the only matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

Throws:

IllegalStateException - if more than one element is found

searchOne

public static <E> Optional<E> searchOne(E[] array,
                                        Predicate<E> predicate)

Searches the only matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

just the element found or nothing

Throws:

IllegalStateException - if more than one element is found

findOne

public static <E> E findOne(Iterator<E> iterator,
                            Predicate<E> predicate)

Searches the only matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalStateException - if more than one element is found

IllegalArgumentException - if no element matches

findOne

public static <E> E findOne(Iterable<E> iterable,
                            Predicate<E> predicate)

Searches the only matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalStateException - if more than one element is found

IllegalArgumentException - if no element matches

findOne

public static <E> E findOne(E[] array,
                            Predicate<E> predicate)

Searches the only matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

the found element

Throws:

IllegalStateException - if more than one element is found

IllegalArgumentException - if no element matches

searchLast

public static <E> Optional<E> searchLast(Iterator<E> iterator,
                                         Predicate<E> predicate)

Searches the last matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

just the last element found or nothing

searchLast

public static <E> Optional<E> searchLast(Iterable<E> iterable,
                                         Predicate<E> predicate)

Searches the last matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

just the last element found or nothing

searchLast

public static <E> Optional<E> searchLast(E[] array,
                                         Predicate<E> predicate)

Searches the last matching element returning just element if found, nothing otherwise.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

just the last element found or nothing

findLast

public static <E> E findLast(Iterator<E> iterator,
                             Predicate<E> predicate)

Searches the last matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterator - the iterator to be searched

predicate - the predicate to be applied to each element

Returns:

the last element found

Throws:

IllegalArgumentException - if no element matches

findLast

public static <E> E findLast(Iterable<E> iterable,
                             Predicate<E> predicate)

Searches the last matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

iterable - the iterable to be searched

predicate - the predicate to be applied to each element

Returns:

the last element found

Throws:

IllegalArgumentException - if no element matches

findLast

public static <E> E findLast(E[] array,
                             Predicate<E> predicate)

Searches the last matching element returning it.

Type Parameters:

E - the element type parameter

Parameters:

array - the array to be searched

predicate - the predicate to be applied to each element

Returns:

the last element found

Throws:

IllegalArgumentException - if no element matches