模块 iofairy.functional

程序包 com.iofairy.si

类 SI

java.lang.Object

com.iofairy.si.SI

public class SI
extends Object

String Interpolator. It's not thread-safe.
字符串插值器（非线程安全）

从以下版本开始:

0.0.1

嵌套类概要

嵌套类

限定符和类型	类	说明
(专用程序包) static class	SI.LRUCache<K,V>	Simple LRU Cache, this implementation is not synchronized and not thread-safe.

字段概要

字段

限定符和类型	字段	说明
private static int	CACHE_SIZE
private boolean	enableSIInValues	是否在 valueMap 的值中开启嵌套插值（enableSIInVariables 为 true 时才有效）
private boolean	enableSIInVariables	是否开启嵌套插值
private boolean	enableUndefinedVariableException	是否抛出异常，当 valueMap 中不存在指定的变量
private static Map<String,String>	KEY_CACHE
private static int	KEY_CACHE_SIZE
private static String	MSG_UNEXPECTED_PARAM
private static int	NESTED_CACHE_SIZE
private static Map<String,List<Object>>	NESTED_TEMPLATE_CACHE
private static Map<String,List<StringToken>>	TEMPLATE_CACHE
private Map<String,Object>	valueMap

构造器概要

构造器

构造器	说明
SI()
SI(Tuple... tuples)
SI(Map<String,?> valueMap)

方法概要

限定符和类型	方法	说明
String	$(CharSequence source)	Interpolating for strings. 执行插值程序，解析字符串
static String	$(CharSequence source, Object... arguments)	Interpolating for strings. 字符串插值
SI	add(Tuple... tuples)
SI	add(Object... kvs)	Add key-value pairs to this SI object.
SI	add(Map<String,?> valueMap)
private void	checkCyclic(String variable, List<String> variablesStack, String source)	Check for circular references when inspecting string interpolation.
SI	del(String... keys)
SI	fill(Object... kvs)	Fill key-value pairs to this SI object.
private static List<Object>	getNestedTokens(String source)
private static List<StringToken>	getTokens(String source)
Map<String,Object>	getValueMap()
static SI	init(Object... kvs)	Instantiate an SI object by key-value pairs, and key must be end with " ->" or " >>>" or " >>", and key will be removed leading and trailing whitespace.
private Object	interpolate(String source, NestedStringToken nestedToken, List<String> variablesStack)	字符串插值处理
boolean	isEnableSIInValues()
boolean	isEnableSIInVariables()
boolean	isEnableUndefinedVariableException()
static SI	load(Object... kvs)	Instantiate an SI object by key-value pairs, and key must be end with " ->" or " >>>" or " >>".
static SI	of(Tuple... tuples)
static SI	of(Object... kvs)	Instantiate an SI object by key-value pairs.
static SI	of(Map<String,?> map)
SI	set(Tuple... tuples)
SI	set(Object... kvs)	Reset this SI object with key-value pairs.
SI	set(Map<String,?> valueMap)
SI	setEnableNestedSI(boolean enableNestedSI)
SI	setEnableSIInValues(boolean enableSIInValues)
SI	setEnableSIInVariables(boolean enableSIInVariables)
SI	setEnableUndefinedVariableException(boolean enableUndefinedVariableException)
private static Map<String,Object>	toMap(boolean withSuffix, boolean needTrim, Object... kvs)
String	toString()
private String	traverseInterpolation(String source, List<String> variablesStack, List<Object> tokens)	遍历token进行字符串插值
private void	tuplesPutToMap(Tuple... tuples)
private static void	verifyPairWithStringKey(Object... kvs)

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

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

字段详细资料

CACHE_SIZE

private static final int CACHE_SIZE

另请参阅:

常量字段值

NESTED_CACHE_SIZE

private static final int NESTED_CACHE_SIZE

另请参阅:

常量字段值

KEY_CACHE_SIZE

private static final int KEY_CACHE_SIZE

另请参阅:

常量字段值

TEMPLATE_CACHE

private static final Map<String,List<StringToken>> TEMPLATE_CACHE

NESTED_TEMPLATE_CACHE

private static final Map<String,List<Object>> NESTED_TEMPLATE_CACHE

KEY_CACHE

private static final Map<String,String> KEY_CACHE

valueMap

private final Map<String,Object> valueMap

enableSIInVariables

private boolean enableSIInVariables

是否开启嵌套插值

enableSIInValues

private boolean enableSIInValues

是否在 valueMap 的值中开启嵌套插值（enableSIInVariables 为 true 时才有效）

enableUndefinedVariableException

private boolean enableUndefinedVariableException

是否抛出异常，当 valueMap 中不存在指定的变量

MSG_UNEXPECTED_PARAM

private static final String MSG_UNEXPECTED_PARAM

另请参阅:

常量字段值

构造器详细资料

SI

public SI()

SI

public SI(Tuple... tuples)

SI

public SI(Map<String,?> valueMap)

方法详细资料

of

public static SI of(Tuple... tuples)

of

public static SI of(Map<String,?> map)

of

public static SI of(Object... kvs)

Instantiate an SI object by key-value pairs.

参数:

kvs - key-value pairs

返回:

SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

UnexpectedParameterException - if the key is not end with " ->" or " >>>" or " >>".

从以下版本开始:

0.0.1

init

public static SI init(Object... kvs)

