Tuple (JFunctional 0.8.6 API)

所有超级接口:

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

从以下版本开始:

0.1.0

字段概要

字段
限定符和类型字段说明

static long serialVersionUID

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

方法概要

所有方法静态方法实例方法抽象方法默认方法
限定符和类型	方法	说明
`<R> R`	`__(TupleAlias alias)`	Get tuple element value by alias, it will throw `AliasNotFoundException` when alias not found. 通过别名获取元组元素的值，如果不存在该别名，将抛出异常 AliasNotFoundException。
`<R> R`	`__(String alias)`	Get tuple element value by alias.
`Tuple`	`alias(TupleAlias... aliases)`	Setting tuple's aliases.
`Tuple`	`alias(String... aliases)`	Setting tuple's aliases.
`boolean`	`aliasesEquals(Tuple tuple)`	Indicates whether some other Tuple object's aliases is "equal to" this one.
`String`	`aliasType()`	Get current alias type: null, tuple, string.
`int`	`arity()`	The size of this Tuple. 元组的元素数量
`void`	`clearAlias()`	clear all aliases.
`static Tuple`	`clone(Tuple tuple)`	clone a tuple by shallow copy.
`boolean`	`containsAlias(TupleAlias alias)`	whether contains alias.
`boolean`	`containsAlias(String alias)`	whether contains alias.
`Tuple`	`copyAliases(Tuple tuple)`	Copy aliases from other tuple.
`<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个元素（带别名）
`<R> Tuple2<TupleAlias,R>`	`elementWithTupleAlias(int n)`	The nth element with alias of this tuple 从元组中取第n个元素（带别名）
`static Tuple0`	`empty()`	Create empty tuple 创建一个空元组
`List<String>`	`getAliases()`	Get list of aliases.
`List<TupleAlias>`	`getTupleAliases()`	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个元素的元组
`<R> Map<String,R>`	`toMap()`	Transform this Tuple to Map.
`SI`	`toSI()`	Transform this Tuple to `SI`.

- 字段详细资料
  - serialVersionUID
```
static final long serialVersionUID
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - arity
```
int arity()
```
    The size of this Tuple.
    元组的元素数量
    
    返回:
    
    元素数量
  - alias
```
Tuple alias(TupleAlias... aliases)
```
    Setting tuple's aliases. When the number of aliases is not match for tuple's elements arity() , will throw NumberOfAliasesException
    为元组（Tuple）的元素设置别名。当设置的别名数量与元组的元素数量不匹配，将会抛出NumberOfAliasesException
    Examples:
```
 // MyTupleAlias.java
 package mypackage;
 public enum MyTupleAlias implements TupleAlias {
     // You can put All aliases in one `enum MyTupleAlias` for all Tuple Type,
     // or create more enum by category: enum UserAliases, enum AddressAliases ...
     // 可以把所有的Tuple要用到的别名全部放在一个枚举类型中，可以使用一些特殊命名为Alias分类，
     // 如下面的 $USER_ALIAS$, $ORDER_ALIAS$。
     // 也可以创建多个枚举类型用于存储不同的Tuple数据。

     $USER_ALIAS$,
          ID, NAME, TEL, AGE, BIRTHDAY, PROVINCE, CITY, REGISTERTIME,
     $ORDER_ALIAS$,
          ORDERID, GOODSID, USERID, PRICE, QUANTITY, ORDERTIME, PAYTIME
 }

 // TestMain.java
 package test.xxx;
 import static mypackage.MyTupleAlias.*;    // import MyTupleAlias

 Tuple3<Integer, String, Integer> tuple = new Tuple3<>(1, "Tom", 20);
 tuple.alias(ID, NAME, AGE);
 
```
    参数:
    
    aliases - aliases.　别名
    
    返回:
    
    tuple.　元组
    
    抛出:
    
    NumberOfAliasesException - if the number of aliases is not equal arity(). 如果设置的别名的数量不等于 arity()，抛出此异常
    
    UnsupportedOperationException - if this method is called by Tuple0 Tuple0.alias(TupleAlias...).
    
    从以下版本开始:
    
    0.5.0
  - alias
```
Tuple alias(String... aliases)
```
    Setting tuple's aliases. Recommend using alias(TupleAlias...)
    为元组（Tuple）的元素设置别名。推荐使用 alias(TupleAlias...) 这个方法设置别名。
    
    参数:
    
    aliases - aliases.　别名
    
    返回:
    
    tuple.　元组
    
    抛出:
    
    NumberOfAliasesException - if the number of aliases is not equal arity(). 如果设置的别名的数量不等于 arity()，抛出此异常
    
    UnsupportedOperationException - if this method is called by Tuple0 Tuple0.alias(String...).
    
    另请参阅:
    
    alias(TupleAlias...)
  - aliasType
```
String aliasType()
```
    Get current alias type: null, tuple, string.
    null: not set alias;
    tuple: use TupleAlias, when call alias(TupleAlias...);
    string: use normal alias, when call alias(String...).
    
    获取当前设置的别名类型（三种）：null, tuple, string.
    null: 表示未设置别名；
    tuple: 使用TupleAlias设置别名，在你调用 alias(TupleAlias...) 之后；
    string: 使用普通的字符串设置别名，在你调用 alias(String...) 之后。
    
    返回:
    
    alias type
    
    从以下版本开始:
    
    0.5.3
  - copyAliases
