StringUtils (firefly-common 4.0.9 API)

java.lang.Object
- com.firefly.utils.StringUtils

```
public class StringUtils
extends Object
```

字段概要

字段
限定符和类型	字段和说明
`static String`	`__ISO_8859_1`
`static String`	`__UTF16`
`static String`	`__UTF8`
`static String`	`EMPTY`
`static String[]`	`EMPTY_STRING_ARRAY`
`static char[]`	`lowercases`

构造器概要

构造器
构造器和说明

StringUtils()

构造器
构造器和说明
`StringUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`append(StringBuilder buf, byte b, int base)` append hex digit
`static void`	`append(StringBuilder buf, String s, int offset, int length)` Append substring to StringBuilder
`static void`	`append2digits(StringBuffer buf, int i)` Append 2 digits (zero padded) to the StringBuffer
`static void`	`append2digits(StringBuilder buf, int i)` Append 2 digits (zero padded) to the StringBuilder
`static String`	`applyRelativePath(String path, String relativePath)` Apply the given relative path to the given Java resource path, assuming standard Java folder separation (i.e. "/" separators).
`static String`	`asciiToLowerCase(String s)` fast lower case conversion.
`static String`	`cleanPath(String path)` Normalize the path by suppressing sequences like "path/.." and inner simple dots.
`static String`	`collectionToCommaDelimitedString(Collection<?> coll)` Convert a `Collection` into a delimited `String` (e.g., CSV).
`static String`	`collectionToDelimitedString(Collection<?> coll, String delim)` Convert a `Collection` into a delimited `String` (e.g.
`static String`	`collectionToDelimitedString(Collection<?> coll, String delim, String prefix, String suffix)` Convert a `Collection` to a delimited `String` (e.g.
`static List<String>`	`csvSplit(List<String> list, String s, int off, int len)` Split a quoted comma separated string to a list Handle rfc4180-like CSV strings, with the exceptions: quoted values may contain double quotes escaped with back-slash Non-quoted values are trimmed of leading trailing white space trailing commas are ignored double commas result in a empty string value
`static String[]`	`csvSplit(String s)` Parse a CSV string using `csvSplit(List,String, int, int)`
`static String[]`	`csvSplit(String s, int off, int len)` Parse a CSV string using `csvSplit(List,String, int, int)`
`static String`	`deleteAny(String inString, String charsToDelete)` Delete any character in a given `String`.
`static String[]`	`delimitedListToStringArray(String str, String delimiter)` Take a `String` that is a delimited list and convert it into a `String` array.
`static String[]`	`delimitedListToStringArray(String str, String delimiter, String charsToDelete)` Take a `String` that is a delimited list and convert it into a `String` array.
`static String`	`escapeXML(String str)`
`static byte[]`	`getBytes(String s)`
`static byte[]`	`getBytes(String s, String charset)`
`static String`	`getFilename(String path)` Extract the filename from the given Java resource path, e.g.
`static String`	`getFilenameExtension(String path)` Extract the filename extension from the given Java resource path, e.g.
`static byte[]`	`getUtf8Bytes(String s)`
`static boolean`	`hasLength(CharSequence str)`
`static boolean`	`hasLength(String str)`
`static boolean`	`hasText(CharSequence str)`
`static boolean`	`hasText(String str)`
`static boolean`	`isAlpha(String value)`
`static String`	`normalizeCharset(String s)` Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
`static String`	`normalizeCharset(String s, int offset, int length)` Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
`static String`	`replace(String s, Map<String,Object> map)` Replace the pattern using a map, such as a pattern, such as A pattern is "hello ${foo}" and the map is {"foo" : "world"}, when you execute this function, the result is "hello world"
`static String`	`replace(String s, Object... objs)`
`static String[]`	`split(String str)` Splits the provided text into an array, using whitespace as the separator.
`static String[]`	`split(String str, char separatorChar)` Splits the provided text into an array, separator specified.
`static String[]`	`split(String str, String separatorChars)` Splits the provided text into an array, separators specified.
`static String[]`	`split(String str, String separatorChars, int max)` Splits the provided text into an array with a maximum length, separators specified.
`static String[]`	`splitByWholeSeparator(String str, String separator)` Splits the provided text into an array, separator string specified.
`static String[]`	`splitByWholeSeparator(String str, String separator, int max)` Splits the provided text into an array, separator string specified.
`static boolean`	`startsWithIgnoreCase(String str, String prefix)` Test if the given `String` starts with the specified prefix, ignoring upper/lower case.
`static int`	`toInt(String string, int from)` Convert String to an integer.
`static long`	`toLong(String string)` Convert String to an long.
`static String`	`unicodeToString(String s)` Convert a string that is unicode form to a normal string.

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

- 字段详细资料
  - EMPTY
```
public static final String EMPTY
```
    另请参阅:
    
    常量字段值
  - EMPTY_STRING_ARRAY
```
public static final String[] EMPTY_STRING_ARRAY
```
  - lowercases
```
public static final char[] lowercases
```
  - __ISO_8859_1
```
public static final String __ISO_8859_1
```
    另请参阅:
    
    常量字段值
  - __UTF8
```
public static final String __UTF8
```
    另请参阅:
    
    常量字段值
  - __UTF16
```
public static final String __UTF16
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - StringUtils
```
public StringUtils()
```
- 方法详细资料
  - normalizeCharset
