StringUtils (Hadoop 1.2.2-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.util.StringUtils

```
public class StringUtils
extends Object
```
General string utils

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`StringUtils.TraditionalBinaryPrefix` The traditional binary prefixes, kilo, mega, ..., exa, which can be represented by a 64-bit integer.

字段概要

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

static char COMMA

static String COMMA_STR

static char ESCAPE_CHAR

字段
限定符和类型	字段和说明
`static char`	`COMMA`
`static String`	`COMMA_STR`
`static char`	`ESCAPE_CHAR`

构造器概要

构造器
构造器和说明

StringUtils()

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

方法概要

方法
限定符和类型	方法和说明
`static String`	`arrayToString(String[] strs)` Given an array of strings, return a comma-separated list of its elements.
`static String`	`byteDesc(long len)` Return an abbreviated English-language desc of the byte length
`static String`	`byteToHexString(byte[] bytes)` Same as byteToHexString(bytes, 0, bytes.length).
`static String`	`byteToHexString(byte[] bytes, int start, int end)` Given an array of bytes it will convert the bytes to a hex string representation of the bytes
`static String`	`camelize(String s)` Convert SOME_STUFF to SomeStuff
`static String`	`capitalize(String s)` Capitalize a word
`static String`	`escapeHTML(String string)` Escapes HTML Special characters present in the string.
`static String`	`escapeString(String str)` Escape commas in the string using the default escape char
`static String`	`escapeString(String str, char escapeChar, char charToEscape)` Escape `charToEscape` in the string with the escape char `escapeChar`
`static String`	`escapeString(String str, char escapeChar, char[] charsToEscape)`
`static int`	`findNext(String str, char separator, char escapeChar, int start, StringBuilder split)` Finds the first occurrence of the separator character ignoring the escaped separators starting from the index.
`static String`	`formatPercent(double done, int digits)` Format a percentage for presentation to the user.
`static String`	`formatTime(long timeDiff)` Given the time in long milliseconds, returns a String in the format Xhrs, Ymins, Z sec.
`static String`	`formatTimeDiff(long finishTime, long startTime)` Given a finish and start time in long milliseconds, returns a String in the format Xhrs, Ymins, Z sec, for the time difference between two times.
`static String`	`getFormattedTimeWithDiff(DateFormat dateFormat, long finishTime, long startTime)` Formats time in ms and appends difference (finishTime - startTime) as returned by formatTimeDiff().
`static String`	`getHostname()` Return hostname without throwing exception.
`static Collection<String>`	`getStringCollection(String str)` Returns a collection of strings.
`static String[]`	`getStrings(String str)` Returns an arraylist of strings.
`static byte[]`	`hexStringToByte(String hex)` Given a hexstring this will return the byte array corresponding to the string
`static String`	`humanReadableInt(long number)` Given an integer, return a string that is in an approximate, but human readable format.
`static String`	`join(CharSequence separator, Iterable<String> strings)` Concatenates strings, using a separator.
`static String`	`join(CharSequence separator, Object[] objects)` Concatenates objects, using a separator.
`static String`	`join(CharSequence separator, String[] strings)` Concatenates strings, using a separator.
`static String`	`limitDecimalTo2(double d)`
`static String`	`simpleHostname(String fullHostname)` Given a full hostname, return the word upto the first dot.
`static String[]`	`split(String str)` Split a string using the default separator
`static String[]`	`split(String str, char escapeChar, char separator)` Split a string using the given separator
`static void`	`startupShutdownMessage(Class<?> clazz, String[] args, org.apache.commons.logging.Log LOG)` Print a log message for starting up and shutting down
`static String`	`stringifyException(Throwable e)` Make a string representation of the exception.
`static Path[]`	`stringToPath(String[] str)`
`static URI[]`	`stringToURI(String[] str)`
`static String`	`unEscapeString(String str)` Unescape commas in the string using the default escape char
`static String`	`unEscapeString(String str, char escapeChar, char charToEscape)` Unescape `charToEscape` in the string with the escape char `escapeChar`
`static String`	`unEscapeString(String str, char escapeChar, char[] charsToEscape)`
`static String`	`uriToString(URI[] uris)`

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

- 字段详细资料
  - COMMA
```
public static final char COMMA
```
    另请参阅:
    常量字段值
  - COMMA_STR
```
public static final String COMMA_STR
```
    另请参阅:
    常量字段值
  - ESCAPE_CHAR
```
public static final char ESCAPE_CHAR
```
    另请参阅:
    常量字段值
- 构造器详细资料
  - StringUtils
```
public StringUtils()
```
- 方法详细资料
  - stringifyException
```
public static String stringifyException(Throwable e)
```
    Make a string representation of the exception.
    
    参数:
    e - The exception to stringify
    
    返回:
    A string with exception name and call stack.
  - simpleHostname
```
public static String simpleHostname(String fullHostname)
```
    Given a full hostname, return the word upto the first dot.
    
    参数:
    fullHostname - the full hostname
    
    返回:
    the hostname to the first dot
  - humanReadableInt
```
public static String humanReadableInt(long number)
```
    Given an integer, return a string that is in an approximate, but human readable format. It uses the bases 'k', 'm', and 'g' for 1024, 1024**2, and 1024**3.
    
    参数:
    number - the number to format
    
    返回:
    a human readable form of the integer
  - formatPercent
```
public static String formatPercent(double done,
                   int digits)
```
    Format a percentage for presentation to the user.
    
    参数:
    done - the percentage to format (0.0 to 1.0)
    digits - the number of digits past the decimal point
    
    返回:
    a string representation of the percentage
  - arrayToString
```
public static String arrayToString(String[] strs)
```
    Given an array of strings, return a comma-separated list of its elements.
    
    参数:
    strs - Array of strings
    
    返回:
    Empty string if strs.length is 0, comma separated list of strings otherwise
  - byteToHexString
```
public static String byteToHexString(byte[] bytes,
                     int start,
                     int end)
```
    Given an array of bytes it will convert the bytes to a hex string representation of the bytes
    
    参数:
    bytes -
    start - start index, inclusively
    end - end index, exclusively
    
    返回:
    hex string representation of the byte array
  - byteToHexString
```
public static String byteToHexString(byte[] bytes)
```
    Same as byteToHexString(bytes, 0, bytes.length).
  - hexStringToByte
```
public static byte[] hexStringToByte(String hex)
```
    Given a hexstring this will return the byte array corresponding to the string
    
    参数:
    hex - the hex String array
    
    返回:
    a byte array that is a hex string representation of the given string. The size of the byte array is therefore hex.length/2
  - uriToString
```
public static String uriToString(URI[] uris)
```
    参数:
    uris -
  - stringToURI
```
public static URI[] stringToURI(String[] str)
```
    参数:
    str -
  - stringToPath
```
public static Path[] stringToPath(String[] str)
```
    参数:
    str -
  - formatTimeDiff
```
public static String formatTimeDiff(long finishTime,
                    long startTime)
```
    Given a finish and start time in long milliseconds, returns a String in the format Xhrs, Ymins, Z sec, for the time difference between two times. If finish time comes before start time then negative valeus of X, Y and Z wil return.
    
    参数:
    finishTime - finish time
    startTime - start time
  - formatTime
```
public static String formatTime(long timeDiff)
```
    Given the time in long milliseconds, returns a String in the format Xhrs, Ymins, Z sec.
    
    参数:
    timeDiff - The time difference to format
  - getFormattedTimeWithDiff
```
public static String getFormattedTimeWithDiff(DateFormat dateFormat,
                              long finishTime,
                              long startTime)
```
    Formats time in ms and appends difference (finishTime - startTime) as returned by formatTimeDiff(). If finish time is 0, empty string is returned, if start time is 0 then difference is not appended to return value.
    
    参数:
    dateFormat - date format to use
    finishTime - fnish time
    startTime - start time
    
    返回:
    formatted value.
  - getStrings
```
public static String[] getStrings(String str)
```
    Returns an arraylist of strings.
    
    参数:
    str - the comma seperated string values
    
    返回:
    the arraylist of the comma seperated string values
  - getStringCollection
```
public static Collection<String> getStringCollection(String str)
```
    Returns a collection of strings.
    
    参数:
    str - comma seperated string values
    
    返回:
    an ArrayList of string values
  - split
```
public static String[] split(String str)
```
    Split a string using the default separator
    
    参数:
    str - a string that may have escaped separator
    
    返回:
    an array of strings
  - split
```
public static String[] split(String str,
             char escapeChar,
             char separator)
```
    Split a string using the given separator
    
    参数:
    str - a string that may have escaped separator
    escapeChar - a char that be used to escape the separator
    separator - a separator char
    
    返回:
    an array of strings
  - findNext
```
public static int findNext(String str,
           char separator,
           char escapeChar,
           int start,
           StringBuilder split)
```
    Finds the first occurrence of the separator character ignoring the escaped separators starting from the index. Note the substring between the index and the position of the separator is passed.
    
    参数:
    str - the source string
    separator - the character to find
    escapeChar - character used to escape
    start - from where to search
    split - used to pass back the extracted string
  - escapeString
```
public static String escapeString(String str)
```
    Escape commas in the string using the default escape char
    
    参数:
    str - a string
    
    返回:
    an escaped string
  - escapeString
```
public static String escapeString(String str,
                  char escapeChar,
                  char charToEscape)
```
    Escape charToEscape in the string with the escape char escapeChar
    
    参数:
    str - string
    escapeChar - escape char
    charToEscape - the char to be escaped
    
    返回:
    an escaped string
  - escapeString
```
public static String escapeString(String str,
                  char escapeChar,
                  char[] charsToEscape)
```
    参数:
    charsToEscape - array of characters to be escaped
  - unEscapeString
```
public static String unEscapeString(String str)
```
    Unescape commas in the string using the default escape char
    
    参数:
    str - a string
    
    返回:
    an unescaped string
  - unEscapeString
```
public static String unEscapeString(String str,
                    char escapeChar,
                    char charToEscape)
```
    Unescape charToEscape in the string with the escape char escapeChar
    
    参数:
    str - string
    escapeChar - escape char
    charToEscape - the escaped char
    
    返回:
    an unescaped string
  - unEscapeString
```
public static String unEscapeString(String str,
                    char escapeChar,
                    char[] charsToEscape)
```
    参数:
    charsToEscape - array of characters to unescape
  - getHostname
```
public static String getHostname()
```
    Return hostname without throwing exception.
    
    返回:
    hostname
  - startupShutdownMessage
```
public static void startupShutdownMessage(Class<?> clazz,
                          String[] args,
                          org.apache.commons.logging.Log LOG)
```
    Print a log message for starting up and shutting down
    
    参数:
    clazz - the class of the server
    args - arguments
    LOG - the target log object
  - escapeHTML
```
public static String escapeHTML(String string)
```
    Escapes HTML Special characters present in the string.
    
    参数:
    string -
    
    返回:
    HTML Escaped String representation
  - byteDesc
```
public static String byteDesc(long len)
```
    Return an abbreviated English-language desc of the byte length
  - limitDecimalTo2
```
public static String limitDecimalTo2(double d)
```
  - join
```
public static String join(CharSequence separator,
          Iterable<String> strings)
```
    Concatenates strings, using a separator.
    
    参数:
    separator - Separator to join with.
    strings - Strings to join.
    
    返回:
    the joined string
  - join
```
public static String join(CharSequence separator,
          String[] strings)
```
    Concatenates strings, using a separator.
    
    参数:
    separator - to join with
    strings - to join
    
    返回:
    the joined string
  - join
```
public static String join(CharSequence separator,
          Object[] objects)
```
    Concatenates objects, using a separator.
    
    参数:
    separator - to join with
    objects - to join
    
    返回:
    the joined string
  - capitalize
```
public static String capitalize(String s)
```
    Capitalize a word
    
    参数:
    s - the input string
    
    返回:
    capitalized string
  - camelize
```
public static String camelize(String s)
```
    Convert SOME_STUFF to SomeStuff
    
    参数:
    s - input string
    
    返回:
    camelized string

类 StringUtils

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

COMMA

COMMA_STR

ESCAPE_CHAR

构造器详细资料

StringUtils

方法详细资料

stringifyException

simpleHostname

humanReadableInt

formatPercent

arrayToString

byteToHexString

byteToHexString

hexStringToByte

uriToString

stringToURI

stringToPath

formatTimeDiff

formatTime

getFormattedTimeWithDiff

getStrings

getStringCollection

split

split

findNext

escapeString

escapeString

escapeString

unEscapeString

unEscapeString

unEscapeString

getHostname

startupShutdownMessage

escapeHTML

byteDesc

limitDecimalTo2

join

join

join

capitalize

camelize