S (Functional Programming for Java 0.3.12 API)

java.lang.Object
- com.iofairy.top.S

```
public final class S
extends Object
```
Global Variables And Methods for String Operations.
字符串相关操作的常用变量与函数。
>>>>>>
采用简单类名 S (String) 模拟类似 Kotlin 的 Top-level function（顶级函数、全局函数）

从以下版本开始:

0.3.0

构造器概要

构造器
构造器说明

S()

构造器
构造器	说明
`S()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法	说明
`static boolean`	`allBlank(CharSequence... css)`	`true` if all array values are `null` or empty `""` or blank or CharSequence array is `null`.
`static boolean`	`allBlank(List<? extends CharSequence> css)`	`true` if all List values are `null` or empty `""` or blank or CharSequence List is `null`.
`static boolean`	`allEmpty(CharSequence... css)`	`true` if all array values are `null` or empty `""` value or CharSequence array is `null`.
`static boolean`	`allEmpty(List<? extends CharSequence> css)`	`true` if all List values are `null` or empty `""` value or CharSequence List is `null`.
`static String`	`blankToEmpty(String s)`	Returns itself if string is non-blank; otherwise, returns empty(`""`).
`static String`	`blankToNull(String s)`	Returns itself if string is non-blank; otherwise, returns `null`.
`static int`	`countChars(CharSequence str, char c)`	Counts how many times the char occurrences in the given string.
`static int[]`	`countMultiChars(CharSequence str, char... cs)`	Counts how many times the char in char array occurrences in the given string.
`static int[]`	`countMultiChars(CharSequence str, CharSequence chars)`	Counts how many times the char in `CharSequence` occurrences in the given string.
`static String`	`emptyToNull(String s)`	Returns itself if string is non-empty; otherwise, returns `null`.
`static String`	`enclose(String enclosedStr, char encloseChar)`	Using char to enclose a String
`static String`	`enclose(String enclosedStr, char encloseChar1, char encloseChar2)`	Using two chars to enclose a String
`static String`	`enclose(String enclosedStr, String encloseStr)`	Using string to enclose a String
`static String`	`enclose(String enclosedStr, String encloseStr1, String encloseStr2)`	Using two strings to enclose a String
`static boolean`	`endsWith(String str, String suffix, int offsetFromEnd)`	Tests if the given string ends with the specified suffix, when compared starting from the specified offset from the end of the string.
`static boolean`	`hasBlank(CharSequence... css)`	Whether CharSequence array contains `null` or empty `""` or blank or CharSequence array is `null`.
`static boolean`	`hasBlank(List<? extends CharSequence> css)`	Whether CharSequence List contains `null` or empty `""` or blank or CharSequence List is `null`.
`static boolean`	`hasEmpty(CharSequence... css)`	Whether CharSequence array contains `null` or empty `""` or CharSequence array is `null`.
`static boolean`	`hasEmpty(List<? extends CharSequence> css)`	Whether CharSequence List contains `null` or empty `""` or CharSequence List is `null`.
`static int`	`indexOf(String source, String subStr, int appearanceOrder)`	The index within this string of the specified occurrence order of the specified substring.
`static boolean`	`isBlank(CharSequence cs)`	`true` if all chars in CharSequence are whitespace `Character.isWhitespace(char)`.
`static boolean`	`isBlankChar(char c)`
`static boolean`	`isBlankChar(int c)`
`static boolean`	`isEmpty(CharSequence cs)`
`static String`	`nullToEmpty(String s)`	Returns itself if string is non-null; otherwise, returns empty(`""`).
`static String`	`padLeftChars(CharSequence cs, char padChar, int length)`	Padding chars to the left of the input char sequence to the given length.
`static String`	`padLeftChars(Number number, char padChar, int length)`	Padding chars to the left of the input number to the given length.
`static Tuple2<String,String>`	`splitOnce(String source, String delimiter)`	Split by the place where the delimiter first appears, only split once.
`static String`	`trim(String str, String trimHeadStr, String trimTailStr)`	Trims the string and returns a string that does not start with `trimHeadStr` and does not end with `trimTailStr`.
`static String`	`trim(String str, String trimHeadStr, String trimTailStr, boolean isTrimHeadFirst)`	Trims the string and returns a string that does not start with `trimHeadStr` and does not end with `trimTailStr`.
`static String`	`trimOnce(String str, String trimHeadStr, String trimTailStr)`	Trim the given string once with the specified header string and tail string.
`static String`	`trimOnce(String str, String trimHeadStr, String trimTailStr, boolean isTrimHeadFirst)`	Trim the given string once with the specified header string and tail string.

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

- 构造器详细资料
  - S
```
public S()
```
- 方法详细资料
  - hasEmpty
```
public static boolean hasEmpty(CharSequence... css)
```
    Whether CharSequence array contains null or empty "" or CharSequence array is null.
    Especially, when length of CharSequence array is 0 (css.length == 0), return true.
    数组中包含null值或者空字符串""或者CharSequence数组本身就为null，则返回true。 特别地，当数组本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence array
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.0.1
  - allEmpty
```
public static boolean allEmpty(CharSequence... css)
```
    true if all array values are null or empty "" value or CharSequence array is null.
    Especially, when length of CharSequence array is 0 (css.length == 0), return true.
    数组中所有的值都是null或者空字符串""或者CharSequence数组本身就为null，则返回true。 特别地，当数组本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence array
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.0.1
  - hasBlank
```
public static boolean hasBlank(CharSequence... css)
```
    Whether CharSequence array contains null or empty "" or blank or CharSequence array is null.
    Especially, when length of CharSequence array is 0 (css.length == 0), return true.
    数组中包含null值或空字符串""或空白字符串或CharSequence数组本身就为null，则返回true。 特别地，当数组本身长度等于0时，也返回true。
    
    参数:
    
    css - string array
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.0.1
    
    另请参阅:
    
    isBlank(CharSequence)
  - allBlank
```
public static boolean allBlank(CharSequence... css)
```
    true if all array values are null or empty "" or blank or CharSequence array is null.
    Especially, when length of CharSequence array is 0 (css.length == 0), return true.
    数组中所有的值都是null或空字符串""或空白字符串或CharSequence数组本身就为null，则返回true。 特别地，当数组本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence array
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.0.1
    
    另请参阅:
    
    isBlank(CharSequence)
  - hasEmpty
```
public static boolean hasEmpty(List<? extends CharSequence> css)
```
    Whether CharSequence List contains null or empty "" or CharSequence List is null.
    Especially, when length of CharSequence List is 0 (css.length == 0), return true.
    列表中包含null值或者空字符串""或者CharSequence列表本身就为null，则返回true。 特别地，当列表本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence List
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.3.0
  - allEmpty
```
public static boolean allEmpty(List<? extends CharSequence> css)
```
    true if all List values are null or empty "" value or CharSequence List is null.
    Especially, when length of CharSequence List is 0 (css.length == 0), return true.
    列表中所有的值都是null或者空字符串""或者CharSequence列表本身就为null，则返回true。 特别地，当列表本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence List
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.3.0
  - hasBlank
```
public static boolean hasBlank(List<? extends CharSequence> css)
```
    Whether CharSequence List contains null or empty "" or blank or CharSequence List is null.
    Especially, when length of CharSequence List is 0 (css.length == 0), return true.
    列表中包含null值或空字符串""或空白字符串或CharSequence列表本身就为null，则返回true。 特别地，当列表本身长度等于0时，也返回true。
    
    参数:
    
    css - string List
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.3.0
    
    另请参阅:
    
    isBlank(CharSequence)
  - allBlank
```
public static boolean allBlank(List<? extends CharSequence> css)
```
    true if all List values are null or empty "" or blank or CharSequence List is null.
    Especially, when length of CharSequence List is 0 (css.length == 0), return true.
    列表中所有的值都是null或空字符串""或空白字符串或CharSequence列表本身就为null，则返回true。 特别地，当列表本身长度等于0时，也返回true。
    
    参数:
    
    css - CharSequence List
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.3.0
    
    另请参阅:
    
    isBlank(CharSequence)
  - isBlank
```
public static boolean isBlank(CharSequence cs)
```
    true if all chars in CharSequence are whitespace Character.isWhitespace(char).
    字符序列中的所有字符都是空白字符，则返回true。
    
    参数:
    
    cs - CharSequence
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    0.0.1
  - isBlankChar
```
public static boolean isBlankChar(char c)
```
  - isBlankChar
```
public static boolean isBlankChar(int c)
```
  - isEmpty
```
public static boolean isEmpty(CharSequence cs)
```
  - nullToEmpty
```
public static String nullToEmpty(String s)
```
    Returns itself if string is non-null; otherwise, returns empty("").
    
    参数:
    
    s - string
    
    返回:
    
    itself or empty("")
  - emptyToNull
```
public static String emptyToNull(String s)
```
    Returns itself if string is non-empty; otherwise, returns null.
    
    参数:
    
    s - string
    
    返回:
    
    itself or null
  - blankToNull
```
public static String blankToNull(String s)
```
    Returns itself if string is non-blank; otherwise, returns null.
    
    参数:
    
    s - string
    
    返回:
    
    itself or null
  - blankToEmpty
```
public static String blankToEmpty(String s)
```
    Returns itself if string is non-blank; otherwise, returns empty("").
    
    参数:
    
    s - string
    
    返回:
    
    itself or empty("").
  - padLeftChars
```
public static String padLeftChars(CharSequence cs,
                                  char padChar,
                                  int length)
