UniteId (weforward-data-api 1.2.2 API)

java.lang.Object
- cn.weforward.common.UniteId
- - cn.weforward.data.UniteId

所有已实现的接口:

cn.weforward.common.UniqueKey, Serializable
```
public final class UniteId
extends cn.weforward.common.UniteId
```
联合标识（以便在整个系统中比较简单实现唯一标识）由三部分组成：
类型名（对象/类）
序号（同类型下的唯一标识）
名称/说明
如：“user$12345678!小明”；“12345678”；“12345678!小明”；“user$12345678” 分隔符尽量避免在URL中传输需要编码（符号“$-_.+!*'(),”不需要编码，但“+”表示空格）

作者:

liangyi,daibo

另请参阅:

序列化表格

字段概要

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

static UniteId _nil
空的联合ID
- 从类继承的字段 cn.weforward.common.UniteId
  _Logger, _SimpleNameCache, _SpeartorChecked, ESCAPE, LN_SPEARATOR, m_IndexId, m_IndexType, m_IntOrdinal, m_Unite, OBJECT_SPEARATOR, PREFIX_SPEARATOR, TYPE_SPEARATOR, UNITE_SPEARATOR

字段
限定符和类型	字段和说明
`static UniteId`	`_nil` 空的联合ID

构造器概要

构造器
限定符	构造器和说明
`protected`	`UniteId(int ordinal, String caption, String type)`
	`UniteId(String uniteid)` 构建联合ID
`protected`	`UniteId(String ordinal, int intOrdinal, String caption, String type)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`UniteId`	`changeCaption(String caption)` 替换或增加描述部分
`UniteId`	`changeType(Class<?> type)` 替换或增加类型部分
`UniteId`	`changeType(String type)` 替换或增加类型部分
`static String`	`changeType(String ordinal, Class<?> type)` 替换类型部分（若标识串中有的话）
`static String`	`changeType(String uniteid, String type)` 替换类型部分（若标识串中有的话）
`boolean`	`equals(Object obj)`
`static boolean`	`equals(String id1, String id2)` 比较方法
`static String`	`escapeOrdinal(String ordinal)` 编码序号中可能存在的分隔符
`static UniteId`	`fixId(String unitid, Class<?> clazz)` 修正标识串为只有ID部分（类型及序号），若没有类型部分则把type补充上去
`static UniteId`	`fixId(String unitid, String type)` 修正标识串为只有ID部分（类型及序号），若没有类型部分则把type补充上去
`static String`	`getCaption(String uniteid)` 取得名称/说明部分
`static String`	`getId(String uniteid)` 返回序号及类型部分的标识串（不包含名称/描述部分），与getUuid()方法等同
`static int`	`getIntOrdinal(String uniteid)` 取得序号部分（数值型）
`static String`	`getOrdinal(String uniteid)` 只返回序号部分
`static String`	`getSimpleName(Class<?> clazz)` 取得类用于标识/映射对象的短名（主要代替Class.getSimpleName，性能高于其将近10倍）
`static String`	`getType(Class<?> classOf)` 由对象类型取得类型名
`static String`	`getType(String uniteid)` 取得类型部分
`static String`	`getUniteId(Class<?> type, int ordinal)` 由类型及数值序号组成联合标识串
`static String`	`getUniteId(Class<?> type, String ordinal)` 由类型及序号组成联合标识串
`static String`	`getUniteId(int ordinal, String caption)` 由数值序号及名称/说明组成联合标识串
`static String`	`getUniteId(int ordinal, String caption, String type)` 由数值序号、名称/说明及类型组成联合标识串
`static String`	`getUniteId(String type, int ordinal)` 由类型及数值序号组成联合标识串
`static String`	`getUniteId(String ordinal, String caption, String type)` 由序号、名称/说明及类型组成联合标识串
`static String`	`getUuid(String uniteid)` 返回序号及类型部分的标识串（不包含名称/描述部分），与getId()方法等同
`static boolean`	`isEmpty(UniteId unid)` 联合标识是否为空
`static boolean`	`isEmtpy(UniteId unid)` 已过时。拼写错误
`String`	`stringValue()`
`String`	`toString()`
`static String`	`unescapeOrdinal(String ordinal)` 还原序号中可能存在的分隔符
`static UniteId`	`valueOf(int ordinal, Class<?> type)` 转为联合标识对象
`static UniteId`	`valueOf(int ordinal, String type, String caption)` 转为联合标识对象
`static UniteId`	`valueOf(String uniteid)` 转为联合标识对象
`static UniteId`	`valueOf(String ordinal, Class<?> type)` 转为联合标识对象
`static UniteId`	`valueOf(String ordinal, int intOrdinal, Class<?> type)` 转为联合标识对象
`static UniteId`	`valueOf(String ordinal, int intOrdinal, String type, String caption)` 转为联合标识对象
`static UniteId`	`valueOf(String ordinal, String type, String caption)` 转为联合标识对象

从类继承的方法 cn.weforward.common.UniteId
equals, equals, getCaption, getId, getIntOrdinal, getKey, getOrdinal, getType, getUuid, isDeclareCaption, isDeclareType, isEmpty, withoutPostfix, withoutType

从类继承的方法 java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料
- _nil
```
public static final UniteId _nil
```
  空的联合ID

构造器详细资料

UniteId
```
public UniteId(String uniteid)
```
构建联合ID

参数:

uniteid - 联合ID格式串，如：user$12345678!小明

UniteId

protected UniteId(int ordinal,
                  String caption,
                  String type)

UniteId

protected UniteId(String ordinal,
                  int intOrdinal,
                  String caption,
                  String type)

方法详细资料
- changeType
```
public UniteId changeType(Class<?> type)
```
  替换或增加类型部分
  
  覆盖:
  
  changeType 在类中 cn.weforward.common.UniteId
  
  参数:
  
  type - 新类型
  
  返回:
  
  转换后的联合标识
- changeType
```
public UniteId changeType(String type)
```
  替换或增加类型部分
  
  覆盖:
  
  changeType 在类中 cn.weforward.common.UniteId
  
  参数:
  
  type - 新类型
  
  返回:
  
  转换后的联合标识
- changeCaption
```
public UniteId changeCaption(String caption)
```
  替换或增加描述部分
  
  覆盖:
  
  changeCaption 在类中 cn.weforward.common.UniteId
  
  参数:
  
  caption - 新描述
  
  返回:
  
  转换后的联合标识
- isEmpty
```
public static final boolean isEmpty(UniteId unid)
```
  联合标识是否为空
  
  参数:
  
  unid - 联合标识
  
  返回:
  
  true/false
- isEmtpy
```
public static final boolean isEmtpy(UniteId unid)
```
  已过时。拼写错误
  
  联合标识是否为空
  
  参数:
  
  unid - 联合标识
  
  返回:
  
  true/false
- equals
```
public static final boolean equals(String id1,
                                   String id2)