```
public static String normalizeCharset(String s)
```
    Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
    
    参数:
    
    s - the charset to normalize
    
    返回:
    
    the normalized charset (or null if normalized version not found)
  - normalizeCharset
```
public static String normalizeCharset(String s,
                                      int offset,
                                      int length)
```
    Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
    
    参数:
    
    s - the charset to normalize
    
    offset - the offset in the charset
    
    length - the length of the charset in the input param
    
    返回:
    
    the normalized charset (or null if not found)
  - split
```
public static String[] split(String str)
```
    Splits the provided text into an array, using whitespace as the separator. Whitespace is defined by Character.isWhitespace(char).
    
    The separator is not included in the returned String array. Adjacent separators are treated as one separator. For more control over the split use the StrTokenizer class.
    
    A null input String returns null.
```
 StringUtils.split(null)       = null
 StringUtils.split("")         = []
 StringUtils.split("abc def")  = ["abc", "def"]
 StringUtils.split("abc  def") = ["abc", "def"]
 StringUtils.split(" abc ")    = ["abc"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    返回:
    
    an array of parsed Strings, null if null String input
  - split
```
public static String[] split(String str,
                             String separatorChars)
```
    Splits the provided text into an array, separators specified. This is an alternative to using StringTokenizer.
    
    The separator is not included in the returned String array. Adjacent separators are treated as one separator. For more control over the split use the StrTokenizer class.
    
    A null input String returns null. A null separatorChars splits on whitespace.
```
 StringUtils.split(null, *)         = null
 StringUtils.split("", *)           = []
 StringUtils.split("abc def", null) = ["abc", "def"]
 StringUtils.split("abc def", " ")  = ["abc", "def"]
 StringUtils.split("abc  def", " ") = ["abc", "def"]
 StringUtils.split("ab:cd:ef", ":") = ["ab", "cd", "ef"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    separatorChars - the characters used as the delimiters, null splits on whitespace
    
    返回:
    
    an array of parsed Strings, null if null String input
  - split
```
public static String[] split(String str,
                             char separatorChar)
```
    Splits the provided text into an array, separator specified. This is an alternative to using StringTokenizer.
    
    The separator is not included in the returned String array. Adjacent separators are treated as one separator. For more control over the split use the StrTokenizer class.
    
    A null input String returns null.
```
 StringUtils.split(null, *)         = null
 StringUtils.split("", *)           = []
 StringUtils.split("a.b.c", '.')    = ["a", "b", "c"]
 StringUtils.split("a..b.c", '.')   = ["a", "b", "c"]
 StringUtils.split("a:b:c", '.')    = ["a:b:c"]
 StringUtils.split("a b c", ' ')    = ["a", "b", "c"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    separatorChar - the character used as the delimiter
    
    返回:
    
    an array of parsed Strings, null if null String input
    
    从以下版本开始:
    
    2.0
  - split
```
public static String[] split(String str,
                             String separatorChars,
                             int max)
```
    Splits the provided text into an array with a maximum length, separators specified.
    
    The separator is not included in the returned String array. Adjacent separators are treated as one separator.
    
    A null input String returns null. A null separatorChars splits on whitespace.
    
    If more than max delimited substrings are found, the last returned string includes all characters after the first max - 1 returned strings (including separator characters).
```
 StringUtils.split(null, *, *)            = null
 StringUtils.split("", *, *)              = []
 StringUtils.split("ab de fg", null, 0)   = ["ab", "cd", "ef"]
 StringUtils.split("ab   de fg", null, 0) = ["ab", "cd", "ef"]
 StringUtils.split("ab:cd:ef", ":", 0)    = ["ab", "cd", "ef"]
 StringUtils.split("ab:cd:ef", ":", 2)    = ["ab", "cd:ef"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    separatorChars - the characters used as the delimiters, null splits on whitespace
    
    max - the maximum number of elements to include in the array. A zero or negative value implies no limit
    
    返回:
    
    an array of parsed Strings, null if null String input
  - splitByWholeSeparator
```
public static String[] splitByWholeSeparator(String str,
                                             String separator)
```
    Splits the provided text into an array, separator string specified.
    
    The separator(s) will not be included in the returned String array. Adjacent separators are treated as one separator.
    
    A null input String returns null. A null separator splits on whitespace.
```
 StringUtils.splitByWholeSeparator(null, *)               = null
 StringUtils.splitByWholeSeparator("", *)                 = []
 StringUtils.splitByWholeSeparator("ab de fg", null)      = ["ab", "de", "fg"]
 StringUtils.splitByWholeSeparator("ab   de fg", null)    = ["ab", "de", "fg"]
 StringUtils.splitByWholeSeparator("ab:cd:ef", ":")       = ["ab", "cd", "ef"]
 StringUtils.splitByWholeSeparator("ab-!-cd-!-ef", "-!-") = ["ab", "cd", "ef"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    separator - String containing the String to be used as a delimiter, null splits on whitespace
    
    返回:
    
    an array of parsed Strings, null if null String was input
  - splitByWholeSeparator
```
public static String[] splitByWholeSeparator(String str,
                                             String separator,
                                             int max)
```
    Splits the provided text into an array, separator string specified. Returns a maximum of max substrings.
    
    The separator(s) will not be included in the returned String array. Adjacent separators are treated as one separator.
    
    A null input String returns null. A null separator splits on whitespace.
```
 StringUtils.splitByWholeSeparator(null, *, *)               = null
 StringUtils.splitByWholeSeparator("", *, *)                 = []
 StringUtils.splitByWholeSeparator("ab de fg", null, 0)      = ["ab", "de", "fg"]
 StringUtils.splitByWholeSeparator("ab   de fg", null, 0)    = ["ab", "de", "fg"]
 StringUtils.splitByWholeSeparator("ab:cd:ef", ":", 2)       = ["ab", "cd:ef"]
 StringUtils.splitByWholeSeparator("ab-!-cd-!-ef", "-!-", 5) = ["ab", "cd", "ef"]
 StringUtils.splitByWholeSeparator("ab-!-cd-!-ef", "-!-", 2) = ["ab", "cd-!-ef"]
 
```
    参数:
    
    str - the String to parse, may be null
    
    separator - String containing the String to be used as a delimiter, null splits on whitespace
    
    max - the maximum number of elements to include in the returned array. A zero or negative value implies no limit.
    
    返回:
    
    an array of parsed Strings, null if null String was input
  - hasText
```
public static boolean hasText(String str)
```
  - hasText
```
public static boolean hasText(CharSequence str)
```
  - hasLength
```
public static boolean hasLength(CharSequence str)
```
  - hasLength
```
public static boolean hasLength(String str)
```
  - replace
```
public static String replace(String s,
                             Map<String,Object> map)
```
    Replace the pattern using a map, such as a pattern, such as A pattern is "hello ${foo}" and the map is {"foo" : "world"}, when you execute this function, the result is "hello world"
    
    参数:
    
    s - The pattern string.
    
    map - The key-value
    
    返回:
    
    The string replaced.
  - replace
```
public static String replace(String s,
                             Object... objs)
```
  - escapeXML
```
public static String escapeXML(String str)
```
  - unicodeToString
```
public static String unicodeToString(String s)
```
    Convert a string that is unicode form to a normal string.
    
    参数:
    
    s - The unicode form of a string, e.g. "\\u8001\\u9A6C"
    
    返回:
    
    Normal string
  - asciiToLowerCase
```
public static String asciiToLowerCase(String s)
```
    fast lower case conversion. Only works on ascii (not unicode)
    
    参数:
    
    s - the string to convert
    
    返回:
    
    a lower case version of s
  - append2digits
```
public static void append2digits(StringBuffer buf,
                                 int i)
```
    Append 2 digits (zero padded) to the StringBuffer
    
    参数:
    
    buf - the buffer to append to
    
    i - the value to append
  - append2digits
```
public static void append2digits(StringBuilder buf,
                                 int i)
```
    Append 2 digits (zero padded) to the StringBuilder
    
    参数:
    
    buf - the buffer to append to
    
    i - the value to append
  - append
```
public static void append(StringBuilder buf,
                          String s,
                          int offset,
                          int length)
```
    Append substring to StringBuilder
    
    参数:
    
    buf - StringBuilder to append to
    
    s - String to append from
    
    offset - The offset of the substring
    
    length - The length of the substring
  - append
```
public static void append(StringBuilder buf,
                          byte b,
                          int base)
```
    append hex digit
    
    参数:
    
    buf - the buffer to append to
    
    b - the byte to append
    
    base - the base of the hex output (almost always 16).
  - toInt
```
public static int toInt(String string,
                        int from)
```
    Convert String to an integer. Parses up to the first non-numeric character. If no number is found an IllegalArgumentException is thrown
    
    参数:
    
    string - A String containing an integer.
    
    from - The index to start parsing from
    
    返回:
    
    an int
  - toLong
```
public static long toLong(String string)
```
    Convert String to an long. Parses up to the first non-numeric character. If no number is found an IllegalArgumentException is thrown
    
    参数:
    
    string - A String containing an integer.
    
    返回:
    
    an int
  - getBytes
```
public static byte[] getBytes(String s)
```
  - getUtf8Bytes
```
public static byte[] getUtf8Bytes(String s)
```
  - getBytes
```
public static byte[] getBytes(String s,
                              String charset)
```
  - csvSplit
```
public static String[] csvSplit(String s)
```
    Parse a CSV string using csvSplit(List,String, int, int)
    
    参数:
    
    s - The string to parse
    
    返回:
    
    An array of parsed values.
  - csvSplit
```
public static String[] csvSplit(String s,
                                int off,
                                int len)
```
    Parse a CSV string using csvSplit(List,String, int, int)
    
    参数:
    
    s - The string to parse
    
    off - The offset into the string to start parsing
    
    len - The len in characters to parse
    
    返回:
    
    An array of parsed values.
  - csvSplit
```
public static List<String> csvSplit(List<String> list,
                                    String s,
                                    int off,
                                    int len)
```
    Split a quoted comma separated string to a list
    Handle rfc4180-like CSV strings, with the exceptions:
    - quoted values may contain double quotes escaped with back-slash
    - Non-quoted values are trimmed of leading trailing white space
    - trailing commas are ignored
    - double commas result in a empty string value
    参数:
    
    list - The Collection to split to (or null to get a new list)
    
    s - The string to parse
    
    off - The offset into the string to start parsing
    
    len - The len in characters to parse
    
    返回:
    
    list containing the parsed list values
  - isAlpha
```
public static final boolean isAlpha(String value)
```
  - startsWithIgnoreCase
```
public static boolean startsWithIgnoreCase(String str,
                                           String prefix)
```
    Test if the given String starts with the specified prefix, ignoring upper/lower case.
    
    参数:
    
    str - the String to check
    
    prefix - the prefix to look for
    
    另请参阅:
    
    String.startsWith(java.lang.String, int)
  - applyRelativePath
```
public static String applyRelativePath(String path,
                                       String relativePath)
```
    Apply the given relative path to the given Java resource path, assuming standard Java folder separation (i.e. "/" separators).
    
    参数:
    
    path - the path to start from (usually a full file path)
    
    relativePath - the relative path to apply (relative to the full file path above)
    
    返回:
    
    the full file path that results from applying the relative path
  - cleanPath
```
public static String cleanPath(String path)
```
    Normalize the path by suppressing sequences like "path/.." and inner simple dots.
    The result is convenient for path comparison. For other uses, notice that Windows separators ("\") are replaced by simple slashes.
    
    参数:
    
    path - the original path
    
    返回:
    
    the normalized path
  - delimitedListToStringArray
```
public static String[] delimitedListToStringArray(String str,
                                                  String delimiter)
```
    Take a String that is a delimited list and convert it into a String array.
    A single delimiter may consist of more than one character, but it will still be considered as a 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
  - delimitedListToStringArray
```
public static String[] delimitedListToStringArray(String str,
                                                  String delimiter,
                                                  String charsToDelete)
```
    Take a String that is a delimited list and convert it into a String array.
    A single delimiter may consist of more than one character, but it will still be considered as a 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
  - collectionToDelimitedString
```
public static String collectionToDelimitedString(Collection<?> coll,
                                                 String delim,
                                                 String prefix,
                                                 String suffix)
```
    Convert a Collection to a delimited String (e.g. CSV).
    Useful for toString() implementations.
    
    参数:
    
    coll - the Collection to convert
    
    delim - the delimiter to use (typically a ",")
    
    prefix - the String to start each element with
    
    suffix - the String to end each element with
    
    返回:
    
    the delimited String
  - collectionToDelimitedString
```
public static String collectionToDelimitedString(Collection<?> coll,
                                                 String delim)
```
    Convert a Collection into a delimited String (e.g. CSV).
    Useful for toString() implementations.
    
    参数:
    
    coll - the Collection to convert
    
    delim - the delimiter to use (typically a ",")
    
    返回:
    
    the delimited String
  - collectionToCommaDelimitedString
```
public static String collectionToCommaDelimitedString(Collection<?> coll)
```
    Convert a Collection into a delimited String (e.g., CSV).
    Useful for toString() implementations.
    
    参数:
    
    coll - the Collection to convert
    
    返回:
    
    the delimited 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
  - getFilenameExtension
```
public static String getFilenameExtension(String path)
```
    Extract the filename extension from the given Java resource path, e.g. "mypath/myfile.txt" -> "txt".
    
    参数:
    
    path - the file path (may be null)
    
    返回:
    
    the extracted filename extension, or null if none
  - getFilename
```
public static String getFilename(String path)
```
    Extract the filename from the given Java resource path, e.g. "mypath/myfile.txt" -> "myfile.txt".
    
    参数:
    
    path - the file path (may be null)
    
    返回:
    
    the extracted filename, or null if none

类 StringUtils

字段概要

构造器概要

方法概要

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

字段详细资料

EMPTY

EMPTY_STRING_ARRAY

lowercases

__ISO_8859_1

__UTF8

__UTF16

构造器详细资料

StringUtils

方法详细资料

normalizeCharset

normalizeCharset

split

split

split

split

splitByWholeSeparator

splitByWholeSeparator

hasText

hasText

hasLength

hasLength

replace

replace

escapeXML

unicodeToString

asciiToLowerCase

append2digits

append2digits

append

append

toInt

toLong

getBytes

getUtf8Bytes

getBytes

csvSplit

csvSplit

csvSplit

isAlpha

startsWithIgnoreCase

applyRelativePath

cleanPath

delimitedListToStringArray

delimitedListToStringArray

collectionToDelimitedString

collectionToDelimitedString

collectionToCommaDelimitedString

deleteAny

getFilenameExtension

getFilename