```
    Padding chars to the left of the input char sequence to the given length.
    在字符串左侧添加字符以达到给定的长度
    
    参数:
    
    cs - input char sequence
    
    padChar - pad char
    
    length - final length of returns string
    
    返回:
    
    string
    
    从以下版本开始:
    
    0.3.7
  - padLeftChars
```
public static String padLeftChars(Number number,
                                  char padChar,
                                  int length)
```
    Padding chars to the left of the input number to the given length.
    在数字左侧添加字符以达到给定的长度
    
    参数:
    
    number - input number
    
    padChar - pad char
    
    length - final length of returns string
    
    返回:
    
    string
    
    从以下版本开始:
    
    0.3.7
  - endsWith
```
public static boolean endsWith(String str,
                               String suffix,
                               int offsetFromEnd)
```
    Tests if the given string ends with the specified suffix, when compared starting from the specified offset from the end of the string.
    检查给定的字符串是否以指定的后缀结尾，从字符串末尾的指定偏移量开始比较。
    
    参数:
    
    str - the string to check
    
    suffix - the suffix to check for
    
    offsetFromEnd - the offset from the end of the string to start the comparison from. 从字符串末尾开始的偏移量
    
    返回:
    
    true if the given string ends with the specified suffix, false otherwise
    
    从以下版本开始:
    
    0.3.11
  - trim
```
public static String trim(String str,
                          String trimHeadStr,
                          String trimTailStr)
