模块 gg.functional

程序包 com.github.gg_a.tuple

接口 Tuple

所有超级接口:

Serializable

所有已知实现类:

EasyTuple2, EasyTuple3, EasyTuple4, EasyTuple5, EasyTuple6, EasyTuple7, EasyTuple8, EasyTuple9, Tuple0, Tuple1, Tuple2, Tuple3, Tuple4, Tuple5, Tuple6, Tuple7, Tuple8, Tuple9, TupleBase

public interface Tuple
extends Serializable

Tuple Interface

字段概要

字段

限定符和类型	字段	说明
static long	serialVersionUID

方法概要

限定符和类型	方法	说明
<R> R	__(String alias)	Get tuple element value by alias, it will throw AliasNotFoundException when alias not found. 通过别名获取元组元素的值，如果不存在该别名，将抛出异常 AliasNotFoundException。
Tuple	alias(String... aliases)	Setting tuple's aliases.
int	arity()	The size of this Tuple. 元组的元素数量
boolean	containsAlias(String alias)	whether contains alias.
<R> R	element(int n)	The nth element of this tuple 从元组中取第n个元素
<R> Tuple2<String,R>	elementWithAlias(int n)	The nth element with alias of this tuple 从元组中取第n个元素（带别名）
static Tuple0	empty()	Create empty tuple 创建一个空元组
List<String>	getAliases()	Get list of aliases.
static Tuple0	of()	Create empty tuple 创建一个空元组
static <T1> Tuple1<T1>	of(T1 _1)	Create a tuple of 1 element 创建1个元素的元组
static <T1,T2> Tuple2<T1,T2>	of(T1 _1, T2 _2)	Create a tuple of 2 elements 创建2个元素的元组
static <T1,T2,T3> Tuple3<T1,T2,T3>	of(T1 _1, T2 _2, T3 _3)	Create a tuple of 3 elements 创建3个元素的元组
static <T1,T2,T3,T4> Tuple4<T1,T2,T3,T4>	of(T1 _1, T2 _2, T3 _3, T4 _4)	Create a tuple of 4 elements 创建4个元素的元组
static <T1,T2,T3,T4,T5> Tuple5<T1,T2,T3,T4,T5>	of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5)	Create a tuple of 5 elements 创建5个元素的元组
static <T1,T2,T3,T4,T5,T6> Tuple6<T1,T2,T3,T4,T5,T6>	of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6)	Create a tuple of 6 elements 创建6个元素的元组
static <T1,T2,T3,T4,T5,T6,T7> Tuple7<T1,T2,T3,T4,T5,T6,T7>	of(T1 _1, T2 _2, T3 _3, T4 _4, T5 _5, T6 _6, T7 _7)	Create a tuple of 7 elements 创建7个元素的元组
static <T1,T2,T3,T4,T5,T6,T7,T8> 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)	Create a tuple of 8 elements 创建8个元素的元组
static <T1,T2,T3,T4,T5,T6,T7,T8,T9> 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)	Create a tuple of 9 elements 创建9个元素的元组

字段详细资料

serialVersionUID

static final long serialVersionUID

另请参阅:

常量字段值

方法详细资料

arity

int arity()

The size of this Tuple.
元组的元素数量

返回:

元素数量

alias

Tuple alias(String... aliases)

Setting tuple's aliases. When the number of aliases is not match for tuple's elements arity() , will throw NumberOfAliasesException
为元组（Tuple）的元素设置别名。当设置的别名数量与元组的元素数量不匹配，将会抛出NumberOfAliasesException

参数:

aliases - aliases.　别名

返回:

tuple.　元组

抛出:

NumberOfAliasesException - if the number of aliases is not equal arity(). 如果设置的别名的数量不等于 arity()，抛出此异常

UnsupportedOperationException - if the alias method is called by Tuple0 Tuple0.alias(java.lang.String...).

getAliases

List<String> getAliases()

Get list of aliases. 获取别名列表。

返回:

list of aliases

__

<R> R __(String alias)

Get tuple element value by alias, it will throw AliasNotFoundException when alias not found.
通过别名获取元组元素的值，如果不存在该别名，将抛出异常 AliasNotFoundException。
注：`_`（下划线） 在 Java 9 中被定义成了关键字，无法单独使用 `_`（下划线） 作为标识符。

类型参数:

R - return type 返回值类型

参数:

alias - tuple element alias 别名

返回:

tuple element value

抛出:

AliasNotFoundException - if the `alias` not found. 如果元组不存在该别名，抛出异常

containsAlias

boolean containsAlias(String alias)

