模块 iofairy.functional

程序包 com.iofairy.tuple

类 TupleBase

java.lang.Object

com.iofairy.tuple.TupleBase

所有已实现的接口:

Tuple, Serializable

直接已知子类:

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

public abstract class TupleBase
extends Object
implements Tuple

Base tuple

从以下版本开始:

0.0.1

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段	说明
private Map<String,Integer>	alias_index	Map of aliases.
private List<String>	aliasList	List of aliases.
private static String	MSG_FOR_STRING_ALIASES
private static String	MSG_FOR_TUPLE_ALIASES
private static String	MSG_FOR_TUPLE0_UNSUPPORTED
private static long	serialVersionUID
private List<TupleAlias>	tupleAliasList	List of tuple aliases.

构造器概要

构造器

构造器	说明
TupleBase()

方法概要

限定符和类型	方法	说明
<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.
void	clearAlias()	clear all aliases.
private String	concatElement(List<String> strList)
boolean	containsAlias(TupleAlias alias)	whether contains alias.
boolean	containsAlias(String alias)	whether contains alias.
Tuple	copyAliases(Tuple tuple)	Copy aliases from other tuple.
<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个元素（带别名）
boolean	equals(Object obj)
List<String>	getAliases()	Get list of aliases.
List<TupleAlias>	getTupleAliases()	Get list of aliases.
private <R> Map<String,R>	map()
private void	putToMapAndList(String alias, int index)
<R> Map<String,R>	toMap()	Transform this Tuple to Map.
SI	toSI()	Transform this Tuple to SI.
String	toString()

从类继承的方法 java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.iofairy.tuple.Tuple

arity, clone, copy, element, empty, of, of, of, of, of, of, of, of, of, of

字段详细资料

serialVersionUID

private static final long serialVersionUID

另请参阅:

常量字段值

aliasList

private final List<String> aliasList

List of aliases.　普通别名列表。

tupleAliasList

private final List<TupleAlias> tupleAliasList

List of tuple aliases.　TupleAlias别名列表。

alias_index

private final Map<String,Integer> alias_index

Map of aliases.　别名与序号键值对

MSG_FOR_TUPLE0_UNSUPPORTED

private static final String MSG_FOR_TUPLE0_UNSUPPORTED

另请参阅:

常量字段值

MSG_FOR_STRING_ALIASES

private static final String MSG_FOR_STRING_ALIASES

另请参阅:

常量字段值

MSG_FOR_TUPLE_ALIASES

private static final String MSG_FOR_TUPLE_ALIASES

另请参阅:

常量字段值

构造器详细资料

TupleBase

public TupleBase()

方法详细资料

alias

public Tuple alias(TupleAlias... aliases)

从接口复制的说明: Tuple

Setting tuple's aliases. When the number of aliases is not match for tuple's elements Tuple.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);
 

指定者:

alias 在接口中 Tuple

参数:

aliases - aliases.　别名

返回:

tuple.　元组

alias

public Tuple alias(String... aliases)

从接口复制的说明: Tuple

Setting tuple's aliases. Recommend using Tuple.alias(TupleAlias...)
为元组（Tuple）的元素设置别名。推荐使用 Tuple.alias(TupleAlias...) 这个方法设置别名。

指定者:

alias 在接口中 Tuple

参数:

aliases - aliases.　别名

返回:

tuple.　元组

另请参阅:

Tuple.alias(TupleAlias...)

putToMapAndList

private void putToMapAndList(String alias,
                             int index)

aliasType

public String aliasType()

从接口复制的说明: Tuple

Get current alias type: null, tuple, string.
null: not set alias;
tuple: use TupleAlias, when call Tuple.alias(TupleAlias...);
string: use normal alias, when call Tuple.alias(String...).

获取当前设置的别名类型（三种）：null, tuple, string.
null: 表示未设置别名；
tuple: 使用TupleAlias设置别名，在你调用 Tuple.alias(TupleAlias...) 之后；
string: 使用普通的字符串设置别名，在你调用 Tuple.alias(String...) 之后。

指定者:

aliasType 在接口中 Tuple

返回:

alias type

copyAliases

public Tuple copyAliases(Tuple tuple)

从接口复制的说明: Tuple

Copy aliases from other tuple.
从其他tuple中复制别名到当前tuple中

指定者:

copyAliases 在接口中 Tuple

参数:

tuple - other tuple

返回:

this tuple

clearAlias

public void clearAlias()

从接口复制的说明: Tuple

clear all aliases. 清空所有别名。

指定者:

clearAlias 在接口中 Tuple

getTupleAliases

public List<TupleAlias> getTupleAliases()

从接口复制的说明: Tuple

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

指定者:

getTupleAliases 在接口中 Tuple

返回:

list of aliases

getAliases

public List<String> getAliases()

从接口复制的说明: Tuple

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

指定者:

getAliases 在接口中 Tuple

返回:

list of aliases

aliasesEquals

public boolean aliasesEquals(Tuple tuple)

从接口复制的说明: Tuple

Indicates whether some other Tuple object's aliases is "equal to" this one.
比较两个Tuple的别名是否相等。

指定者:

aliasesEquals 在接口中 Tuple

参数:

tuple - other tuple object

返回:

return true if aliases are equal.　返回true，如果两个tuple的所有别名都相等。

__

public <R> R __(TupleAlias alias)

从接口复制的说明: Tuple

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

指定者:

__ 在接口中 Tuple

类型参数:

R - return type 返回值类型

参数:

alias - tuple element alias 别名

返回:

tuple element value

__

public <R> R __(String alias)

从接口复制的说明: Tuple

Get tuple element value by alias. Recommend using Tuple.__(TupleAlias)

指定者:

__ 在接口中 Tuple

类型参数:

R - return type 返回值类型

参数:

alias - tuple element alias 别名

返回:

tuple element value

另请参阅:

Tuple.__(TupleAlias)

containsAlias

public boolean containsAlias(TupleAlias alias)

从接口复制的说明: Tuple

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

指定者:

containsAlias 在接口中 Tuple

参数:

alias - alias.　别名

返回:

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

containsAlias

public boolean containsAlias(String alias)

从接口复制的说明: Tuple

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

指定者:

containsAlias 在接口中 Tuple

参数:

alias - alias.　别名

返回:

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

toMap

public <R> Map<String,R> toMap()

从接口复制的说明: Tuple

Transform this Tuple to Map.
将 tuple 转成 map

指定者:

toMap 在接口中 Tuple

类型参数:

R - map value type

返回:

a map -- key is alias, value is tuple's element

map

private <R> Map<String,R> map()

toSI

public SI toSI()

从接口复制的说明: Tuple

Transform this Tuple to SI.
将 tuple 转成 SI

指定者:

toSI 在接口中 Tuple

返回:

SI object.

elementWithTupleAlias

public <R> Tuple2<TupleAlias,R> elementWithTupleAlias(int n)

从接口复制的说明: Tuple

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

指定者:

elementWithTupleAlias 在接口中 Tuple

类型参数:

R - return type 返回值类型

参数:

n - index 序号

返回:

(alias, element)

elementWithAlias

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

从接口复制的说明: Tuple

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

指定者:

elementWithAlias 在接口中 Tuple

类型参数:

R - return type 返回值类型

参数:

n - index 序号

返回:

(alias, element)

toString

public String toString()

覆盖:

toString 在类中 Object

concatElement

private String concatElement(List<String> strList)

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object