```
    Trims the string and returns a string that does not start with trimHeadStr and does not end with trimTailStr.
    修剪字符串，并返回不以 trimHeadStr 开头且不以 trimTailStr 结尾的字符串
    
    参数:
    
    str - 待修剪的字符串
    
    trimHeadStr - 修剪头部指定的字符串
    
    trimTailStr - 修剪尾部指定的字符串
    
    返回:
    
    修剪后的字符串
    
    从以下版本开始:
    
    0.3.11
  - trim
```
public static String trim(String str,
                          String trimHeadStr,
                          String trimTailStr,
                          boolean isTrimHeadFirst)
```
    Trims the string and returns a string that does not start with trimHeadStr and does not end with trimTailStr.
    修剪字符串，并返回不以 trimHeadStr 开头且不以 trimTailStr 结尾的字符串
    
    参数:
    
    str - 待修剪的字符串
    
    trimHeadStr - 修剪头部指定的字符串
    
    trimTailStr - 修剪尾部指定的字符串
    
    isTrimHeadFirst - true，先修剪头部，再修剪尾部；false，先修剪尾部，再修剪头部
    
    返回:
    
    修剪后的字符串
    
    从以下版本开始:
    
    0.3.11
  - trimOnce
```
public static String trimOnce(String str,
                              String trimHeadStr,
                              String trimTailStr)
```
    Trim the given string once with the specified header string and tail string.
    使用指定的头部字符串与尾部字符串对给定的字符串修剪一次
    
    参数:
    
    str - 待修剪的字符串
    
    trimHeadStr - 修剪头部指定的字符串
    
    trimTailStr - 修剪尾部指定的字符串
    
    返回:
    
    修剪后的字符串
    
    从以下版本开始:
    
    0.3.11
  - trimOnce
```
public static String trimOnce(String str,
                              String trimHeadStr,
                              String trimTailStr,
                              boolean isTrimHeadFirst)
```
    Trim the given string once with the specified header string and tail string.
    使用指定的头部字符串与尾部字符串对给定的字符串修剪一次
    
    参数:
    
    str - 待修剪的字符串
    
    trimHeadStr - 修剪头部指定的字符串
    
    trimTailStr - 修剪尾部指定的字符串
    
    isTrimHeadFirst - true，先修剪头部，再修剪尾部；false，先修剪尾部，再修剪头部
    
    返回:
    
    修剪后的字符串
    
    从以下版本开始:
    
    0.3.11
  - enclose
```
public static String enclose(String enclosedStr,
                             String encloseStr)
```
    Using string to enclose a String
    
    Examples:
```
 S.enclose("abc", "||");              // returns "||abc||";
 
```
    参数:
    
    enclosedStr - 被包围的字符串
    
    encloseStr - 包围的字符串
    
    返回:
    
    包围后的字符串
    
    从以下版本开始:
    
    0.3.11
  - enclose
```
public static String enclose(String enclosedStr,
                             String encloseStr1,
                             String encloseStr2)