whether contains alias. 该元组中是否包含别名

参数:

alias - alias.　别名

返回:

return true if contains alias.　返回true，如果此tuple包含该别名。

element

<R> R element(int n)

The nth element of this tuple
从元组中取第n个元素

类型参数:

R - return type 返回值类型

参数:

n - index 序号

返回:

return value of sp

抛出:

IndexOutOfBoundsException - if the `n` is out of range(n < 0 || n >= arity). 当 n < 0 或者 n >= arity() 时，抛出异常。

elementWithAlias

<R> Tuple2<String,R> elementWithAlias(int n)

The nth element with alias of this tuple
从元组中取第n个元素（带别名）

类型参数:

R - return type 返回值类型

参数:

n - index 序号

返回:

(alias, element)

抛出:

AliasNotSetException - if call elementWithAlias(int) before alias(java.lang.String...). 在调用 alias(java.lang.String...) 之前调用 elementWithAlias(int)，将抛出AliasNotSetException

IndexOutOfBoundsException - if the `n` is out of range(n < 0 || n >= arity). 当 n < 0 或者 n >= arity() 时，抛出异常。

empty

static Tuple0 empty()

Create empty tuple
创建一个空元组

返回:

the instance of Tuple0.　返回Tuple0的实例

of

static Tuple0 of()

Create empty tuple
创建一个空元组

返回:

the instance of Tuple0.　返回Tuple0的实例

of

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

Create a tuple of 1 element
创建1个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

参数:

_1 - the 1st element.　第1个元素

返回:

the instance of Tuple1.　返回Tuple1的实例

of

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

Create a tuple of 2 elements
创建2个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

返回:

the instance of Tuple2.　返回Tuple2的实例

of

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

Create a tuple of 3 elements
创建3个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

返回:

the instance of Tuple3.　返回Tuple3的实例

of

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

Create a tuple of 4 elements
创建4个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

返回:

the instance of Tuple4.　返回Tuple4的实例

of

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

Create a tuple of 5 elements
创建5个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

T5 - type of the 5th element.　第5个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

_5 - the 5th element.　第5个元素

返回:

the instance of Tuple5.　返回Tuple5的实例

of

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

Create a tuple of 6 elements
创建6个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

T5 - type of the 5th element.　第5个元素的类型

T6 - type of the 6th element.　第6个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

_5 - the 5th element.　第5个元素

_6 - the 6th element.　第6个元素

返回:

the instance of Tuple6.　返回Tuple6的实例

of

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

Create a tuple of 7 elements
创建7个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

T5 - type of the 5th element.　第5个元素的类型

T6 - type of the 6th element.　第6个元素的类型

T7 - type of the 7th element.　第7个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

_5 - the 5th element.　第5个元素

_6 - the 6th element.　第6个元素

_7 - the 7th element.　第7个元素

返回:

the instance of Tuple7.　返回Tuple7的实例

of

static <T1,T2,T3,T4,T5,T6,T7,T8> 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)

Create a tuple of 8 elements
创建8个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

T5 - type of the 5th element.　第5个元素的类型

T6 - type of the 6th element.　第6个元素的类型

T7 - type of the 7th element.　第7个元素的类型

T8 - type of the 8th element.　第8个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

_5 - the 5th element.　第5个元素

_6 - the 6th element.　第6个元素

_7 - the 7th element.　第7个元素

_8 - the 8th element.　第8个元素

返回:

the instance of Tuple8.　返回Tuple8的实例

of

static <T1,T2,T3,T4,T5,T6,T7,T8,T9> 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)

Create a tuple of 9 elements
创建9个元素的元组

类型参数:

T1 - type of the 1st element.　第1个元素的类型

T2 - type of the 2nd element.　第2个元素的类型

T3 - type of the 3rd element.　第3个元素的类型

T4 - type of the 4th element.　第4个元素的类型

T5 - type of the 5th element.　第5个元素的类型

T6 - type of the 6th element.　第6个元素的类型

T7 - type of the 7th element.　第7个元素的类型

T8 - type of the 8th element.　第8个元素的类型

T9 - type of the 9th element.　第9个元素的类型

参数:

_1 - the 1st element.　第1个元素

_2 - the 2nd element.　第2个元素

_3 - the 3rd element.　第3个元素

_4 - the 4th element.　第4个元素

_5 - the 5th element.　第5个元素

_6 - the 6th element.　第6个元素

_7 - the 7th element.　第7个元素

_8 - the 8th element.　第8个元素

_9 - the 9th element.　第9个元素

返回:

the instance of Tuple9.　返回Tuple9的实例