```
  比较方法
  
  参数:
  
  id1 - id对象
  
  id2 - id对象
  
  返回:
  
  true/false
- valueOf
```
public static final UniteId valueOf(String uniteid)
```
  转为联合标识对象
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  联合标识对象
- valueOf
```
public static final UniteId valueOf(String ordinal,
                                    String type,
                                    String caption)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  type - 类型名部分
  
  caption - 名称/描述部分
  
  返回:
  
  联合标识
- valueOf
```
public static final UniteId valueOf(String ordinal,
                                    int intOrdinal,
                                    String type,
                                    String caption)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  intOrdinal - 整数序号
  
  type - 类型名部分
  
  caption - 名称/描述部分
  
  返回:
  
  联合标识
- valueOf
```
public static final UniteId valueOf(int ordinal,
                                    String type,
                                    String caption)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  type - 类型名部分
  
  caption - 名称/描述部分
  
  返回:
  
  联合标识
- valueOf
```
public static final UniteId valueOf(String ordinal,
                                    Class<?> type)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  type - 对象类
  
  返回:
  
  联合标识
- valueOf
```
public static final UniteId valueOf(String ordinal,
                                    int intOrdinal,
                                    Class<?> type)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  intOrdinal - 整数序号
  
  type - 对象类
  
  返回:
  
  联合标识
- valueOf
```
public static final UniteId valueOf(int ordinal,
                                    Class<?> type)
```
  转为联合标识对象
  
  参数:
  
  ordinal - 序号部分
  
  type - 对象类
  
  返回:
  
  联合标识
- getUniteId
```
public static final String getUniteId(String type,
                                      int ordinal)
```
  由类型及数值序号组成联合标识串
  
  参数:
  
  type - 类型
  
  ordinal - 序号
  
  返回:
  
  标识串
- getUniteId
```
public static final String getUniteId(Class<?> type,
                                      int ordinal)
```
  由类型及数值序号组成联合标识串
  
  参数:
  
  type - 类型
  
  ordinal - 序号
  
  返回:
  
  标识串
- getUniteId
```
public static final String getUniteId(Class<?> type,
                                      String ordinal)
```
  由类型及序号组成联合标识串
  
  参数:
  
  type - 类型
  
  ordinal - 序号
  
  返回:
  
  标识串
- getUniteId
```
public static final String getUniteId(int ordinal,
                                      String caption)
```
  由数值序号及名称/说明组成联合标识串
  
  参数:
  
  ordinal - 序号
  
  caption - 说明
  
  返回:
  
  标识串