```
    Using two strings to enclose a String
    
    Examples:
```
 S.enclose("abc", ">>", "<<");            // returns ">>abc<<";
 
```
    参数:
    
    enclosedStr - 被包围的字符串
    
    encloseStr1 - 包围的字符串1
    
    encloseStr2 - 包围的字符串2
    
    返回:
    
    包围后的字符串
    
    从以下版本开始:
    
    0.3.11
  - enclose
```
public static String enclose(String enclosedStr,
                             char encloseChar)
```
    Using char to enclose a String
    Examples:
```
 S.enclose("abc", '"');                   // returns "\"abc\"";
 
```
    参数:
    
    enclosedStr - 被包围的字符串
    
    encloseChar - 包围的字符
    
    返回:
    
    包围后的字符串
    
    从以下版本开始:
    
    0.3.11
  - enclose
```
public static String enclose(String enclosedStr,
                             char encloseChar1,
                             char encloseChar2)
```
    Using two chars to enclose a String
    Examples:
```
 S.enclose("abc", '>', '<');              // returns ">abc<";
 
```
    参数:
    
    enclosedStr - 被包围的字符串
    
    encloseChar1 - 包围的字符1
    
    encloseChar2 - 包围的字符2
    
    返回:
    
    包围后的字符串
    
    从以下版本开始:
    
    0.3.11
  - splitOnce
```
public static Tuple2<String,String> splitOnce(String source,
                                              String delimiter)
```
    Split by the place where the delimiter first appears, only split once.
    在分隔符第一次出现的地方切分字符串，将一个字符串分隔成两个字符串
    
    参数:
    
    source - will be split
    
    delimiter - delimiter
    
    返回:
    
    Tuple2<String, String> -- first substring and second substring
    
    从以下版本开始:
    
    0.2.0
  - indexOf
```
public static int indexOf(String source,
                          String subStr,
                          int appearanceOrder)
```
    The index within this string of the specified occurrence order of the specified substring.
    获取指定的子字符串的指定出现次序在原字符串中的位置序号
    
    参数:
    
    source - 原字符串
    
    subStr - 要匹配的子字符串
    
    appearanceOrder - 出现的次序（第几次出现），从 1 开始计数
    
    返回:
    
    index
    
    抛出:
    
    NullPointerException - if source or subStr is null
    
    UnexpectedParameterException - if appearanceOrder less than 1.
    
    从以下版本开始:
    
    0.3.11
  - countChars
```
public static int countChars(CharSequence str,
                             char c)
```
    Counts how many times the char occurrences in the given string.
    
    参数:
    
    str - input string
    
    c - match character
    
    返回:
    
    the number of occurrences
    
    从以下版本开始:
    
    0.3.0
  - countMultiChars
```
public static int[] countMultiChars(CharSequence str,
                                    char... cs)
```
    Counts how many times the char in char array occurrences in the given string.
    Examples:
```
 S.countMultiChars("abc- Defgh_IJ--klm  _nop-", '-', ' ', 'z', '_');    // returns [4, 3, 0, 2];
                                                                        // --------------------
                                                                        // The number of '-': 4
                                                                        // The number of ' ': 3
                                                                        // The number of 'z': 0
                                                                        // The number of '_': 2
 
```
    参数:
    
    str - string
    
    cs - char array
    
    返回:
    
    each char occurrences times
    
    从以下版本开始:
    
    0.3.0
  - countMultiChars
```
public static int[] countMultiChars(CharSequence str,
                                    CharSequence chars)
```
    Counts how many times the char in CharSequence occurrences in the given string.
    Examples:
```
 S.countMultiChars("abc- Defgh_IJ--klm  _nop-", "- z_");    // returns [4, 3, 0, 2];
                                                            // --------------------
                                                            // The number of '-': 4
                                                            // The number of ' ': 3
                                                            // The number of 'z': 0
                                                            // The number of '_': 2
 
```
    参数:
    
    str - string
    
    chars - CharSequence
    
    返回:
    
    each char occurrences times
    
    从以下版本开始:
    
    0.3.0

类 S

构造器概要

方法概要

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

构造器详细资料

S

方法详细资料

hasEmpty

allEmpty

hasBlank

allBlank

hasEmpty

allEmpty

hasBlank

allBlank

isBlank

isBlankChar

isBlankChar

isEmpty

nullToEmpty

emptyToNull

blankToNull

blankToEmpty

padLeftChars

padLeftChars

endsWith

trim

trim

trimOnce

trimOnce

enclose

enclose

enclose

enclose

splitOnce

indexOf

countChars

countMultiChars

countMultiChars