Instantiate an SI object by key-value pairs, and key must be end with " ->" or " >>>" or " >>", and key will be removed leading and trailing whitespace.
Examples:

 String infoTemplate = "ip: ${ip}---port: ${port}---db: ${db}---otherInfo: ${other_info}";

 SI si = SI.init("         ip ->", "127.0.0.1",
                 "         db ->", "testdb",
                 "       port ->", 3306,
                 "     dbType ->", "mysql",
                 " other_info ->", Tuple.of("isCluster", true),
                 "description ->", new Object());

 String dbInfo = si.$(infoTemplate);
 

参数:

kvs - key-value pairs

返回:

SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

UnexpectedParameterException - if the key is not end with " ->" or " >>>" or " >>".

从以下版本开始:

0.0.1

load

public static SI load(Object... kvs)

Instantiate an SI object by key-value pairs, and key must be end with " ->" or " >>>" or " >>".
Examples:

 SI si = SI.load("ip ->", "127.0.0.1",
                 "port ->", 3306,
                 "db ->", "testdb",
                 "dbType ->", "mysql",
                 "other_info ->", Tuple.of("isCluster", true),
                 "description ->", new Object());

  String dbInfo = si.$("ip: ${ip}---port: ${port}---db: ${db}---otherInfo: ${other_info}");
 

参数:

kvs - key-value pairs

返回:

SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

UnexpectedParameterException - if the key is not end with " ->" or " >>>" or " >>".

从以下版本开始:

0.0.1

add

public SI add(Tuple... tuples)

add

public SI add(Map<String,?> valueMap)

add

public SI add(Object... kvs)

Add key-value pairs to this SI object.

参数:

kvs - key-value pairs

返回:

this SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

从以下版本开始:

0.0.1

fill

public SI fill(Object... kvs)

Fill key-value pairs to this SI object. And key must be end with " ->" or " >>>" or " >>", and key will be removed leading and trailing whitespace.
Examples:

 String infoTemplate = "ip: ${ip}---port: ${port}---db: ${db}---otherInfo: ${other_info}";
 SI si = SI.of();
 si.fill("         ip ->", "127.0.0.1",
         "         db ->", "testdb",
         "       port ->", 3306,
         "     dbType ->", "mysql",
         " other_info ->", Tuple.of("isCluster", true),
         "description ->", new Object());

 String dbInfo = si.$(infoTemplate);
 

参数:

kvs - key-value pairs

返回:

this SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

UnexpectedParameterException - if the key is not end with " ->" or " >>>" or " >>".

从以下版本开始:

0.0.1

set

public SI set(Tuple... tuples)

set

public SI set(Map<String,?> valueMap)

set

public SI set(Object... kvs)

Reset this SI object with key-value pairs.

参数:

kvs - key-value pairs

返回:

this SI object

抛出:

RuntimeException - if the kvs length not be even.

NullPointerException - if the key is null.

ClassCastException - if the key is not String.

从以下版本开始:

0.0.1

del

public SI del(String... keys)

tuplesPutToMap

private void tuplesPutToMap(Tuple... tuples)

$

public String $(CharSequence source)

Interpolating for strings.
执行插值程序，解析字符串

参数:

source - source string

返回:

string that has been processed

抛出:

CircularReferencesException - when the circular reference occurs

UndefinedVariableException - No variable was found during string interpolation when enableUndefinedVariableException is true.

从以下版本开始:

0.0.1

interpolate

private Object interpolate(String source,
                           NestedStringToken nestedToken,
                           List<String> variablesStack)

字符串插值处理

参数:

source - 原始字符串

nestedToken - nestedToken

variablesStack - 变量栈

返回:

插值后的字符串

从以下版本开始:

0.4.0

traverseInterpolation

private String traverseInterpolation(String source,
                                     List<String> variablesStack,
                                     List<Object> tokens)

遍历token进行字符串插值

参数:

source - 原始字符串

variablesStack - 变量栈

tokens - tokens

返回:

插值后的字符串

从以下版本开始:

0.4.0

checkCyclic

private void checkCyclic(String variable,
                         List<String> variablesStack,
                         String source)

Check for circular references when inspecting string interpolation.
检查字符串插值时是否有存在循环引用

参数:

variable - 当前检查的变量

variablesStack - 变量栈

source - 原始字符串

从以下版本开始:

0.4.0

getNestedTokens

private static List<Object> getNestedTokens(String source)

$

public static String $(CharSequence source,
                       Object... arguments)

Interpolating for strings.
字符串插值

参数:

source - source string

arguments - arguments

返回:

string that has been processed

从以下版本开始:

0.3.3

getTokens

private static List<StringToken> getTokens(String source)

getValueMap

public Map<String,Object> getValueMap()

toMap

private static Map<String,Object> toMap(boolean withSuffix,
                                        boolean needTrim,
                                        Object... kvs)

verifyPairWithStringKey

private static void verifyPairWithStringKey(Object... kvs)

toString

public String toString()

覆盖:

toString 在类中 Object

isEnableSIInVariables

public boolean isEnableSIInVariables()

setEnableSIInVariables

public SI setEnableSIInVariables(boolean enableSIInVariables)

isEnableSIInValues

public boolean isEnableSIInValues()

setEnableSIInValues

public SI setEnableSIInValues(boolean enableSIInValues)

setEnableNestedSI

public SI setEnableNestedSI(boolean enableNestedSI)

isEnableUndefinedVariableException

public boolean isEnableUndefinedVariableException()

setEnableUndefinedVariableException

public SI setEnableUndefinedVariableException(boolean enableUndefinedVariableException)