net.markenwerk.commons.collections.sources

Class AbstractSource<Payload>

java.lang.Object

net.markenwerk.commons.collections.sources.AbstractSource<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, Source<Payload>, ProtectedIterable<Payload>

Direct Known Subclasses:

AbstractIndexedSource, AbstractStack, CollectionSource, EmptySource, MapKeySource, MapValueSource, ObjectSource, OptionalSource

public abstract class AbstractSource<Payload>
extends Object
implements Source<Payload>

An AbstractSource is an abstract base implementation of a Source.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractSource()

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object reference) Returns whether this Source contains, by equality, the given reference payload value.
boolean	containsAll(Iterable<?> references) Returns whether this Source contains, by equality, all of the given reference payload values.
boolean	containsAll(Object... references) Returns whether this Source contains, by equality, all of the given reference payload values.
boolean	containsMatch(Predicate<? super Payload> predicate) Returns whether this Source contains a payload value that satisfies the given Predicate.
protected Predicate<Payload>	createPredicate(Payload payload) Creates and returns a Predicate that is satisfied, if the test subject is equal to the given payload value.
protected Payload	doGetFirst() Returns the first (i.e.
protected static <Payload> Optional<Integer>	firstIndexOf(Iterator<? extends Payload> iterator, Predicate<? super Payload> predicate) Returns the index of the first payload value that satisfies the give Predicate.
Source<Payload>	getAll(Payload payload) Returns all occurrences, by equality, of the given reference payload value.
Source<Payload>	getAllMatches(Predicate<? super Payload> predicate) Returns the payload values that satisfy the given Predicate.
Payload	getFirst() Returns the first (i.e.
Optional<Payload>	getFirst(Payload reference) Returns the first (i.e.
Optional<Payload>	getFirstMatch(Predicate<? super Payload> predicate) Returns the first (i.e.
boolean	isEmpty() Returns whether this Source is empty.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.markenwerk.commons.collections.sources.Source

size

Methods inherited from interface net.markenwerk.commons.iterables.ProtectedIterable

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractSource

public AbstractSource()

Method Detail

isEmpty

public final boolean isEmpty()

Description copied from interface: Source

Returns whether this Source is empty.

Specified by:

isEmpty in interface Source<Payload>

Returns:

Whether this Source is empty.

getFirst

public final Payload getFirst()
                       throws NoSuchElementException

Description copied from interface: Source

Returns the first (i.e. first payload value in an iterator) payload value.

Specified by:

getFirst in interface Source<Payload>

Returns:

The payload value.

Throws:

NoSuchElementException - If this IndexedSource is empty.

doGetFirst

protected Payload doGetFirst()

Returns the first (i.e. first payload value in an iterator) payload value, which is guaranteed to exist.

Returns:

The payload value.

getFirst

public final Optional<Payload> getFirst(Payload reference)

Description copied from interface: Source

Returns the first (i.e. first occurrence in an iterator of this Source) occurrences, by equality, of the given reference payload value.

Specified by:

getFirst in interface Source<Payload>

Parameters:

reference - The reference payload to be used.

Returns:

An Optional yielding the payload value.

getFirstMatch

public final Optional<Payload> getFirstMatch(Predicate<? super Payload> predicate)
                                      throws IllegalArgumentException

Description copied from interface: Source

Returns the first (i.e. first occurrence in an iterator of this Source) payload value that satisfies the given Predicate.

Specified by:

getFirstMatch in interface Source<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

An Optional yielding the payload value.

Throws:

IllegalArgumentException - If the given Predicate is null.

getAll

public final Source<Payload> getAll(Payload payload)

Description copied from interface: Source

Returns all occurrences, by equality, of the given reference payload value.

Specified by:

getAll in interface Source<Payload>

Parameters:

payload - The reference payload to be used.

Returns:

A Source yielding the payload values.

getAllMatches

public final Source<Payload> getAllMatches(Predicate<? super Payload> predicate)
                                    throws IllegalArgumentException

Description copied from interface: Source

Returns the payload values that satisfy the given Predicate.

Specified by:

getAllMatches in interface Source<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

A Source yielding the payload values.

Throws:

IllegalArgumentException - If the given Predicate is null.

contains

public final boolean contains(Object reference)

Description copied from interface: Source

Returns whether this Source contains, by equality, the given reference payload value.

Specified by:

contains in interface Source<Payload>

Parameters:

reference - The reference payload value to be checked.

Returns:

Whether this Source contains the given reference payload value.

containsMatch

public final boolean containsMatch(Predicate<? super Payload> predicate)
                            throws IllegalArgumentException

Description copied from interface: Source

Returns whether this Source contains a payload value that satisfies the given Predicate.

Specified by:

containsMatch in interface Source<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

Whether this Source contains a payload value that satisfies the given Predicate.

Throws:

IllegalArgumentException - if the given Predicate is null.

containsAll

public final boolean containsAll(Object... references)
                          throws IllegalArgumentException

Description copied from interface: Source

Returns whether this Source contains, by equality, all of the given reference payload values.

Specified by:

containsAll in interface Source<Payload>

Parameters:

references - The array of reference payload values to be checked.

Returns:

Whether this Source contains all of the given payload values.

Throws:

IllegalArgumentException - If the given array of reference payload values is null.

containsAll

public final boolean containsAll(Iterable<?> references)

Description copied from interface: Source

Returns whether this Source contains, by equality, all of the given reference payload values.

Specified by:

containsAll in interface Source<Payload>

Parameters:

references - The Iterable of reference payload values to be checked.

Returns:

Whether this Source contains all of the given payload values.

toString

public final String toString()

Overrides:

toString in class Object

createPredicate

protected final Predicate<Payload> createPredicate(Payload payload)

Creates and returns a Predicate that is satisfied, if the test subject is equal to the given payload value.

Parameters:

payload - The payload value to be used.

Returns:

The Predicate.

firstIndexOf

protected static <Payload> Optional<Integer> firstIndexOf(Iterator<? extends Payload> iterator,
                                                          Predicate<? super Payload> predicate)

Returns the index of the first payload value that satisfies the give Predicate.

Parameters:

iterator - The Iterator to be used, which must not be null.

predicate - The Predicate to be used, which must not be null.

Returns:

The index of the first payload value that satisfies the give -1, if no such payload value exists.