- getUniteId
```
public static final String getUniteId(int ordinal,
                                      String caption,
                                      String type)
```
  由数值序号、名称/说明及类型组成联合标识串
  
  参数:
  
  ordinal - 序号
  
  caption - 说明
  
  type - 类型
  
  返回:
  
  标识串
- getUniteId
```
public static final String getUniteId(String ordinal,
                                      String caption,
                                      String type)
```
  由序号、名称/说明及类型组成联合标识串
  
  参数:
  
  ordinal - 序号
  
  caption - 说明
  
  type - 类型
  
  返回:
  
  标识串
- getType
```
public static final String getType(String uniteid)
```
  取得类型部分
  
  参数:
  
  uniteid - 联合id
  
  返回:
  
  标识串
- getType
```
public static final String getType(Class<?> classOf)
```
  由对象类型取得类型名
  
  参数:
  
  classOf - 类
  
  返回:
  
  类型
- getId
```
public static final String getId(String uniteid)
```
  返回序号及类型部分的标识串（不包含名称/描述部分），与getUuid()方法等同
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  标识串
- getUuid
```
public static final String getUuid(String uniteid)
```
  返回序号及类型部分的标识串（不包含名称/描述部分），与getId()方法等同
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  标识串
- getIntOrdinal
```
public static final int getIntOrdinal(String uniteid)
```
  取得序号部分（数值型）
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  数值型
- getOrdinal
```
public static final String getOrdinal(String uniteid)
```
  只返回序号部分
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  标识串
- getCaption
```
public static final String getCaption(String uniteid)
```
  取得名称/说明部分
  
  参数:
  
  uniteid - 联合标识串
  
  返回:
  
  名称
- fixId
```
public static final UniteId fixId(String unitid,
                                  Class<?> clazz)
```
  修正标识串为只有ID部分（类型及序号），若没有类型部分则把type补充上去
  
  参数:
  
  unitid - 标识串
  
  clazz - 类型
  
  返回:
  
  调整后的联合标识
- fixId
```
public static final UniteId fixId(String unitid,
                                  String type)
```
  修正标识串为只有ID部分（类型及序号），若没有类型部分则把type补充上去
  
  参数:
  
  unitid - 标识串
  
  type - 类型名
  
  返回:
  
  调整后的联合标识
- changeType
```
public static final String changeType(String uniteid,
                                      String type)
```
  替换类型部分（若标识串中有的话）
  
  参数:
  
  uniteid - 联合标识串
  
  type - 类型
  
  返回:
  
  替换后的联合标识串
- changeType
```
public static final String changeType(String ordinal,
                                      Class<?> type)
```
  替换类型部分（若标识串中有的话）
  
  参数:
  
  ordinal - 序号
  
  type - 对象类
  
  返回:
  
  替换后的联合标识串
- escapeOrdinal
```
public static final String escapeOrdinal(String ordinal)
```
  编码序号中可能存在的分隔符
  
  参数:
  
  ordinal - 编码前的序号
  
  返回:
  
  编码后的序号
  
  另请参阅:
  
  unescapeOrdinal(String)
- unescapeOrdinal
```
public static final String unescapeOrdinal(String ordinal)
```
  还原序号中可能存在的分隔符
  
  参数:
  
  ordinal - 编码后的序号
  
  返回:
  
  解码后的序号
  
  另请参阅:
  
  escapeOrdinal(String)
- getSimpleName
```
public static final String getSimpleName(Class<?> clazz)
```
  取得类用于标识/映射对象的短名（主要代替Class.getSimpleName，性能高于其将近10倍）
  
  参数:
  
  clazz - 类，如 UniteId
  
  返回:
  
  短名，如 UniteId
- toString
```
public String toString()
```
  覆盖:
  
  toString 在类中 cn.weforward.common.UniteId
- stringValue
```
public String stringValue()
```
  覆盖:
  
  stringValue 在类中 cn.weforward.common.UniteId
- equals
```
public boolean equals(Object obj)
```
  覆盖:
  
  equals 在类中 cn.weforward.common.UniteId

类 UniteId

字段概要

从类继承的字段 cn.weforward.common.UniteId

构造器概要

方法概要

从类继承的方法 cn.weforward.common.UniteId

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

字段详细资料

_nil

构造器详细资料

UniteId

UniteId

UniteId

方法详细资料

changeType

changeType

changeCaption

isEmpty

isEmtpy

equals

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

getUniteId

getUniteId

getUniteId

getUniteId

getUniteId

getUniteId

getType

getType

getId

getUuid

getIntOrdinal

getOrdinal

getCaption

fixId

fixId

changeType

changeType

escapeOrdinal

unescapeOrdinal

getSimpleName

toString

stringValue

equals