```
Tuple copyAliases(Tuple tuple)
```
    Copy aliases from other tuple.
    从其他tuple中复制别名到当前tuple中
    
    参数:
    
    tuple - other tuple
    
    返回:
    
    this tuple
    
    从以下版本开始:
    
    0.5.3
  - clearAlias
```
void clearAlias()
```
    clear all aliases. 清空所有别名。
    
    从以下版本开始:
    
    0.5.3
  - getTupleAliases
```
List<TupleAlias> getTupleAliases()
```
    Get list of aliases. 获取别名列表。
    
    返回:
    
    list of aliases
    
    从以下版本开始:
    
    0.5.0
  - getAliases
```
List<String> getAliases()
```
    Get list of aliases. 获取别名列表。
    
    返回:
    
    list of aliases
  - aliasesEquals
```
boolean aliasesEquals(Tuple tuple)
```
    Indicates whether some other Tuple object's aliases is "equal to" this one.
    比较两个Tuple的别名是否相等。
    
    参数:
    
    tuple - other tuple object
    
    返回:
    
    return true if aliases are equal.　返回true，如果两个tuple的所有别名都相等。
    
    从以下版本开始:
    
    0.5.3
  - __
```
<R> R __(TupleAlias 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
    
    抛出:
    
    AliasNotSetException - if call this method before alias(TupleAlias...). 在调用 alias(TupleAlias...) 之前调用此方法，将抛出AliasNotSetException
    
    AliasNotFoundException - if the `alias` not found. 如果元组不存在该别名，抛出异常
    
    从以下版本开始:
    
    0.5.0
  - __
```
<R> R __(String alias)
```
    Get tuple element value by alias. Recommend using __(TupleAlias)
    
    类型参数:
    
    R - return type 返回值类型
    
    参数:
    
    alias - tuple element alias 别名
    
    返回:
    
    tuple element value
    
    抛出:
    
    AliasNotSetException - if call this method before alias(String...). 在调用 alias(String...) 之前调用此方法，将抛出AliasNotSetException
    
    AliasNotFoundException - if the `alias` not found. 如果元组不存在该别名，抛出异常
    
    另请参阅:
    
    __(TupleAlias)
  - containsAlias
```
boolean containsAlias(TupleAlias alias)
```
    whether contains alias. 该元组中是否包含别名
    
    参数:
    
    alias - alias.　别名
    
    返回:
    
    return true if contains alias.　返回true，如果此tuple包含该别名。
    
    从以下版本开始:
    
    0.5.0
  - containsAlias
```
boolean containsAlias(String alias)
```
    whether contains alias. 该元组中是否包含别名
    
    参数:
    
    alias - alias.　别名
    
    返回:
    
    return true if contains alias.　返回true，如果此tuple包含该别名。
  - toMap
```
<R> Map<String,R> toMap()
```
    Transform this Tuple to Map.
    将 tuple 转成 map
    
    类型参数:
    
    R - map value type
    
    返回:
    
    a map -- key is alias, value is tuple's element
    
    从以下版本开始:
    
    0.7.3
  - toSI
```
SI toSI()
```
    Transform this Tuple to SI.
    将 tuple 转成 SI
    
    返回:
    
    SI object.
    
    从以下版本开始:
    
    0.8.0
  - 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() 时，抛出异常。
  - elementWithTupleAlias
```
<R> Tuple2<TupleAlias,R> elementWithTupleAlias(int n)
```
    The nth element with alias of this tuple
    从元组中取第n个元素（带别名）
    
    类型参数:
    
    R - return type 返回值类型
    
    参数:
    
    n - index 序号
    
    返回:
    
    (alias, element)
    
    抛出:
    
    AliasNotSetException - if call this method before alias(TupleAlias...). 在调用 alias(TupleAlias...) 之前调用此方法，将抛出AliasNotSetException
    
    IndexOutOfBoundsException - if the `n` is out of range(n < 0 || n >= arity). 当 n < 0 或者 n >= arity() 时，抛出异常。
    
    从以下版本开始:
    
    0.5.0
  - 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 this method before alias(String...). 在调用 alias(String...) 之前调用此方法，将抛出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的实例
  - clone
```
static Tuple clone(Tuple tuple)
```
    clone a tuple by shallow copy.
    通过浅拷贝的方式克隆一个tuple
    
    参数:
    
    tuple - origin tuple
    
    返回:
    
    new tuple
    
    从以下版本开始:
    
    0.5.3

接口 Tuple

字段概要

方法概要

字段详细资料

serialVersionUID

方法详细资料

arity

alias

alias

aliasType

copyAliases

clearAlias

getTupleAliases

getAliases

aliasesEquals

__

__

containsAlias

containsAlias

toMap

toSI

element

elementWithTupleAlias

elementWithAlias

empty

of

of

of

of

of

of

of

of

of

of

clone