cn.ujava.common.text.placeholder

枚举 StrTemplate.Feature

java.lang.Object

java.lang.Enum<StrTemplate.Feature>

cn.ujava.common.text.placeholder.StrTemplate.Feature

所有已实现的接口:

Serializable, Comparable<StrTemplate.Feature>

封闭类:

StrTemplate

public static enum StrTemplate.Feature
extends Enum<StrTemplate.Feature>

格式化 和 解析 策略

同组内的策略是互斥的，一但设置为组内的某个新策略，就会清除之前的同组策略，仅保留新策略

枚举常量概要

枚举常量

枚举常量和说明
FORMAT_MISSING_KEY_PRINT_DEFAULT_VALUE 格式化时，如果 占位符 没有 对应的值，则打印 默认值，如果 没有默认值，则抛出异常
FORMAT_MISSING_KEY_PRINT_EMPTY 格式化时，如果 占位符 没有 对应的值，则打印 空字符串 该策略意味着 模板存在默认值，且为 空字符串
FORMAT_MISSING_KEY_PRINT_NULL 格式化时，如果 占位符 没有 对应的值，且没有默认值，则打印 "null"字符串
FORMAT_MISSING_KEY_PRINT_VARIABLE_NAME 格式化时，如果 占位符 没有 对应的值： 对于 单个占位符，例如"?"
FORMAT_MISSING_KEY_PRINT_WHOLE_PLACEHOLDER 格式化时，如果 占位符 没有 对应的值，则打印完整占位符 对于 变量占位符，例如"${name}"，原样打印"${name}" 默认策略
FORMAT_MISSING_KEY_THROWS 格式化时，如果 占位符 没有 对应的值，则抛出异常
FORMAT_NULL_VALUE_TO_DEFAULT_VALUE 格式化时，如果 占位符 对应的值为 null，则使用 默认值，如果 没有默认值，则抛出异常
FORMAT_NULL_VALUE_TO_EMPTY 格式化时，如果 占位符 对应的值为 null，则打印 "" 空字符串
FORMAT_NULL_VALUE_TO_STR 格式化时，如果 占位符 对应的值为 null，则打印 "null" 字符串 默认策略
FORMAT_NULL_VALUE_TO_WHOLE_PLACEHOLDER 格式化时，如果 占位符 对应的值为 null，则原样打印占位符 对于 变量占位符，输出完整占位符，例如"${name}"，打印"${name}"
MATCH_DEFAULT_VALUE_TO_NULL 解析时，在 结果中 将 默认值 转为 null 返回的结果 map 中 包含 这个key
MATCH_EMPTY_VALUE_TO_DEFAULT_VALUE 解析时，占位符 对应的值为 空字符串，将 这个空字符串 转为 默认值，如果 没有默认值，则转为 null
MATCH_EMPTY_VALUE_TO_NULL 解析时，占位符 对应的值为 空字符串，将 这个空字符串 转为 null 默认策略
MATCH_IGNORE_DEFAULT_VALUE 解析时，结果中 不包含 默认值，只要等于默认值，都忽略 即，返回的结果 map 中 不会包含 这个key 在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的
MATCH_IGNORE_EMPTY_VALUE 解析时，占位符 对应的值为 空字符串，结果中 不包含 这个空字符串 即，返回的结果 map 中 不会包含 这个key 在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的
MATCH_IGNORE_NULL_STR 解析时，占位符 对应的值为 "null" 字符串，结果中 不包含 这个值 即，返回的结果 map 中 不会包含 这个key 在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的
MATCH_KEEP_DEFAULT_VALUE 解析时，结果中 包含 默认值，原样返回 默认策略
MATCH_KEEP_NULL_STR 解析时，占位符 对应的值为 "null" 字符串，在 结果中 保留字符串形式 "null"
MATCH_KEEP_VALUE_EMPTY 解析时，占位符 对应的值为 空字符串，结果中 依然保留 这个空字符串
MATCH_NULL_STR_TO_NULL 解析时，占位符 对应的值为 "null" 字符串，在 结果中 转为 null 默认策略

方法概要

