Package ch.nolix.coreapi.containerapi.baseapi

Schnittstelle ISearchableContainer<E>

Typparameter:

E - is the type of the elements a ISearchableContainer.

Alle bekannten Unterschnittstellen:

IArrayList<E>, ICachingContainer<E>, IContainer<E>, ILinkedList<E>, IMatrix<E>

Alle bekannten Implementierungsklassen:

ArrayList, ArrayReadContainer, CachingContainer, CompressedList, Container, GapMatrix, ImmutableList, IterableReadContainer, LinkedList, Matrix, MatrixColumn, MatrixRow, MultiReadContainer, ReadContainer

public interface ISearchableContainer<E>

Version:

2023-10-14

Autor:

Silvan Wyss

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Optional<E>	getOptionalStoredFirst()
Optional<E>	getOptionalStoredFirst(Predicate<? super E> selector)
E	getStoredAny()
E	getStoredAt1BasedIndex(int p1BasedIndex)
<C extends Comparable<C>> E	getStoredByMax(Function<E,C> norm)
<C extends Comparable<C>> E	getStoredByMin(Function<E,C> norm)
E	getStoredFirst()
E	getStoredFirst(Predicate<? super E> selector)
IContainer<? extends IContainer<E>>	getStoredGroups(Function<E,?> norm)
E	getStoredLast()
<E2 extends E> IContainer<E2>	getStoredOfType(Class<E2> type)
E	getStoredOne()
E	getStoredOne(Predicate<? super E> selector)
IContainer<E>	getStoredOther(Predicate<E> selector)
IContainer<E>	getStoredSelected(Predicate<? super E> selector)

Methodendetails

getOptionalStoredFirst

Optional<E> getOptionalStoredFirst()

Gibt zurück:

a Optional with the first element of the current ISearchableContainer if the current ISearchableContainer contains any, an empty Optional otherwise.

getOptionalStoredFirst

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

Parameter:

selector -

Gibt zurück:

a new Optional with the first element the given selector selects from the current ISearchableContainer if the current ISearchableContainer contains an element the given selector selects, an empty Optional otherwise.

Löst aus:

RuntimeException - if the given selector is null.

getStoredAny

E getStoredAny()

Gibt zurück:

a randomly selected element of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

getStoredAt1BasedIndex

E getStoredAt1BasedIndex(int p1BasedIndex)

Parameter:

p1BasedIndex -

Gibt zurück:

the element at the given p1BasedIndex.

Löst aus:

RuntimeException - if the current ISearchableContainer does not contain an element at the given p1BasedIndex.

getStoredByMax

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

Typparameter:

C - is the type of the Comparables the given norm returns.

Parameter:

norm -

Gibt zurück:

the element with the biggest Comparable the given norm returns from the elements of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

getStoredByMin

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

Typparameter:

C - is the type of the Comparables the given norm returns.

Parameter:

norm -

Gibt zurück:

the element with the smallest Comparable the given norm returns from the elements of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

getStoredFirst

E getStoredFirst()

Gibt zurück:

the first element of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

getStoredFirst

E getStoredFirst(Predicate<? super E> selector)

Parameter:

selector -

Gibt zurück:

the first element the given selector selects from the current ISearchableContainer.

Löst aus:

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

getStoredGroups

IContainer<? extends IContainer<E>> getStoredGroups(Function<E,?> norm)

Parameter:

norm -

Gibt zurück:

a new ISearchableContainer with groups with the elements of the current ISearchableContainer grouped by the given norm.

getStoredLast

E getStoredLast()

Gibt zurück:

the last element of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

getStoredOfType

<E2 extends E> IContainer<E2> getStoredOfType(Class<E2> type)

Typparameter:

E2 - is the type of the elements of the returned ISearchableContainer.

Parameter:

type -

Gibt zurück:

a new ISearchableContainer with the elements from the current ISearchableContainer that are of the given type.

getStoredOne

E getStoredOne()

Gibt zurück:

the one element of the current ISearchableContainer.

Löst aus:

RuntimeException - if the current ISearchableContainer is empty.

RuntimeException - if the current ISearchableContainer contains several elements.

getStoredOne

E getStoredOne(Predicate<? super E> selector)

Parameter:

selector -

Gibt zurück:

the one element the given selector selects from the current ISearchableContainer.

Löst aus:

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

getStoredOther

IContainer<E> getStoredOther(Predicate<E> selector)

Parameter:

selector -

Gibt zurück:

a new ISearchableContainer with the elements from the current ISearchableContainer the given selector skips (!).

getStoredSelected

IContainer<E> getStoredSelected(Predicate<? super E> selector)

Parameter:

selector -

Gibt zurück:

a new ISearchableContainer with the elements the given selector selects from the current ISearchableContainer.