de.team33.patterns.serial.charon

Class Series<E>

java.lang.Object

de.team33.patterns.serial.charon.Series<E>

Type Parameters:

E - The element type.

public abstract class Series<E>
extends Object

Abstracts a series of elements of a certain type and as such represents an alternative view of a Collection.

In this view, a series essentially consists of two components:

• The first element ("head", an element that may be missing)
• The rest of the sequence ("tail", again a sequence)

If the first component ("head") is missing, the sequence is empty. Then the rest of the sequence ("tail") is also empty.

A sequence according to this definition is immutable and cannot contain null elements. In addition to the components mentioned above, it has a certain size (number of items contained), can be streamed and presented as a "normal" List.

Constructor Summary

Constructors

Constructor and Description
Series()

Method Summary

Modifier and Type	Method and Description
abstract List<E>	asList() Returns an immutable List representation of this series.
static <E> Series<E>	empty() Returns an empty Series.
boolean	equals(Object obj)
int	hashCode()
abstract E	head() Returns this series' head element if this is charged.
<R> Optional<R>	ifCharged(BiFunction<E,Series<E>,R> function) Executes a given function with this series' head and tail as arguments if this is charged.
boolean	isCharged() Returns true if this contains at least one element, false otherwise.
boolean	isEmpty() Returns true if this does not contain any element, false otherwise.
static <E> Series<E>	of(Collection<? extends E> origin) Returns a Series composed of the given Collection's elements in the given order.
static <E> Series<E>	of(E... elements) Returns a Series composed of the given elements in the given order.
static <E> Series<E>	of(Iterable<? extends E> origin) Returns a Series composed of the given Iterable's elements in the given order.
static <E> Series<E>	of(Streamable<? extends E> origin) Returns a Series composed of the given Streamable's elements in the given order.
abstract int	size() Returns the number of elements within this series.
Stream<E>	stream() Returns a sequential Stream with this Series as its source.
abstract Series<E>	tail() Returns the remaining subseries that follows this series' head element.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Series

public Series()

Method Detail

empty

public static <E> Series<E> empty()

Returns an empty Series.

of

@SafeVarargs
public static <E> Series<E> of(E... elements)

Returns a Series composed of the given elements in the given order.

of

public static <E> Series<E> of(Streamable<? extends E> origin)

Returns a Series composed of the given Streamable's elements in the given order.

of

public static <E> Series<E> of(Iterable<? extends E> origin)

Returns a Series composed of the given Iterable's elements in the given order.

of

public static <E> Series<E> of(Collection<? extends E> origin)

Returns a Series composed of the given Collection's elements in the given order.

isEmpty

public final boolean isEmpty()

Returns true if this does not contain any element, false otherwise.

See Also:

isCharged()

isCharged

public final boolean isCharged()

Returns true if this contains at least one element, false otherwise.

See Also:

isEmpty()

ifCharged

public final <R> Optional<R> ifCharged(BiFunction<E,Series<E>,R> function)

Executes a given function with this series' head and tail as arguments if this is charged.

Type Parameters:

R - The result type.

Returns:

• An Optional describing the result of the function call if this is charged.
• Optional.empty() if the result of the function call is null.
• Optional.empty() if this is empty.

See Also:

isCharged()

head

public abstract E head()

Returns this series' head element if this is charged.

Throws:

NoSuchElementException - if this is empty.

tail

public abstract Series<E> tail()

Returns the remaining subseries that follows this series' head element.

size

public abstract int size()

Returns the number of elements within this series.

asList

public abstract List<E> asList()

Returns an immutable List representation of this series.

stream

public final Stream<E> stream()

Returns a sequential Stream with this Series as its source.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object