javaslang

Interface Tuple

All Known Implementing Classes:

Tuple0, Tuple1, Tuple2, Tuple3, Tuple4, Tuple5, Tuple6, Tuple7, Tuple8

public interface Tuple

The base interface of all tuples.

Since:

1.1.0

Author:

Daniel Dietrich

Method Summary

Modifier and Type	Method and Description
int	arity() Returns the number of elements of this tuple.
static Tuple0	empty() Creates the empty tuple.
static <T1> Tuple1<T1>	of(T1 t1) Creates a tuple of one element.
static <T1,T2> Tuple2<T1,T2>	of(T1 t1, T2 t2) Creates a tuple of two elements.
static <T1,T2,T3> Tuple3<T1,T2,T3>	of(T1 t1, T2 t2, T3 t3) Creates a tuple of three elements.
static <T1,T2,T3,T4> Tuple4<T1,T2,T3,T4>	of(T1 t1, T2 t2, T3 t3, T4 t4) Creates a tuple of 4 elements.
static <T1,T2,T3,T4,T5> Tuple5<T1,T2,T3,T4,T5>	of(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5) Creates a tuple of 5 elements.
static <T1,T2,T3,T4,T5,T6> Tuple6<T1,T2,T3,T4,T5,T6>	of(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6) Creates a tuple of 6 elements.
static <T1,T2,T3,T4,T5,T6,T7> Tuple7<T1,T2,T3,T4,T5,T6,T7>	of(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7) Creates a tuple of 7 elements.
static <T1,T2,T3,T4,T5,T6,T7,T8> Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>	of(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8) Creates a tuple of 8 elements.
Seq<?>	toSeq() Converts this tuple to a sequence.

Method Detail

arity

int arity()

Returns the number of elements of this tuple.

Returns:

the number of elements.

toSeq

Seq<?> toSeq()

Converts this tuple to a sequence.

Returns:

A new Seq.

empty

static Tuple0 empty()

Creates the empty tuple.

Returns:

the empty tuple.

of

static <T1> Tuple1<T1> of(T1 t1)

Creates a tuple of one element.

Type Parameters:

T1 - type of the 1st element

Parameters:

t1 - the 1st element

Returns:

a tuple of one element.

of

static <T1,T2> Tuple2<T1,T2> of(T1 t1,
                                T2 t2)

Creates a tuple of two elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

Parameters:

t1 - the 1st element

t2 - the 2nd element

Returns:

a tuple of two elements.

of

static <T1,T2,T3> Tuple3<T1,T2,T3> of(T1 t1,
                                      T2 t2,
                                      T3 t3)

Creates a tuple of three elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

Returns:

a tuple of three elements.

of

static <T1,T2,T3,T4> Tuple4<T1,T2,T3,T4> of(T1 t1,
                                            T2 t2,
                                            T3 t3,
                                            T4 t4)

Creates a tuple of 4 elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

T4 - type of the 4th element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

t4 - the 4th element

Returns:

a tuple of 4 elements.

of

static <T1,T2,T3,T4,T5> Tuple5<T1,T2,T3,T4,T5> of(T1 t1,
                                                  T2 t2,
                                                  T3 t3,
                                                  T4 t4,
                                                  T5 t5)

Creates a tuple of 5 elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

T4 - type of the 4th element

T5 - type of the 5th element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

t4 - the 4th element

t5 - the 5th element

Returns:

a tuple of 5 elements.

of

static <T1,T2,T3,T4,T5,T6> Tuple6<T1,T2,T3,T4,T5,T6> of(T1 t1,
                                                        T2 t2,
                                                        T3 t3,
                                                        T4 t4,
                                                        T5 t5,
                                                        T6 t6)

Creates a tuple of 6 elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

T4 - type of the 4th element

T5 - type of the 5th element

T6 - type of the 6th element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

t4 - the 4th element

t5 - the 5th element

t6 - the 6th element

Returns:

a tuple of 6 elements.

of

static <T1,T2,T3,T4,T5,T6,T7> Tuple7<T1,T2,T3,T4,T5,T6,T7> of(T1 t1,
                                                              T2 t2,
                                                              T3 t3,
                                                              T4 t4,
                                                              T5 t5,
                                                              T6 t6,
                                                              T7 t7)

Creates a tuple of 7 elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

T4 - type of the 4th element

T5 - type of the 5th element

T6 - type of the 6th element

T7 - type of the 7th element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

t4 - the 4th element

t5 - the 5th element

t6 - the 6th element

t7 - the 7th element

Returns:

a tuple of 7 elements.

of

static <T1,T2,T3,T4,T5,T6,T7,T8> Tuple8<T1,T2,T3,T4,T5,T6,T7,T8> of(T1 t1,
                                                                    T2 t2,
                                                                    T3 t3,
                                                                    T4 t4,
                                                                    T5 t5,
                                                                    T6 t6,
                                                                    T7 t7,
                                                                    T8 t8)

Creates a tuple of 8 elements.

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

T4 - type of the 4th element

T5 - type of the 5th element

T6 - type of the 6th element

T7 - type of the 7th element

T8 - type of the 8th element

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

t4 - the 4th element

t5 - the 5th element

t6 - the 6th element

t7 - the 7th element

t8 - the 8th element

Returns:

a tuple of 8 elements.