Strings (milky-common 1.0.1 API)

java.lang.Object
- cn.sliew.milky.common.primitives.Strings

```
public class Strings
extends Object
```

字段概要

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

static String[] EMPTY_ARRAY

字段
限定符和类型	字段和说明
`static String[]`	`EMPTY_ARRAY`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`arrayToCommaDelimitedString(Object[] arr)` Convenience method to return a String array as a CSV String.
`static String`	`arrayToDelimitedString(Object[] arr, String delim)` Convenience method to return a String array as a delimited (e.g.
`static void`	`arrayToDelimitedString(Object[] arr, String delim, StringBuilder sb)`
`static String`	`capitalize(String str)` Capitalize a `String`, changing the first letter to upper case as per `Character.toUpperCase(char)`.
`static String`	`cleanTruncate(String s, int length)` Truncates string to a length less than length.
`static String`	`coalesceToEmpty(String s)`
`static String`	`collectionToCommaDelimitedString(Iterable<?> coll)` Convenience method to return a Collection as a CSV String.
`static String`	`collectionToDelimitedString(Iterable<?> coll, String delim)` Convenience method to return a Collection as a delimited (e.g.
`static String`	`collectionToDelimitedString(Iterable<?> coll, String delim, String prefix, String suffix)` Convenience method to return a Collection as a delimited (e.g.
`static void`	`collectionToDelimitedString(Iterable<?> coll, String delim, String prefix, String suffix, StringBuilder sb)`
`static Set<String>`	`commaDelimitedListToSet(String str)` Convenience method to convert a CSV string list to a set.
`static String[]`	`commaDelimitedListToStringArray(String str)` Convert a CSV list into an array of Strings.
`static String`	`delete(String inString, String pattern)` Delete all occurrences of the given substring.
`static String`	`deleteAny(String inString, String charsToDelete)` Delete any character in a given String.
`static String[]`	`delimitedListToStringArray(String str, String delimiter)` Take a String which is a delimited list and convert it to a String array.
`static String[]`	`delimitedListToStringArray(String str, String delimiter, String charsToDelete)` Take a String which is a delimited list and convert it to a String array.
`static String`	`empty()`
`static String`	`format1Decimals(double value, String suffix)` Format the double value with a single decimal points, trimming trailing '.0'.
`static boolean`	`hasLength(CharSequence str)` Check that the given CharSequence is neither `null` nor of length 0.
`static boolean`	`hasLength(String str)` Check that the given String is neither `null` nor of length 0.
`static boolean`	`hasText(CharSequence str)` Check whether the given CharSequence has actual text.
`static boolean`	`hasText(String str)` Check whether the given String has actual text.
`static boolean`	`isEmpty(CharSequence str)` Check that the given CharSequence is either `null` or of length 0.
`static boolean`	`isNullOrEmpty(String s)`
`static String`	`padStart(String s, int minimumLength, char c)`
`static String`	`quote(String str)` Quote the given String with single quotes.
`static String`	`replace(String inString, String oldPattern, String newPattern)` Replace all occurrences of a substring within a string with another string.
`static void`	`spaceify(int spaces, String from, StringBuilder to)`
`static String[]`	`split(String toSplit, String delimiter)` Split a String at the first occurrence of the delimiter.
`static List<String>`	`splitSmart(String s, String separator, boolean decode)` Splits a backslash escaped string on the separator.
`static String[]`	`splitStringByCommaToArray(String s)` Split the specified string by commas to an array.
`static String`	`substring(String s, int beginIndex, int endIndex)` Return substring(beginIndex, endIndex) that is impervious to string length.
`static boolean`	`substringMatch(CharSequence str, int index, CharSequence substring)` Test whether the given string matches the given substring at the given index.
`static Set<String>`	`tokenizeByCommaToSet(String s)` Tokenize the specified string by commas to a set, trimming whitespace and ignoring empty tokens.
`static String[]`	`tokenizeToStringArray(String s, String delimiters)` Tokenize the given String into a String array via a StringTokenizer.
`static String`	`toLowercaseAscii(String in)`
`static String[]`	`toStringArray(Collection<String> collection)` Copy the given Collection into a String array.
`static String`	`trimLeadingCharacter(String str, char leadingCharacter)` Trim all occurrences of the supplied leading character from the given String.

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

- 字段详细资料
  - EMPTY_ARRAY
```
public static final String[] EMPTY_ARRAY
```
- 方法详细资料
  - empty
```
public static String empty()
```
  - spaceify
```
public static void spaceify(int spaces,
                            String from,
                            StringBuilder to)
                     throws Exception
```
    抛出:
    
    Exception
  - splitSmart
```
public static List<String> splitSmart(String s,
                                      String separator,
                                      boolean decode)
```
    Splits a backslash escaped string on the separator.
    Current backslash escaping supported:
    \n \t \r \b \f are escaped the same as a Java String
    Other characters following a backslash are produced verbatim (\c => c)
    
    参数:
    
    s - the string to split
    
    separator - the separator to split on
    
    decode - decode backslash escaping
  - hasLength
```
public static boolean hasLength(CharSequence str)
```
    Check that the given CharSequence is neither null nor of length 0. Note: Will return true for a CharSequence that purely consists of whitespace.
```
 StringUtils.hasLength(null) = false
 StringUtils.hasLength("") = false
 StringUtils.hasLength(" ") = true
 StringUtils.hasLength("Hello") = true
 
```
    参数:
    
    str - the CharSequence to check (may be null)
    
    返回:
    
    true if the CharSequence is not null and has length
    
    另请参阅:
    
    hasText(String)
  - hasLength
```
public static boolean hasLength(String str)
```
    Check that the given String is neither null nor of length 0. Note: Will return true for a String that purely consists of whitespace.
    
    参数:
    
    str - the String to check (may be null)
    
    返回:
    
    true if the String is not null and has length
    
    另请参阅:
    
    hasLength(CharSequence)
  - isEmpty
```
public static boolean isEmpty(CharSequence str)
```
    Check that the given CharSequence is either null or of length 0. Note: Will return false for a CharSequence that purely consists of whitespace.
```
 StringUtils.isEmpty(null) = true
 StringUtils.isEmpty("") = true
 StringUtils.isEmpty(" ") = false
 StringUtils.isEmpty("Hello") = false
 
```
    参数:
    
    str - the CharSequence to check (may be null)
    
    返回:
    
    true if the CharSequence is either null or has a zero length
  - hasText
```
public static boolean hasText(CharSequence str)
```
    Check whether the given CharSequence has actual text. More specifically, returns true if the string not null, its length is greater than 0, and it contains at least one non-whitespace character.
```
 StringUtils.hasText(null) = false
 StringUtils.hasText("") = false
 StringUtils.hasText(" ") = false
 StringUtils.hasText("12345") = true
 StringUtils.hasText(" 12345 ") = true
 
```
    参数:
    
    str - the CharSequence to check (may be null)
    
    返回:
    
    true if the CharSequence is not null, its length is greater than 0, and it does not contain whitespace only
    
    另请参阅:
    
    Character.isWhitespace(char)
  - hasText
```
public static boolean hasText(String str)
```
    Check whether the given String has actual text. More specifically, returns true if the string not null, its length is greater than 0, and it contains at least one non-whitespace character.
    
    参数:
    
    str - the String to check (may be null)
    
    返回:
    
    true if the String is not null, its length is greater than 0, and it does not contain whitespace only
    
    另请参阅:
    
    hasText(CharSequence)
  - trimLeadingCharacter
```
public static String trimLeadingCharacter(String str,
                                          char leadingCharacter)
```
    Trim all occurrences of the supplied leading character from the given String.
    
    参数:
    
    str - the String to check
    
    leadingCharacter - the leading character to be trimmed
    
    返回:
    
    the trimmed String
  - substringMatch
```
public static boolean substringMatch(CharSequence str,
                                     int index,
                                     CharSequence substring)
```
    Test whether the given string matches the given substring at the given index.
    
    参数:
    
    str - the original string (or StringBuilder)
    
    index - the index in the original string to start matching against
    
    substring - the substring to match at the given index
  - replace
```
public static String replace(String inString,
                             String oldPattern,
                             String newPattern)
```
    Replace all occurrences of a substring within a string with another string.
    
    参数:
    
    inString - String to examine
    
    oldPattern - String to replace
    
    newPattern - String to insert
    
    返回:
    
    a String with the replacements
  - delete
```
public static String delete(String inString,
                            String pattern)
```
    Delete all occurrences of the given substring.
    
    参数:
    
    inString - the original String
    
    pattern - the pattern to delete all occurrences of
    
    返回:
    
    the resulting String
  - deleteAny
```
public static String deleteAny(String inString,
                               String charsToDelete)
```
    Delete any character in a given String.
    
    参数:
    
    inString - the original String
    
    charsToDelete - a set of characters to delete. E.g. "az\n" will delete 'a's, 'z's and new lines.
    
    返回:
    
    the resulting String
  - quote
```
public static String quote(String str)
```
    Quote the given String with single quotes.
    
    参数:
    
    str - the input String (e.g. "myString")
    
    返回:
    
    the quoted String (e.g. "'myString'"), or null if the input was null
  - capitalize
```
public static String capitalize(String str)
```
    Capitalize a String, changing the first letter to upper case as per Character.toUpperCase(char). No other letters are changed.
    
    参数:
    
    str - the String to capitalize, may be null
    
    返回:
    
    the capitalized String, null if null
  - toStringArray
```
public static String[] toStringArray(Collection<String> collection)
```
    Copy the given Collection into a String array. The Collection must contain String elements only.
    
    参数:
    
    collection - the Collection to copy
    
    返回:
    
    the String array (null if the passed-in Collection was null)
  - tokenizeByCommaToSet
```
public static Set<String> tokenizeByCommaToSet(String s)
```
    Tokenize the specified string by commas to a set, trimming whitespace and ignoring empty tokens.
    
    参数:
    
    s - the string to tokenize
    
    返回:
    
    the set of tokens
  - splitStringByCommaToArray
```
public static String[] splitStringByCommaToArray(String s)
```
    Split the specified string by commas to an array.
    
    参数:
    
    s - the string to split
    
    返回:
    
    the array of split values
    
    另请参阅:
    
    String.split(String)
  - split
```
public static String[] split(String toSplit,
                             String delimiter)
```
    Split a String at the first occurrence of the delimiter. Does not include the delimiter in the result.
    
    参数:
    
    toSplit - the string to split
    
    delimiter - to split the string up with
    
    返回:
    
    a two element array with index 0 being before the delimiter, and index 1 being after the delimiter (neither element includes the delimiter); or null if the delimiter wasn't found in the given input String
  - tokenizeToStringArray
```
public static String[] tokenizeToStringArray(String s,
                                             String delimiters)
```
    Tokenize the given String into a String array via a StringTokenizer. Trims tokens and omits empty tokens.
    The given delimiters string is supposed to consist of any number of delimiter characters. Each of those characters can be used to separate tokens. A delimiter is always a single character; for multi-character delimiters, consider using delimitedListToStringArray
    
    参数:
    
    s - the String to tokenize
    
    delimiters - the delimiter characters, assembled as String (each of those characters is individually considered as delimiter).
    
    返回:
    
    an array of the tokens
    
    另请参阅:
    
    StringTokenizer, String.trim(), delimitedListToStringArray(java.lang.String, java.lang.String)
  - delimitedListToStringArray
```
public static String[] delimitedListToStringArray(String str,
                                                  String delimiter)
```
    Take a String which is a delimited list and convert it to a String array.
    A single delimiter can consists of more than one character: It will still be considered as single delimiter string, rather than as bunch of potential delimiter characters - in contrast to tokenizeToStringArray.
    
    参数:
    
    str - the input String
    
    delimiter - the delimiter between elements (this is a single delimiter, rather than a bunch individual delimiter characters)
    
    返回:
    
    an array of the tokens in the list
    
    另请参阅:
    
    tokenizeToStringArray(java.lang.String, java.lang.String)
  - delimitedListToStringArray
```
public static String[] delimitedListToStringArray(String str,
                                                  String delimiter,
                                                  String charsToDelete)
```
    Take a String which is a delimited list and convert it to a String array.
    A single delimiter can consists of more than one character: It will still be considered as single delimiter string, rather than as bunch of potential delimiter characters - in contrast to tokenizeToStringArray.
    
    参数:
    
    str - the input String
    
    delimiter - the delimiter between elements (this is a single delimiter, rather than a bunch individual delimiter characters)
    
    charsToDelete - a set of characters to delete. Useful for deleting unwanted line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String.
    
    返回:
    
    an array of the tokens in the list
    
    另请参阅:
    
    tokenizeToStringArray(java.lang.String, java.lang.String)
  - commaDelimitedListToStringArray
```
public static String[] commaDelimitedListToStringArray(String str)
```
    Convert a CSV list into an array of Strings.
    
    参数:
    
    str - the input String
    
    返回:
    
    an array of Strings, or the empty array in case of empty input
  - commaDelimitedListToSet
```
public static Set<String> commaDelimitedListToSet(String str)
```
    Convenience method to convert a CSV string list to a set. Note that this will suppress duplicates.
    
    参数:
    
    str - the input String
    
    返回:
    
    a Set of String entries in the list
  - collectionToDelimitedString
```
public static String collectionToDelimitedString(Iterable<?> coll,
                                                 String delim,
                                                 String prefix,
                                                 String suffix)
```
    Convenience method to return a Collection as a delimited (e.g. CSV) String. E.g. useful for toString() implementations.
    
    参数:
    
    coll - the Collection to display
    
    delim - the delimiter to use (probably a ",")
    
    prefix - the String to start each element with
    
    suffix - the String to end each element with
    
    返回:
    
    the delimited String
  - collectionToDelimitedString
```
public static void collectionToDelimitedString(Iterable<?> coll,
                                               String delim,
                                               String prefix,
                                               String suffix,
                                               StringBuilder sb)
```
  - collectionToDelimitedString
```
public static String collectionToDelimitedString(Iterable<?> coll,
                                                 String delim)
```
    Convenience method to return a Collection as a delimited (e.g. CSV) String. E.g. useful for toString() implementations.
    
    参数:
    
    coll - the Collection to display
    
    delim - the delimiter to use (probably a ",")
    
    返回:
    
    the delimited String
  - collectionToCommaDelimitedString
```
public static String collectionToCommaDelimitedString(Iterable<?> coll)
```
    Convenience method to return a Collection as a CSV String. E.g. useful for toString() implementations.
    
    参数:
    
    coll - the Collection to display
    
    返回:
    
    the delimited String
  - arrayToDelimitedString
```
public static String arrayToDelimitedString(Object[] arr,
                                            String delim)
```
    Convenience method to return a String array as a delimited (e.g. CSV) String. E.g. useful for toString() implementations.
    
    参数:
    
    arr - the array to display
    
    delim - the delimiter to use (probably a ",")
    
    返回:
    
    the delimited String
  - arrayToDelimitedString
```
public static void arrayToDelimitedString(Object[] arr,
                                          String delim,
                                          StringBuilder sb)
```
  - arrayToCommaDelimitedString
```
public static String arrayToCommaDelimitedString(Object[] arr)
```
    Convenience method to return a String array as a CSV String. E.g. useful for toString() implementations.
    
    参数:
    
    arr - the array to display
    
    返回:
    
    the delimited String
  - format1Decimals
```
public static String format1Decimals(double value,
                                     String suffix)
```
    Format the double value with a single decimal points, trimming trailing '.0'.
  - substring
```
public static String substring(String s,
                               int beginIndex,
                               int endIndex)
```
    Return substring(beginIndex, endIndex) that is impervious to string length.
  - cleanTruncate
```
public static String cleanTruncate(String s,
                                   int length)
```
    Truncates string to a length less than length. Backtracks to throw out high surrogates.
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(String s)
```
  - coalesceToEmpty
```
public static String coalesceToEmpty(String s)
```
  - padStart
```
public static String padStart(String s,
                              int minimumLength,
                              char c)
```
  - toLowercaseAscii
```
public static String toLowercaseAscii(String in)
```

类 Strings

字段概要

方法概要

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

字段详细资料

EMPTY_ARRAY

方法详细资料

empty

spaceify

splitSmart

hasLength

hasLength

isEmpty

hasText

hasText

trimLeadingCharacter

substringMatch

replace

delete

deleteAny

quote

capitalize

toStringArray

tokenizeByCommaToSet

splitStringByCommaToArray

split

tokenizeToStringArray

delimitedListToStringArray

delimitedListToStringArray

commaDelimitedListToStringArray

commaDelimitedListToSet

collectionToDelimitedString

collectionToDelimitedString

collectionToDelimitedString

collectionToCommaDelimitedString

arrayToDelimitedString

arrayToDelimitedString

arrayToCommaDelimitedString

format1Decimals

substring

cleanTruncate

isNullOrEmpty

coalesceToEmpty

padStart

toLowercaseAscii