Tuple (abacus-util 1.21.8 API)

java.lang.Object
- com.landawn.abacus.util.Tuple<TP>

All Implemented Interfaces:

Immutable

Direct Known Subclasses:

Tuple.Tuple1, Tuple.Tuple2, Tuple.Tuple3, Tuple.Tuple4, Tuple.Tuple5, Tuple.Tuple6, Tuple.Tuple7, Tuple.Tuple8, Tuple.Tuple9
```
public abstract class Tuple<TP>
extends Object
implements Immutable
```
Since:

0.8

Author:

Haiyang Li

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Tuple.Tuple1<T1>` The Class Tuple1.
`static class`	`Tuple.Tuple2<T1,T2>` The Class Tuple2.
`static class`	`Tuple.Tuple3<T1,T2,T3>` The Class Tuple3.
`static class`	`Tuple.Tuple4<T1,T2,T3,T4>` The Class Tuple4.
`static class`	`Tuple.Tuple5<T1,T2,T3,T4,T5>` The Class Tuple5.
`static class`	`Tuple.Tuple6<T1,T2,T3,T4,T5,T6>` The Class Tuple6.
`static class`	`Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>` The Class Tuple7.
`static class`	`Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>` The Class Tuple8.
`static class`	`Tuple.Tuple9<T1,T2,T3,T4,T5,T6,T7,T8,T9>` The Class Tuple9.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<E extends Exception> void`	`accept(Throwables.Consumer<? super TP,E> action)`
`abstract boolean`	`allNull()`
`abstract boolean`	`anyNull()`
`abstract int`	`arity()`
`abstract boolean`	`contains(Object objToFind)`
`<E extends Exception> u.Optional<TP>`	`filter(Throwables.Predicate<? super TP,E> predicate)`
`static <T1,T2,T3> Tuple.Tuple3<T1,T2,T3>`	`flatten(Tuple.Tuple2<Tuple.Tuple2<T1,T2>,T3> tp)`
`abstract <E extends Exception> void`	`forEach(Throwables.Consumer<?,E> consumer)`
`static <TP extends Tuple<TP>> TP`	`from(Collection<?> c)`
`static <K,V> Tuple.Tuple2<K,V>`	`from(Map.Entry<K,V> entry)`
`static <TP extends Tuple<TP>> TP`	`from(Object[] a)`
`<U,E extends Exception> U`	`map(Throwables.Function<? super TP,U,E> mapper)`
`static <T1> Tuple.Tuple1<T1>`	`of(T1 _1)`
`static <T1,T2> Tuple.Tuple2<T1,T2>`	`of(T1 _1, T2 _2)`
`static <T1,T2,T3> Tuple.Tuple3<T1,T2,T3>`	`of(T1 _1, T2 _2, T3 _3)`
`static <T1,T2,T3,T4> Tuple.Tuple4<T1,T2,T3,T4>`	`of(T1 _1, T2 _2, T3 _3, T4 _4)`
`static <T1,T2,T3,T4,T5> Tuple.Tuple5<T1,T2,T3,T4,T5>`	`of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5)`
`static <T1,T2,T3,T4,T5,T6> Tuple.Tuple6<T1,T2,T3,T4,T5,T6>`	`of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6)`
`static <T1,T2,T3,T4,T5,T6,T7> Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>`	`of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6, T7 _7)`
`static <T1,T2,T3,T4,T5,T6,T7,T8> Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>`	`of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6, T7 _7, T8 _8)` Deprecated. you should consider using `class SomeClass { final T1 propName1, final T2 propName2...}`
`static <T1,T2,T3,T4,T5,T6,T7,T8,T9> Tuple.Tuple9<T1,T2,T3,T4,T5,T6,T7,T8,T9>`	`of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6, T7 _7, T8 _8, T9 _9)` Deprecated. you should consider using `class SomeClass { final T1 propName1, final T2 propName2...}`
`Stream<TP>`	`stream()`
`<T,E extends Exception> Stream<T>`	`stream(Throwables.Function<? super TP,Stream<T>,E> func)`
`abstract Object[]`	`toArray()`
`abstract <A> A[]`	`toArray(A[] a)`
`u.Optional<TP>`	`toOptional()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

arity
```
public abstract int arity()
```

anyNull
```
public abstract boolean anyNull()
```
Returns:

true, if successful

allNull
```
public abstract boolean allNull()
```
Returns:

true, if successful

contains

public abstract boolean contains(Object objToFind)

Parameters:: objToFind -
Returns:

toArray
```
public abstract Object[] toArray()
```

toArray
```
public abstract <A> A[] toArray(A[] a)
```
Type Parameters:

A -

Parameters:

a -

Returns:

forEach

public abstract <E extends Exception> void forEach(Throwables.Consumer<?,E> consumer)
                                            throws E extends Exception

Type Parameters:: E -
Parameters:: consumer -
Throws:: E - the e; E extends Exception

accept

public <E extends Exception> void accept(Throwables.Consumer<? super TP,E> action)
                                  throws E extends Exception

Type Parameters:: E -
Parameters:: action -
Throws:: E - the e; E extends Exception

map

public <U,E extends Exception> U map(Throwables.Function<? super TP,U,E> mapper)
                              throws E extends Exception

Type Parameters:: U -; E -
Parameters:: mapper -
Returns:
Throws:: E - the e; E extends Exception

filter

public <E extends Exception> u.Optional<TP> filter(Throwables.Predicate<? super TP,E> predicate)
                                            throws E extends Exception

Type Parameters:: E -
Parameters:: predicate -
Returns:
Throws:: E - the e; E extends Exception

stream
```
public Stream<TP> stream()
```

stream

public <T,E extends Exception> Stream<T> stream(Throwables.Function<? super TP,Stream<T>,E> func)
                                         throws E extends Exception

Throws:: E extends Exception

toOptional
```
public u.Optional<TP> toOptional()
```
Returns:

of

public static <T1> Tuple.Tuple1<T1> of(T1 _1)

Type Parameters:: T1 -
Parameters:: _1 - the 1
Returns:

of

public static <T1,T2> Tuple.Tuple2<T1,T2> of(T1 _1,
                                             T2 _2)

Type Parameters:: T1 -; T2 -
Parameters:: _1 - the 1; _2 - the 2
Returns:

of

public static <T1,T2,T3> Tuple.Tuple3<T1,T2,T3> of(T1 _1,
                                                   T2 _2,
                                                   T3 _3)

Type Parameters:: T1 -; T2 -; T3 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3
Returns:

of

public static <T1,T2,T3,T4> Tuple.Tuple4<T1,T2,T3,T4> of(T1 _1,
                                                         T2 _2,
                                                         T3 _3,
                                                         T4 _4)

Type Parameters:: T1 -; T2 -; T3 -; T4 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4
Returns:

of

public static <T1,T2,T3,T4,T5> Tuple.Tuple5<T1,T2,T3,T4,T5> of(T1 _1,
                                                               T2 _2,
                                                               T3 _3,
                                                               T4 _4,
                                                               T5 _5)

Type Parameters:: T1 -; T2 -; T3 -; T4 -; T5 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4; _5 - the 5
Returns:

of

public static <T1,T2,T3,T4,T5,T6> Tuple.Tuple6<T1,T2,T3,T4,T5,T6> of(T1 _1,
                                                                     T2 _2,
                                                                     T3 _3,
                                                                     T4 _4,
                                                                     T5 _5,
                                                                     T6 _6)

Type Parameters:: T1 -; T2 -; T3 -; T4 -; T5 -; T6 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4; _5 - the 5; _6 - the 6
Returns:

of

public static <T1,T2,T3,T4,T5,T6,T7> Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7> of(T1 _1,
                                                                           T2 _2,
                                                                           T3 _3,
                                                                           T4 _4,
                                                                           T5 _5,
                                                                           T6 _6,
                                                                           T7 _7)

Type Parameters:: T1 -; T2 -; T3 -; T4 -; T5 -; T6 -; T7 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4; _5 - the 5; _6 - the 6; _7 - the 7
Returns:

of

@Deprecated
public static <T1,T2,T3,T4,T5,T6,T7,T8> Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8> of(T1 _1,
                                                                                              T2 _2,
                                                                                              T3 _3,
                                                                                              T4 _4,
                                                                                              T5 _5,
                                                                                              T6 _6,
                                                                                              T7 _7,
                                                                                              T8 _8)

Deprecated. you should consider using class SomeClass { final T1 propName1, final T2 propName2...}

Type Parameters:: T1 -; T2 -; T3 -; T4 -; T5 -; T6 -; T7 -; T8 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4; _5 - the 5; _6 - the 6; _7 - the 7; _8 - the 8
Returns:

of

@Deprecated
public static <T1,T2,T3,T4,T5,T6,T7,T8,T9> Tuple.Tuple9<T1,T2,T3,T4,T5,T6,T7,T8,T9> of(T1 _1,
                                                                                                    T2 _2,
                                                                                                    T3 _3,
                                                                                                    T4 _4,
                                                                                                    T5 _5,
                                                                                                    T6 _6,
                                                                                                    T7 _7,
                                                                                                    T8 _8,
                                                                                                    T9 _9)

Deprecated. you should consider using class SomeClass { final T1 propName1, final T2 propName2...}

Type Parameters:: T1 -; T2 -; T3 -; T4 -; T5 -; T6 -; T7 -; T8 -; T9 -
Parameters:: _1 - the 1; _2 - the 2; _3 - the 3; _4 - the 4; _5 - the 5; _6 - the 6; _7 - the 7; _8 - the 8; _9 - the 9
Returns:

from
```
public static <K,V> Tuple.Tuple2<K,V> from(Map.Entry<K,V> entry)
```
Type Parameters:

K - the key type

V - the value type

Parameters:

entry -

Returns:

from

public static <TP extends Tuple<TP>> TP from(Object[] a)

Type Parameters:: T -
Parameters:: a -
Returns:

from

public static <TP extends Tuple<TP>> TP from(Collection<?> c)

Type Parameters:: T -
Parameters:: c -
Returns:

flatten

public static <T1,T2,T3> Tuple.Tuple3<T1,T2,T3> flatten(Tuple.Tuple2<Tuple.Tuple2<T1,T2>,T3> tp)

Class Tuple<TP>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

arity

anyNull

allNull

contains

toArray

toArray

forEach

accept

map

filter

stream

stream

toOptional

of

of

of

of

of

of

of

of

of

from

from

from

flatten