限定符和类型	方法和说明
int	clear(int features) 在 策略值 中移除 当前策略
boolean	contains(int features) 是否为当前策略
static int	of(StrTemplate.Feature... features) 计算 总的策略值
int	set(int features) 在 策略值 中添加 当前策略
static StrTemplate.Feature	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static StrTemplate.Feature[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

FORMAT_MISSING_KEY_PRINT_WHOLE_PLACEHOLDER

public static final StrTemplate.Feature FORMAT_MISSING_KEY_PRINT_WHOLE_PLACEHOLDER

格式化时，如果 占位符 没有 对应的值，则打印完整占位符
对于 变量占位符，例如"${name}"，原样打印"${name}"

默认策略

FORMAT_MISSING_KEY_PRINT_DEFAULT_VALUE

public static final StrTemplate.Feature FORMAT_MISSING_KEY_PRINT_DEFAULT_VALUE

格式化时，如果 占位符 没有 对应的值，则打印 默认值，如果 没有默认值，则抛出异常

FORMAT_MISSING_KEY_PRINT_NULL

public static final StrTemplate.Feature FORMAT_MISSING_KEY_PRINT_NULL

格式化时，如果 占位符 没有 对应的值，且没有默认值，则打印 "null"字符串

FORMAT_MISSING_KEY_PRINT_EMPTY

public static final StrTemplate.Feature FORMAT_MISSING_KEY_PRINT_EMPTY

格式化时，如果 占位符 没有 对应的值，则打印 空字符串

该策略意味着 模板存在默认值，且为 空字符串

FORMAT_MISSING_KEY_PRINT_VARIABLE_NAME

public static final StrTemplate.Feature FORMAT_MISSING_KEY_PRINT_VARIABLE_NAME

格式化时，如果 占位符 没有 对应的值：
对于 单个占位符，例如"?"，打印完整占位符"?";
对于 变量占位符，则只打印占位变量，例如"${name}"，只打印"name";

FORMAT_MISSING_KEY_THROWS

public static final StrTemplate.Feature FORMAT_MISSING_KEY_THROWS

格式化时，如果 占位符 没有 对应的值，则抛出异常

FORMAT_NULL_VALUE_TO_STR

public static final StrTemplate.Feature FORMAT_NULL_VALUE_TO_STR

格式化时，如果 占位符 对应的值为 null，则打印 "null" 字符串

默认策略

FORMAT_NULL_VALUE_TO_EMPTY

public static final StrTemplate.Feature FORMAT_NULL_VALUE_TO_EMPTY

格式化时，如果 占位符 对应的值为 null，则打印 "" 空字符串

FORMAT_NULL_VALUE_TO_WHOLE_PLACEHOLDER

public static final StrTemplate.Feature FORMAT_NULL_VALUE_TO_WHOLE_PLACEHOLDER

格式化时，如果 占位符 对应的值为 null，则原样打印占位符
对于 变量占位符，输出完整占位符，例如"${name}"，打印"${name}"

FORMAT_NULL_VALUE_TO_DEFAULT_VALUE

public static final StrTemplate.Feature FORMAT_NULL_VALUE_TO_DEFAULT_VALUE

格式化时，如果 占位符 对应的值为 null，则使用 默认值，如果 没有默认值，则抛出异常

MATCH_KEEP_DEFAULT_VALUE

public static final StrTemplate.Feature MATCH_KEEP_DEFAULT_VALUE

解析时，结果中 包含 默认值，原样返回

默认策略

MATCH_IGNORE_DEFAULT_VALUE

public static final StrTemplate.Feature MATCH_IGNORE_DEFAULT_VALUE

解析时，结果中 不包含 默认值，只要等于默认值，都忽略

即，返回的结果 map 中 不会包含 这个key

在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的

MATCH_DEFAULT_VALUE_TO_NULL

public static final StrTemplate.Feature MATCH_DEFAULT_VALUE_TO_NULL

解析时，在 结果中 将 默认值 转为 null

返回的结果 map 中 包含 这个key

MATCH_EMPTY_VALUE_TO_NULL

public static final StrTemplate.Feature MATCH_EMPTY_VALUE_TO_NULL

解析时，占位符 对应的值为 空字符串，将 这个空字符串 转为 null

默认策略

MATCH_EMPTY_VALUE_TO_DEFAULT_VALUE

public static final StrTemplate.Feature MATCH_EMPTY_VALUE_TO_DEFAULT_VALUE

解析时，占位符 对应的值为 空字符串，将 这个空字符串 转为 默认值，如果 没有默认值，则转为 null

MATCH_IGNORE_EMPTY_VALUE

public static final StrTemplate.Feature MATCH_IGNORE_EMPTY_VALUE

解析时，占位符 对应的值为 空字符串，结果中 不包含 这个空字符串

即，返回的结果 map 中 不会包含 这个key

在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的

MATCH_KEEP_VALUE_EMPTY

public static final StrTemplate.Feature MATCH_KEEP_VALUE_EMPTY

解析时，占位符 对应的值为 空字符串，结果中 依然保留 这个空字符串

MATCH_NULL_STR_TO_NULL

public static final StrTemplate.Feature MATCH_NULL_STR_TO_NULL

解析时，占位符 对应的值为 "null" 字符串，在 结果中 转为 null

默认策略

MATCH_KEEP_NULL_STR

public static final StrTemplate.Feature MATCH_KEEP_NULL_STR

解析时，占位符 对应的值为 "null" 字符串，在 结果中 保留字符串形式 "null"

MATCH_IGNORE_NULL_STR

public static final StrTemplate.Feature MATCH_IGNORE_NULL_STR

解析时，占位符 对应的值为 "null" 字符串，结果中 不包含 这个值

即，返回的结果 map 中 不会包含 这个key

在 基于下标的解析方法中 不生效，基于下标的解析结果只区分是否为 null，元素数量是固定的

方法详细资料

values

public static StrTemplate.Feature[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (StrTemplate.Feature c : StrTemplate.Feature.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static StrTemplate.Feature valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

contains

public boolean contains(int features)

是否为当前策略

参数:

features - 外部的策略值

返回:

是否为当前策略

set

public int set(int features)

在 策略值 中添加 当前策略

参数:

features - 外部的策略值

返回:

添加后的策略值

clear

public int clear(int features)

在 策略值 中移除 当前策略

参数:

features - 外部的策略值

返回:

移除后的策略值

of

public static int of(StrTemplate.Feature... features)

计算 总的策略值

参数:

features - 策略枚举数组

返回:

总的策略值