Interface SingleSearchable<E>

Type Parameters:

E - is the type of the elements a SingleSearchable.

All Known Subinterfaces:

IArrayList<E>, IContainer<E>, ILinkedList<E>, IMatrix<E>, IMatrixColumn<E>, IMatrixRow<E>, ISqlRecord

All Known Implementing Classes:

AbstractContainer, AbstractExtendedContainer, ArrayContainerView, ArrayList, ContainerView, FilterContainerView, ImmutableList, IntervallContainerView, IterableContainerView, LinkedList, MappingContainerView, Matrix, MatrixColumn, MatrixRow, MultiContainerView, SingleContainer, SqlRecord

public interface SingleSearchable<E>

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
Optional<E>	getOptionalStoredFirst()
Optional<E>	getOptionalStoredFirst(Predicate<? super E> selector)
E	getStoredAtOneBasedIndex(int oneBasedIndex)
<C extends Comparable<C>> E	getStoredByMax(Function<E,C> comparableMapper)
<C extends Comparable<C>> E	getStoredByMin(Function<E,C> comparableMapper)
E	getStoredFirst()
E	getStoredFirst(Predicate<? super E> selector)
<T extends E> T	getStoredFirstOfType(Class<T> type)
E	getStoredLast()
E	getStoredOne()
E	getStoredOne(Predicate<? super E> selector)

Method Details

getOptionalStoredFirst

Optional<E> getOptionalStoredFirst()

Returns:

a Optional with the first element of the current SingleSearchable if the current SingleSearchable is not empty and if the first element of the current SingleSearchable is not null, an empty Optional otherwise.

getOptionalStoredFirst

Optional<E> getOptionalStoredFirst(Predicate<? super E> selector)

Parameters:

selector -

Returns:

a new Optional with the first element the given selector selects from the current SingleSearchable if the current SingleSearchable contains an element the given selector selects, an empty Optional otherwise. Ignores null elements.

Throws:

RuntimeException - if the given selector is null.

getStoredAtOneBasedIndex

E getStoredAtOneBasedIndex(int oneBasedIndex)

Parameters:

oneBasedIndex -

Returns:

the element at the given oneBasedIndex. The element can be null.

Throws:

RuntimeException - if the current SingleSearchable does not contain an element at the given oneBasedIndex.

getStoredByMax

<C extends Comparable<C>> E getStoredByMax(Function<E,C> comparableMapper)

Type Parameters:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current SingleSearchable.

Parameters:

comparableMapper -

Returns:

the element with the biggest Comparable the given comparableMapper maps from the elements of the current SingleSearchable. Ignores null elements.

Throws:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current SingleSearchable does not contain a non-null element.

getStoredByMin

<C extends Comparable<C>> E getStoredByMin(Function<E,C> comparableMapper)

Type Parameters:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current SingleSearchable.

Parameters:

comparableMapper -

Returns:

the element with the smallest Comparable the given comparableMapper maps from the elements of the current SingleSearchable. Ignores null elements.

Throws:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current SingleSearchable does not contain a non-null element.

getStoredFirst

E getStoredFirst()

Returns:

the first element of the current SingleSearchable. The element can be null.

Throws:

RuntimeException - if the current SingleSearchable is empty.

getStoredFirst

E getStoredFirst(Predicate<? super E> selector)

Parameters:

selector -

Returns:

the first element the given selector selects from the current SingleSearchable. Ignores null elements.

Throws:

RuntimeException - if the current SingleSearchable does not contain an element the given selector selects.

getStoredFirstOfType

<T extends E> T getStoredFirstOfType(Class<T> type)

Type Parameters:

T - is the given type.

Parameters:

type -

Returns:

the first element from the current SingleSearchable that is of the given type.

Throws:

RuntimeException - if the given type is null.

RuntimeException - if the current SingleSearchable does not contain an element of the given type.

getStoredLast

E getStoredLast()

Returns:

the last element of the current SingleSearchable. The element can be null.

Throws:

RuntimeException - if the current SingleSearchable is empty.

getStoredOne

E getStoredOne()

Returns:

the one element of the current SingleSearchable. The element can be null.

Throws:

RuntimeException - if the current SingleSearchable is empty.

RuntimeException - if the current SingleSearchable contains several elements.

getStoredOne

E getStoredOne(Predicate<? super E> selector)

Parameters:

selector -

Returns:

the one element the given selector selects from the current SingleSearchable. Ignores null elements.

Throws:

RuntimeException - if the given selector is null.

RuntimeException - if the given selector selects none or several elements from the current SingleSearchable.