SI (Functional Programming for Java 0.3.12 API)

java.lang.Object
- com.iofairy.si.SI

```
public class SI
extends Object
```
String Interpolator.
字符串插值器

从以下版本开始:

0.0.1

嵌套类概要

嵌套类
限定符和类型类说明

(专用程序包) static class SI.LRUCache<K,V>
Simple LRU Cache, this implementation is not synchronized and not thread-safe.

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

字段概要

字段
限定符和类型	字段	说明
`private static int`	`CACHE_SIZE`
`private static Map<String,String>`	`KEY_CACHE`
`private static int`	`KEY_CACHE_SIZE`
`private static String`	`MSG_UNEXPECTED_PARAM`
`private static Map<String,List<StringToken>>`	`TEMPLATE_CACHE`
`private Map<String,Object>`	`valueMap`

构造器概要

构造器
构造器说明

SI()

SI(Tuple... tuples)

SI(Map<String,?> valueMap)

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`String`	`$(CharSequence source)`	Interpolating for strings. 执行插值程序，解析字符串
`String`	`$(CharSequence source, boolean enableNestedParse)`	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 property, List<String> propertiesStack, List<String> sourceList)`	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<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.
`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)`
`private void`	`splitTokenAndCheckCyclic(List<StringToken> tokens, List<String> propertiesStack, List<String> sourceList)`	分割token及检查是否循环引用
`private static Map<String,Object>`	`toMap(boolean withSuffix, boolean needTrim, Object... kvs)`
`String`	`toString()`
`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
```
    另请参阅:
    
    常量字段值
  - KEY_CACHE_SIZE
```
private static final int KEY_CACHE_SIZE
```
    另请参阅:
    
    常量字段值
  - TEMPLATE_CACHE
```
private static final Map<String,List<StringToken>> TEMPLATE_CACHE
```
  - KEY_CACHE
```
private static final Map<String,String> KEY_CACHE
```
  - valueMap
```
private final Map<String,Object> 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
    
    从以下版本开始:
    
    0.0.1
  - $
```
public String $(CharSequence source,
                boolean enableNestedParse)
```
    Interpolating for strings.
    执行插值程序，解析字符串
    
    参数:
    
    source - source string
    
    enableNestedParse - enable nested parsing or not
    
    返回:
    
    string that has been processed
    
    抛出:
    
    CircularReferencesException - when the circular reference occurs
    
    从以下版本开始:
    
    0.3.12
  - splitTokenAndCheckCyclic
```
private void splitTokenAndCheckCyclic(List<StringToken> tokens,
                                      List<String> propertiesStack,
                                      List<String> sourceList)
```
    分割token及检查是否循环引用
    
    参数:
    
    tokens - 字符串分割的token
    
    propertiesStack - 属性栈
    
    sourceList - 原始字符串多次插值后的数组
    
    从以下版本开始:
    
    0.3.12
  - checkCyclic
```
private void checkCyclic(String property,
                         List<String> propertiesStack,
                         List<String> sourceList)
```
    Check for circular references when inspecting string interpolation.
    检查字符串插值时是否有存在循环引用
    
    参数:
    
    property - 当前检查的属性
    
    propertiesStack - 属性栈
    
    sourceList - 原始字符串多次插值后的数组
    
    从以下版本开始:
    
    0.3.12
  - $
```
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

类 SI

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

CACHE_SIZE

KEY_CACHE_SIZE

TEMPLATE_CACHE

KEY_CACHE

valueMap

MSG_UNEXPECTED_PARAM

构造器详细资料

SI

SI

SI

方法详细资料

of

of

of

init

load

add

add

add

fill

set

set

set

del

tuplesPutToMap

$

$

splitTokenAndCheckCyclic

checkCyclic

$

getTokens

getValueMap

toMap

verifyPairWithStringKey

toString