eu.hanskruse.noaber.tuples

Interface Tuple

All Known Implementing Classes:

BaseTuple, Tuple0, Tuple1, Tuple10, Tuple11, Tuple12, Tuple13, Tuple14, Tuple15, Tuple16, Tuple2, Tuple3, Tuple4, Tuple5, Tuple6, Tuple7, Tuple8, Tuple9

public interface Tuple

Tuple is a generic readonly container for multiple fields of possible different types.

Method Summary

Modifier and Type	Method and Description
default <T> Iterable<T>	asIterable() Return an iterable of the Tuple's values.
<R> R	get(int i) Gets a value of a specific index from the tuple.
default <R> R	head() Gets the first element of the tuple
default boolean	isEmpty() Whether the Tuple is empty.
default <R> R	last() Gets the last element of the tuple
int	size() Gets the number of elements of the Tuple.
default <T> Stream<T>	stream() Stream the tuple's values
Tuple	tail() Gets a Tuple with all the elements of this tuple skipping the first one.
default Object[]	toArray() Convert this Tuple to an Object[].
default <T> T[]	toArray(T[] arr) Fill an arrat with the elements of this Tuple.

Method Detail

get

<R> R get(int i)

Gets a value of a specific index from the tuple.

Type Parameters:

R - return type of the selected field

Parameters:

i - 0..n index of the field to get

Returns:

the selected field at position i in the tuple.

Throws:

IndexOutOfBoundsException - thrown when i < 0 or i > n where n is the last index of the Tuple

size

int size()

Gets the number of elements of the Tuple.

Returns:

the number of elements of the Tuple

head

default <R> R head()

Gets the first element of the tuple

Type Parameters:

R - type to cast to.

Returns:

first element of the tuple

last

default <R> R last()

Gets the last element of the tuple

Type Parameters:

R - type to cast to.

Returns:

the last element of the tuple

stream

default <T> Stream<T> stream()

Stream the tuple's values

Type Parameters:

T - type the values must be casted to.

Returns:

stream of the tuple's values.

asIterable

default <T> Iterable<T> asIterable()

Return an iterable of the Tuple's values.

Type Parameters:

T - type the values must be casted to.

Returns:

stream of the tuple's values

tail

Tuple tail()

Gets a Tuple with all the elements of this tuple skipping the first one.

Returns:

the tail of this tuple as Tuple

isEmpty

default boolean isEmpty()

Whether the Tuple is empty. This is always false except for Tuple0 where it is always true.

Returns:

false

toArray

default Object[] toArray()

Convert this Tuple to an Object[].

Returns:

an Object[] representation of this Tuple.

toArray

default <T> T[] toArray(T[] arr)

Fill an arrat with the elements of this Tuple.

Type Parameters:

T - type of the provided array

Parameters:

arr - the array to file

Returns:

arr filled with the elements of the tuple or a new array with the elements of the tuple if the provided array was too small.