Module com.speedment.common.tuple

Package com.speedment.common.tuple

Interface BasicTuple<R>

Type Parameters:

R - The return type of get(int)

All Known Subinterfaces:

MutableTuple, MutableTuple0, MutableTuple1<T0>, MutableTuple10<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9>, MutableTuple11<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, MutableTuple12<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, MutableTuple13<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, MutableTuple14<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, MutableTuple15<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, MutableTuple16<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, MutableTuple17<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>, MutableTuple18<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>, MutableTuple19<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>, MutableTuple2<T0,T1>, MutableTuple20<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>, MutableTuple21<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>, MutableTuple22<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>, MutableTuple23<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>, MutableTuple3<T0,T1,T2>, MutableTuple4<T0,T1,T2,T3>, MutableTuple5<T0,T1,T2,T3,T4>, MutableTuple6<T0,T1,T2,T3,T4,T5>, MutableTuple7<T0,T1,T2,T3,T4,T5,T6>, MutableTuple8<T0,T1,T2,T3,T4,T5,T6,T7>, MutableTuple9<T0,T1,T2,T3,T4,T5,T6,T7,T8>, Tuple, Tuple0, Tuple0OfNullables, Tuple1<T0>, Tuple10<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9>, Tuple10OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9>, Tuple11<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, Tuple11OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, Tuple12<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, Tuple12OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, Tuple13<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, Tuple13OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, Tuple14<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, Tuple14OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, Tuple15<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, Tuple15OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, Tuple16<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, Tuple16OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, Tuple17<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>, Tuple17OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>, Tuple18<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>, Tuple18OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>, Tuple19<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>, Tuple19OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>, Tuple1OfNullables<T0>, Tuple2<T0,T1>, Tuple20<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>, Tuple20OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>, Tuple21<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>, Tuple21OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>, Tuple22<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>, Tuple22OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>, Tuple23<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>, Tuple23OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>, Tuple2OfNullables<T0,T1>, Tuple3<T0,T1,T2>, Tuple3OfNullables<T0,T1,T2>, Tuple4<T0,T1,T2,T3>, Tuple4OfNullables<T0,T1,T2,T3>, Tuple5<T0,T1,T2,T3,T4>, Tuple5OfNullables<T0,T1,T2,T3,T4>, Tuple6<T0,T1,T2,T3,T4,T5>, Tuple6OfNullables<T0,T1,T2,T3,T4,T5>, Tuple7<T0,T1,T2,T3,T4,T5,T6>, Tuple7OfNullables<T0,T1,T2,T3,T4,T5,T6>, Tuple8<T0,T1,T2,T3,T4,T5,T6,T7>, Tuple8OfNullables<T0,T1,T2,T3,T4,T5,T6,T7>, Tuple9<T0,T1,T2,T3,T4,T5,T6,T7,T8>, Tuple9OfNullables<T0,T1,T2,T3,T4,T5,T6,T7,T8>, TupleOfNullables

public interface BasicTuple<R>

Author:

pemi

Method Summary

Modifier and Type	Method	Description
int	degree()	Returns the degree of the BasicTuple.
R	get(int index)	Gets the tuple element at the given index.
<T> Stream<T>	streamOf(Class<T> clazz)	Returns a Stream of all values for this Tuple of the given class.

Method Detail

degree

int degree()

Returns the degree of the BasicTuple. For example, a Tuple2 has a degree of 2 whereas a Tuple3 has a degree of 3.

Returns:

the degree of the Tuple

get

R get(int index)

Gets the tuple element at the given index. For example, get(0) will return the first element and get(1) will return the second etc.

Parameters:

index - of the element to get

Returns:

the tuple element at the given index

Throws:

IndexOutOfBoundsException - if index < 0 || index >= length()

streamOf

<T> Stream<T> streamOf(Class<T> clazz)

Returns a Stream of all values for this Tuple of the given class. I.e. all non-null members of a Tuple that can be cast to the given class are included in the Stream. If sequential, the Stream will start with the 0:th tuple and progress upwards.

Type Parameters:

T - The type of stream

Parameters:

clazz - The class of the type of the stream

Returns:

a Stream of all values for this Tuple of the given class