Interface IterableFirstProvider<E>

Type Parameters:

E - the type of the elements a IterableFirstProvider

All Known Subinterfaces:

ExtendedIterable<E>, IAppendableList<E>, IArrayList<E>, ILinkedList<E>, IMatrix<E>, IMatrixColumn<E>, IMatrixRow<E>, ISqlRecord

All Known Implementing Classes:

AbstractExtendedIterable, ArrayExtendedIterableView, ArrayList, ExtendedIterableFilterView, ExtendedIterableIntervalView, ExtendedIterableMapperView, ExtendedIterableView, ImmutableList, IterableExtendedIterableView, LinkedList, Matrix, MatrixColumn, MatrixRow, MultiExtendedIterableView, SqlRecord

public interface IterableFirstProvider<E>

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
Optional<E>	getOptionalStoredFirst()	The time complexity of this method is O(1).
Optional<E>	getOptionalStoredFirst(Predicate<? super E> selector)	The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.
E	getStoredFirst()	The time complexity of this method is O(1).
E	getStoredFirst(Predicate<? super E> selector)	The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.
E	getStoredFirstNonNull()	The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.
<T extends E> T	getStoredFirstOfType(Class<T> type)	The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.

Method Details

getOptionalStoredFirst

Optional<E> getOptionalStoredFirst()

The time complexity of this method is O(1).

Returns:

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

getOptionalStoredFirst

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

The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.

Parameters:

selector - can select elements, is considered not to select any element when is null

Returns:

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

getStoredFirst

E getStoredFirst()

The time complexity of this method is O(1).

Returns:

the first element of the current IterableFirstProvider

Throws:

RuntimeException - if the current IterableFirstProvider is empty

getStoredFirst

E getStoredFirst(Predicate<? super E> selector)

The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.

Parameters:

selector - can select elements, is considered not to select any element when is null

Returns:

the first element the given selector selects from the current IterableFirstProvider, ignoring null elements

Throws:

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

getStoredFirstNonNull

E getStoredFirstNonNull()

The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.

Returns:

the first non-null element of the current IterableFirstProvider

Throws:

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

getStoredFirstOfType

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

The time complexity of this method is O(n) if the current IterableFirstProvider contains n elements.

Type Parameters:

T - the modeled type of the given type

Parameters:

type -

Returns:

the first element from the current IterableFirstProvider that is of the given type

Throws:

RuntimeException - if the given type is null

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