StringUtils (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.stringutils.StringUtilities
- - org.safs.StringUtils

```
public abstract class StringUtils
extends StringUtilities
```
This class provides different kinds of utilities to handle string.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringUtils.ErrorLineParser` This class is used to parse the test error message.
`static class`	`StringUtils.ErrorLinkTrace` This class encapsulate the test error message.

Nested classes/interfaces inherited from class org.safs.tools.stringutils.StringUtilities
StringUtilities.TestStacktraceCaller

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AND` string and &
`static java.lang.String`	`BACK_SLASH` string back slash \
`static java.lang.String`	`CARET` string caret ^
`static java.lang.String`	`CARRIAGE_RETURN` "\r" carriage return
`static java.lang.String`	`CASE_INSENSITIVE` "CASE-INSENSITIVE"
`static java.lang.String`	`CASEINSENSITIVE` "CASEINSENSITIVE"
`static char`	`CHAR_AND` character and &
`static char`	`CHAR_BACK_SLASH` character back slash \
`static char`	`CHAR_CARET` character caret ^
`static char`	`CHAR_COLON` character colon :
`static char`	`CHAR_COMMA` ','
`static char`	`CHAR_DOLLAR` character dollar $
`static char`	`CHAR_DOT` character dot .
`static char`	`CHAR_DOUBLE_QUOTE` character double quote "
`static char`	`CHAR_EQUAL` character equal =
`static char`	`CHAR_INTERROGATION` character interrogation ?
`static char`	`CHAR_MINUS` '-'
`static char`	`CHAR_NUMBER` character number #
`static char`	`CHAR_PERCENTAGE` '%'
`static char`	`CHAR_PLUS` '+'
`static char`	`CHAR_QUOTE` character single quote '
`static char`	`CHAR_SEMI_COLON` ';'
`static char`	`CHAR_SLASH` character slash /
`static char`	`CHAR_SPACE` ' '
`static char`	`CHAR_STAR` character star *
`static java.lang.String`	`CHARSET_UTF8` "UTF-8" charset
`static java.lang.String`	`COLON` string colon :
`static java.lang.String`	`COMMA` ","
`static java.lang.String`	`CRLF` "\r\n" PC new line string
`static int`	`DEFAULT_BUFFER_SIZE` 1024*10
`static int`	`DEFAULT_X_COORDINATE` '5', the default x coordinate in pixel.
`static int`	`DEFAULT_Y_COORDINATE` '5', the default y coordinate in pixel.
`static java.lang.String`	`DOLLAR` string dollar $
`static java.lang.String`	`DOT` string dot .
`static java.lang.String`	`DOUBLE_QUOTE` string double quote "
`static java.lang.String`	`EQUAL` string equal =
`static java.lang.String`	`INTERROGATION` string interrogation ?
`static java.lang.String`	`KEY_UTF8_CHARSET` The charset used to translate the base64 encoded bytes to string, and translate that string back to base64 encoded bytes.
`static java.lang.String`	`LOCAL_HOST` 'localhost'
`static java.lang.String`	`LOCAL_HOST_IP` '127.0.0.1'
`static int`	`maxBytesPerRead` 10000
`static java.lang.String`	`MINUS` "-"
`static java.lang.String`	`NEW_LINE` "\n" new line string
`static java.lang.String`	`NUMBER` string number #
`static java.lang.String`	`PERCENTAGE` "%"
`static java.lang.String`	`PLUS` "+"
`static java.lang.String`	`PROPERTY_START`
`static java.lang.String`	`QUOTE` string single quote '
`static java.lang.String`	`REGEX_CHARACTER_ANY` "."
`static java.lang.String`	`REGEX_CHARACTER_MATCH_MANY` "*"
`static java.lang.String`	`REGEX_CHARACTER_MATCH_ONE` "?"
`static java.lang.Character`	`REGEX_ESCAPE_CHARACTER` '\'
`static java.lang.String`	`SEMI_COLON` ";"
`static java.lang.String`	`SLASH` string slash /
`static java.lang.String`	`SPACE` " "
`static java.lang.String[]`	`specialKeys` "~", "+", "^", "%", "(", ")", "{", "}"
`static java.lang.String`	`SYSTEM_PROPERTY_NON_PROXY_HOSTS` 'http.nonProxyHosts'
`static java.lang.String`	`SYSTEM_PROPERTY_PROXY_BYPASS` 'http.proxyBypass'
`static java.lang.String`	`SYSTEM_PROPERTY_PROXY_HOST` 'http.proxyHost'
`static java.lang.String`	`SYSTEM_PROPERTY_PROXY_PORT` 'http.proxyPort'
`static char[]`	`URL_ENCODING_IGNORE_CHARACTERS` An array defines the characters should not be encoded.
`static char[]`	`WILDCARD_CHARS` '*', '$'

Fields inherited from class org.safs.tools.stringutils.StringUtilities
DATE_FORMAT_a, DATE_FORMAT_AM_PM_DATE_TIME, DATE_FORMAT_AM_PM_TIME, DATE_FORMAT_DATE, DATE_FORMAT_MILITARY_DATE_TIME, DATE_FORMAT_MILITARY_TIME, FILE_TIME_BASE, JAVA_TIME_BASE, SAFS_DEFAULT_START_INDEX, TIME_OF_AM, TIME_OF_PM, TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond

Constructor Summary

Constructors
Constructor and Description

StringUtils()

Constructors
Constructor and Description
`StringUtils()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static <T> java.util.List<T>`	`arrayToList(T[] array)` As the List returned by Arrays.asList() does not support remove operation. So we provide this method ourselves.
`static java.lang.String`	`arrayToString(java.lang.Object[] values)` Convert an array to a string, which contains the array's value separated by a space.
`static java.lang.String`	`arrayToString(java.lang.Object[] values, java.lang.String delimiter)` Convert an array to a string, which contains the array's value separated by parameter delimiter.
`static java.lang.String[]`	`breakXpath(java.lang.String xpath, boolean onlyLeaf, boolean rootToLeaf)` Break the xpath into multiple xparts by slash and return these xparts as an array. The slash between quote or double-quote will not be considered as separator of xpart.
`static java.lang.String`	`concat(java.lang.String s1, java.lang.String s2, java.lang.String s3)` Purpose: concatenate strings
`static java.lang.String`	`concatURL(java.lang.String baseURL, java.lang.String relativeURI)`
`static boolean`	`contains(java.lang.String content, char[] characters)` check if a string contains one of characters given by an array.
`static boolean`	`containsSepcialKeys(java.lang.String value)`
`static java.util.Map<java.lang.String,java.lang.String>`	`convertCollectionToMap(java.util.Collection<java.lang.String> contents, java.lang.String sep)` Convert a collection of text entries formatted as name=value into a Map file.
`static java.awt.Point`	`convertCoords(java.lang.String coords)` Convert coordinates string formats: "x;y" "x,y" "x y" "Coords=x;y" "Coords=x,y" "Coords=x y" into a java.awt.Point object.
`static java.awt.Point`	`convertCoords(java.lang.String[] coordsPair)` Convert the coordinate (given by array of String) into java.awt.Point format.
`static java.awt.Point`	`convertCoords(java.lang.String[] coordsPair, java.awt.Rectangle compRect)` Convert the coordinate (given by array of String) into java.awt.Point format.
`static java.lang.String[]`	`convertCoordsToArray(java.lang.String coords, int length)` Convert coordinates string of the formats: "x1;y1;x2;y2" "x1,y1,x2,y2" "x1 y1 x2 y2" "x1;y1;x2;y2;x3;y3;x4;y4" "Coords=x1;y1;x2;y2" "Coords=x1,y1,x2,y2" "Coords=x1 y1 x2 y2" "Coords=x1 y1 x2 y2 x3 y3 x4 y4" into an array object.
`static java.awt.Polygon`	`convertLine(java.lang.String coords)` Convert 2-point Line coordinates string of the formats: "x1;y1;x2;y2" "x1,y1,x2,y2" "x1 y1 x2 y2" "Coords=x1;y1;x2;y2" "Coords=x1,y1,x2,y2" "Coords=x1 y1 x2 y2" into a java.awt.Polygon object.
`static java.lang.Integer`	`convertNum(java.lang.String num)` Purpose: convertNum: convert into a number Assumptions: all exceptions are handled.
`static java.lang.String`	`convertWildcardsToRegularExpression(java.lang.String input)` convert ? and * wildcarding to regular expression wildcarding .? and .*
`static java.lang.Object`	`decodeBase64Object(java.lang.String base64String)` Decode a string to object with charset "UTF-8".
`static java.lang.String`	`deduceUnusedSeparatorString(java.lang.String expression)` Decide what is the best separator to use for a record from a possible separator list: `TestRecordData.POSSIBLE_SEPARATOR`.
`static java.lang.String`	`deduceUsedSeparatorString(java.lang.String expression)` Deduce the separator used in the expression, it tries each possible separator in list `TestRecordData.POSSIBLE_SEPARATOR` and return the first used one.
`static java.lang.String`	`encodeBase64Object(java.lang.Object object)` Encode the object to a string with charset "UTF-8".
`static java.lang.String[]`	`extractCoordStringPair(java.lang.String coords)` Deprecated. call `convertCoordsToArray(String, int)`, which is more generic.
`static int`	`findExactMatchIndex(java.util.ListIterator iter, java.lang.String match)` Purpose: find an exact match based on the parameter by walking the list, finding a string which equals the matching string, and returning the index into the list if it matched.
`static int`	`findMatchIndex(java.util.ListIterator iter, java.lang.String match)` Purpose: find a match based on the parameter by walking the list, finding a string which contains the matching substring, and returning the index into the list if it matched.
`static java.lang.String`	`generatePositionSepeartor(java.lang.String stepSeparator)` Generate a separator different from 'step separator', and it can be used to separate the coordinates for the position parameter in a test record.
`static java.lang.String`	`generateUniqueName(java.lang.String prefix)` Generate a unique name.
`static java.lang.String`	`getChars(java.lang.Integer num, java.lang.String chars)` Purpose: get a string with the number of specified sequenced 'chars'
`static java.lang.String`	`getDBVal(java.lang.Object m)` Deprecated. for DatabaseUtils.getDBVal(Object)
`static java.lang.String`	`getDelimitedString(java.util.List<java.lang.String> list, java.lang.String delimiter)` Purpose: Get text strung delimited by delimiter from a list, delimiter will be considered as a whole string Example: If delimiter is "->", if the list contains 3 items, "parent" "child" "grandChild" the returned text is "parent->child->grandChild"
`static int`	`getFieldCount(java.lang.String input, int startindex, java.lang.String seps)` Purpose: Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
`static java.lang.String`	`getFirstLine(java.lang.String content)`
`static java.lang.String`	`getInputToken(java.lang.String input, int n, java.lang.String sep)` Purpose: get 0-based field N of input by tokenizing with sep.
`static java.lang.String`	`getLastDelimitedToken(java.lang.String delimitedString, java.lang.String delimiter)`
`static java.lang.String`	`getMemoryAddress(java.lang.Object object)` Get the object's memory address according to the method hashCode(). Note: The method hashCode() should not be overridden.
`static java.lang.String`	`getParentXpath(java.lang.String xpath)` Return the parent part of an xpath.
`static java.lang.String[]`	`getSortArray(java.lang.String[] inp)`
`static java.lang.String`	`getSpaces(java.lang.Integer num)` Purpose: get a string with the number of specified spaces
`static java.lang.String`	`getStackInfo(java.util.Stack<?> stack)`
`static java.lang.String`	`getSystemProperty(java.lang.String property, ConfigureInterface config, java.lang.String section, java.lang.String key, java.lang.String... defaultValue)` Get the value of a property from system properties and Set a value from the configuration to System-Properties.
`static java.lang.String[]`	`getTokenArray(java.lang.String text, java.lang.String delimiter)`
`static java.lang.String[]`	`getTokenArray(java.lang.String text, java.lang.String delimiter, java.lang.Character escapeChar)`
`static java.util.List<java.lang.String>`	`getTokenList(java.lang.String text, java.lang.String delimiter)` Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string Example: If delimiter is "->", text is "parent->child->grandChild", then the returned list will contains 3 items: "parent", "child" and "grandChild".
`static java.util.List<java.lang.String>`	`getTokenList(java.lang.String text, java.lang.String delimiter, java.lang.Character escapeChar)` Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string, if some token contains the delimiter, user needs to escape the delimiter.
`static java.util.List<java.lang.String>`	`getTrimmedTokenList(java.lang.String text, java.lang.String delimiter)` Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string.
`static java.util.List<java.lang.String>`	`getTrimmedTokenList(java.lang.String text, java.lang.String delimiter, java.lang.Character escapeChar)` Purpose: Get tokens of text separated by delimiter, delimiter will be considered as a whole string, if some token contains the delimiter, user needs to escape the delimiter.
`static java.lang.String`	`getTrimmedUnquotedStr(java.lang.String str)` Purpose: This method takes a string trims it of leading and trailing spaces, non-breaking spaces, and tabs, and then strips one leading and/or trailing quotation mark(#34)--if they exist.
`static java.lang.String`	`getUniqueSep(java.lang.String sep, java.lang.String command, java.lang.String... params)` Get a separator NOT appear in command neither in params; if no such separator can be found, then the default separator will be return.
`static void`	`initIndependantLogByConsole()`
`static boolean`	`isCaseContainsMatch(java.lang.String source, java.lang.String target, boolean exactMatch)` Purpose: evaluate 2 string values to see if they match.
`static boolean`	`isCaseSensitive(java.lang.String caseSensitiveStr)` parse a string to tell if it represnet case insensitive.
`static boolean`	`isMatchingMaps(java.util.Map<java.lang.String,java.lang.String> source, java.util.Map<java.lang.String,java.lang.String> target)`
`static boolean`	`isMatchingTargetMapValues(java.util.Map<java.lang.String,java.lang.String> source, java.util.Map<java.lang.String,java.lang.String> target)` Compares 2 Maps, but only cares about matching those key/value items that exist in the target/benchmark.
`static boolean`	`isQuoted(java.lang.String value)` Test if the value is double-quoted or not.
`static boolean`	`isValid(java.lang.String value)`
`static java.lang.String`	`leftTrimSpace(java.lang.String text)` Trims all chars below char (int) 32 EXCEPT for TAB char (int) 9 from the left side of the provided text string.
`static void`	`main(java.lang.String[] args)` java -ea org.safs.StringUtils
`static boolean`	`matchRegex(java.lang.String expression, java.lang.String value)` Purpose: match a regular expression to a value.
`static boolean`	`matchText(java.lang.String actualText, java.lang.String expectedText, boolean partialMatch, boolean ignoreCase)` match a text(provided as fullstring, substing, regex, wildcard) against the actual text got from application component(list, menu, tree, tab etc.)
`static java.lang.String`	`normalizeLineBreaks(java.lang.String source)` Normalize potential line breaks:
`static boolean`	`parseBoolean(java.lang.String booleanString)`
`static float`	`parseFloat(java.lang.String floatNumber)` Convert s String float number (such as 35%, 0.68, 23, 5.4 etc.) into float.
`static java.lang.String`	`parseSeparator(java.lang.String input)` Parse a string to get the separator.
`static java.lang.String`	`processEmbeddedVariables(java.lang.String stringContainingVariables)` Replace the embedded variables inside a string. Embedded variables are in the form %VARIABLE_NAME% and will be sought as System Properties, or System Environment variables.
`static java.lang.String`	`quote(java.lang.String parameter)` Add double-quote around a string value.
`static java.lang.StringBuffer`	`readBinaryFile(java.lang.String filename)` Purpose: read Binary file based on 'filename', returns String
`static java.util.Collection`	`readEncodingfile(java.lang.String filename, java.lang.String encoding)` read file based on 'filename', returns collection of lines with no CR or LF.
`static java.util.Map<java.lang.String,java.lang.String>`	`readEncodingMap(java.lang.String filename, java.lang.String encoding)` read file based on 'filename', returns collection of lines with no CR or LF.
`static java.util.Collection`	`readfile(java.lang.String filename)` read file based on 'filename', returns collection of lines with no CR or LF.
`static java.lang.StringBuffer`	`readRawFile(java.lang.String filename)` read file based on 'filename', returns StringBuffer of file contents. The file is assumed to be in the default System character encoding.
`static java.lang.StringBuffer`	`readRawUTF8File(java.lang.String filename)` read file based on 'filename', returns StringBuffer of file contents. The file is assumed to be using UTF-8 character encoding.
`static java.util.Collection`	`readstring(java.lang.String str)` read string, returns collection of lines with no CR or LF.
`static java.util.Collection`	`readUTF8file(java.lang.String filename)` read file based on 'filename', returns collection of lines with no CR or LF.
`static java.lang.String`	`removeWrappingDoubleQuotes(java.lang.String expression)` Remove the leading and ending double quote.
`static java.lang.String`	`replaceChar(java.lang.String source, char toReplace, char by)` Replace a certain char by a new char in the source string.
`static java.lang.String`	`replaceJVMOptionValue(java.lang.String jvmOptions, java.lang.String option, java.lang.String value)` Replace the value of an option in the whole JVM options.
`static java.lang.String[]`	`replaceSeparator(java.lang.String originalSeparator, java.lang.String... params)` If the params contain the originalSeparator, then replace it by a different separator.
`static <T> boolean`	`reverseArray(T[] array)` Reverse an array.
`static java.lang.String`	`rightTrimSpace(java.lang.String text)` Trims all chars below char (int) 32 EXCEPT for TAB characters (int) 9 from the right side of the provided text string.
`static java.lang.String`	`stripFromEnv(java.lang.String envVar, java.lang.String[] toRemoves)`
`static java.lang.String`	`toStringWithAddress(java.lang.Object object)`
`static java.lang.String`	`urlEncode(java.lang.String content)` Encode URL or form-content.
`static java.lang.String`	`urlEncode(java.lang.String content, java.lang.String encoding)` Encode URL or form-content.
`static java.lang.String`	`urlEncode(java.lang.String content, java.lang.String encoding, char[] escapeChars)` Encode URL or form-content following the rule defined at application/x-www-form-urlencoded
`static java.lang.String`	`wildcardToRegex(java.lang.String wildcard)` Convert the wildcard string to regex expression.
`static java.lang.String`	`wildcardToRegex(java.lang.String wildcard, boolean matchLineBegin, boolean matchLineEnd)` Convert the wildcard string to regex expression. The wildcard * represents zero or more characters.
`static void`	`writeEncodingfile(java.lang.String filename, java.util.Collection list, java.lang.String encoding)` Note: The file will be opened as OutputStreamWriter with encoding write to file 'filename' the toString() values contained in list.
`static void`	`writeEncodingProperties(java.lang.String filename, java.util.Map<java.lang.String,java.lang.String> list, java.lang.String encoding)` Note: The file will be opened as OutputStreamWriter with encoding write to file 'filename' the toString() values contained in list.
`static void`	`writefile(java.lang.String filename, java.util.Collection list)` write to file 'filename' the toString() values contained in list.
`static void`	`writefile(java.lang.String filename, java.util.Collection list, java.lang.String delim)` Deprecated. for DatabaseUtils.writefile(String, Collection, String)
`static void`	`writeUTF8file(java.lang.String filename, java.util.Collection list)` Note: The file will be opened as UTF-8 OutputStreamWriter write to file 'filename' the toString() values contained in list.

Methods inherited from class org.safs.tools.stringutils.StringUtilities
charIsInRange, convertBool, convertToInteger, current, debugmsg, debugmsg, debugmsg, debugmsg, debugmsg, debugmsg, findAndReplace, formRectangle, getBoolean, getCallerClassName, getCallerID, getCallerName, getClassName, getCurrentMethodName, getDate, getDateString, getDateString, getDateTimeString, getDouble, getFloat, getIndex, getIndex, getInteger, getLong, getMethodName, getNumber, getNumSubstrings, getStackTraceElement, getString, getSubStrings, getSubStrings, getTimeString, getValue, isLegalVarName, isQuoted, isQuoted, isValidNonStdChar, locateNextNonWhiteSpace, locateNextSubstring, locateNextUnquotedNonWhiteSpace, locateNextUnquotedSingleChar, locateNextUnquotedSingleChar, locateNextUnquotedSubstring, locateNextUnquotedSubstring, locateQuotedSubStrings, LTWhitespace, nextCharIsDQ, parseIndex, parseIndex, removeAllNonQuotedWhitespace, removeAllNonQuotedWhitespace, removeDoubleQuotes, removePrefix, removeRelativeFilePathPrefix, removeSingleQuotes, removeSuffix, replaceString, reverse, RTWhitespace, sleep, spacePad, TWhitespace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHAR_DOT
```
public static final char CHAR_DOT
```
    character dot .
    
    See Also:
    
    Constant Field Values
  - CHAR_STAR
```
public static final char CHAR_STAR
```
    character star *
    
    See Also:
    
    Constant Field Values
  - CHAR_SLASH
```
public static final char CHAR_SLASH
```
    character slash /
    
    See Also:
    
    Constant Field Values
  - CHAR_QUOTE
```
public static final char CHAR_QUOTE
```
    character single quote '
    
    See Also:
    
    Constant Field Values
  - CHAR_DOUBLE_QUOTE
```
public static final char CHAR_DOUBLE_QUOTE
```
    character double quote "
    
    See Also:
    
    Constant Field Values
  - CHAR_BACK_SLASH
```
public static final char CHAR_BACK_SLASH
```
    character back slash \
    
    See Also:
    
    Constant Field Values
  - CHAR_NUMBER
```
public static final char CHAR_NUMBER
```
    character number #
    
    See Also:
    
    Constant Field Values
  - CHAR_COLON
```
public static final char CHAR_COLON
```
    character colon :
    
    See Also:
    
    Constant Field Values
  - CHAR_EQUAL
```
public static final char CHAR_EQUAL
```
    character equal =
    
    See Also:
    
    Constant Field Values
  - CHAR_AND
```
public static final char CHAR_AND
```
    character and &
    
    See Also:
    
    Constant Field Values
  - CHAR_INTERROGATION
```
public static final char CHAR_INTERROGATION
```
    character interrogation ?
    
    See Also:
    
    Constant Field Values
  - CHAR_CARET
```
public static final char CHAR_CARET
```
    character caret ^
    
    See Also:
    
    Constant Field Values
  - CHAR_DOLLAR
```
public static final char CHAR_DOLLAR
```
    character dollar $
    
    See Also:
    
    Constant Field Values
  - CHAR_PLUS
```
public static final char CHAR_PLUS
```
    '+'
    
    See Also:
    
    Constant Field Values
  - CHAR_MINUS
```
public static final char CHAR_MINUS
```
    '-'
    
    See Also:
    
    Constant Field Values
  - CHAR_COMMA
```
public static final char CHAR_COMMA
```
    ','
    
    See Also:
    
    Constant Field Values
  - CHAR_SEMI_COLON
```
public static final char CHAR_SEMI_COLON
```
    ';'
    
    See Also:
    
    Constant Field Values
  - CHAR_PERCENTAGE
```
public static final char CHAR_PERCENTAGE
```
    '%'
    
    See Also:
    
    Constant Field Values
  - CHAR_SPACE
```
public static final char CHAR_SPACE
```
    ' '
    
    See Also:
    
    Constant Field Values
  - WILDCARD_CHARS
```
public static final char[] WILDCARD_CHARS
```
    '*', '$'
  - REGEX_CHARACTER_ANY
```
public static final java.lang.String REGEX_CHARACTER_ANY
```
    "."
  - REGEX_CHARACTER_MATCH_MANY
```
public static final java.lang.String REGEX_CHARACTER_MATCH_MANY
```
    "*"
  - REGEX_CHARACTER_MATCH_ONE
```
public static final java.lang.String REGEX_CHARACTER_MATCH_ONE
```
    "?"
  - REGEX_ESCAPE_CHARACTER
```
public static final java.lang.Character REGEX_ESCAPE_CHARACTER
```
    '\'
  - SLASH
```
public static final java.lang.String SLASH
```
    string slash /
  - QUOTE
```
public static final java.lang.String QUOTE
```
    string single quote '
  - DOUBLE_QUOTE
```
public static final java.lang.String DOUBLE_QUOTE
```
    string double quote "
  - BACK_SLASH
```
public static final java.lang.String BACK_SLASH
```
    string back slash \
  - NUMBER
```
public static final java.lang.String NUMBER
```
    string number #
  - COLON
```
public static final java.lang.String COLON
```
    string colon :
  - DOT
```
public static final java.lang.String DOT
```
    string dot .
  - EQUAL
```
public static final java.lang.String EQUAL
```
    string equal =
  - AND
```
public static final java.lang.String AND
```
    string and &
  - INTERROGATION
```
public static final java.lang.String INTERROGATION
```
    string interrogation ?
  - CARET
```
public static final java.lang.String CARET
```
    string caret ^
  - DOLLAR
```
public static final java.lang.String DOLLAR
```
    string dollar $
  - PLUS
```
public static final java.lang.String PLUS
```
    "+"
  - MINUS
```
public static final java.lang.String MINUS
```
    "-"
  - COMMA
```
public static final java.lang.String COMMA
```
    ","
  - SEMI_COLON
```
public static final java.lang.String SEMI_COLON
```
    ";"
  - PERCENTAGE
```
public static final java.lang.String PERCENTAGE
```
    "%"
  - SPACE
```
public static final java.lang.String SPACE
```
    " "
  - maxBytesPerRead
```
public static final int maxBytesPerRead
```
    10000
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    1024*10
    
    See Also:
    
    Constant Field Values
  - specialKeys
```
public static final java.lang.String[] specialKeys
```
    "~", "+", "^", "%", "(", ")", "{", "}"
  - LOCAL_HOST
```
public static final java.lang.String LOCAL_HOST
```
    'localhost'
    
    See Also:
    
    Constant Field Values
  - LOCAL_HOST_IP
```
public static final java.lang.String LOCAL_HOST_IP
```
    '127.0.0.1'
    
    See Also:
    
    Constant Field Values
  - CASE_INSENSITIVE
```
public static final java.lang.String CASE_INSENSITIVE
```
    "CASE-INSENSITIVE"
    
    See Also:
    
    Constant Field Values
  - CASEINSENSITIVE
```
public static final java.lang.String CASEINSENSITIVE
```
    "CASEINSENSITIVE"
    
    See Also:
    
    Constant Field Values
  - NEW_LINE
```
public static final java.lang.String NEW_LINE
```
    "\n" new line string
    
    See Also:
    
    Constant Field Values
  - CRLF
```
public static final java.lang.String CRLF
```
    "\r\n" PC new line string
    
    See Also:
    
    Constant Field Values
  - CARRIAGE_RETURN
```
public static final java.lang.String CARRIAGE_RETURN
```
    "\r" carriage return
    
    See Also:
    
    Constant Field Values
  - CHARSET_UTF8
```
public static final java.lang.String CHARSET_UTF8
```
    "UTF-8" charset
    
    See Also:
    
    Constant Field Values
  - KEY_UTF8_CHARSET
```
public static final java.lang.String KEY_UTF8_CHARSET
```
    The charset used to translate the base64 encoded bytes to string, and translate that string back to base64 encoded bytes.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_PROXY_HOST
```
public static final java.lang.String SYSTEM_PROPERTY_PROXY_HOST
```
    'http.proxyHost'
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_PROXY_PORT
```
public static final java.lang.String SYSTEM_PROPERTY_PROXY_PORT
```
    'http.proxyPort'
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_PROXY_BYPASS
```
public static final java.lang.String SYSTEM_PROPERTY_PROXY_BYPASS
```
    'http.proxyBypass'
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_NON_PROXY_HOSTS
```
public static final java.lang.String SYSTEM_PROPERTY_NON_PROXY_HOSTS
```
    'http.nonProxyHosts'
    
    See Also:
    
    Constant Field Values
  - PROPERTY_START
```
public static java.lang.String PROPERTY_START
```
  - URL_ENCODING_IGNORE_CHARACTERS
```
public static final char[] URL_ENCODING_IGNORE_CHARACTERS
```
    An array defines the characters should not be encoded.
  - DEFAULT_X_COORDINATE
```
public static final int DEFAULT_X_COORDINATE
```
    '5', the default x coordinate in pixel.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_Y_COORDINATE
```
public static final int DEFAULT_Y_COORDINATE
```
    '5', the default y coordinate in pixel.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringUtils
```
public StringUtils()
```
- Method Detail
  - findMatchIndex
```
public static int findMatchIndex(java.util.ListIterator iter,
                                 java.lang.String match)
```
    Purpose: find a match based on the parameter by walking the list, finding a string which contains the matching substring, and returning the index into the list if it matched.
    Side Effects: The iterator will be moved to the appropriate item (one past), therefore, the value of the item can also be fetched with iter.previous()
    Assumptions: match is not null; All elements on the supporting List are of type String; first match will be considered the match, subsequent matches would therefore be ignored.
    
    Parameters:
    
    iter, - ListIterator
    
    match, - String
    
    Returns:
    
    index if match, -1 if no match
  - findExactMatchIndex
```
public static int findExactMatchIndex(java.util.ListIterator iter,
                                      java.lang.String match)
```
    Purpose: find an exact match based on the parameter by walking the list, finding a string which equals the matching string, and returning the index into the list if it matched.
    Side Effects: The iterator will be moved to the appropriate item (one past), therefore, the value of the item can also be fetched with iter.previous()
    Assumptions: match is not null; All elements on the supporting List are of type String; first match will be considered the match, subsequent matches would therefore be ignored.
    
    Parameters:
    
    iter, - ListIterator
    
    match, - String
    
    Returns:
    
    index if match, -1 if no match
  - isCaseSensitive
```
public static boolean isCaseSensitive(java.lang.String caseSensitiveStr)
```
    parse a string to tell if it represnet case insensitive.
  - isCaseContainsMatch
```
public static boolean isCaseContainsMatch(java.lang.String source,
                                          java.lang.String target,
                                          boolean exactMatch)
```
    Purpose: evaluate 2 string values to see if they match. If exactMatch is true, then the 2 strings must match exactly. If exactMatch is false, then we will not only ignore case, but the source string can merely be a substring appearing anywhere in the target.
    
    Parameters:
    
    source, - String to match against target. Can be a case-insensitive substring of target if exactMatch is false.
    
    target, - String to compare with source.
    
    exactMatch, - false allows a case-insensitive comparison for a source substring in target. Otherwise, the source and target must match exactly.
    
    Returns:
    
    true for a match as described above or if *both* source and target are null. false if no match as described above or if either source or target are null.
  - getSpaces
```
public static java.lang.String getSpaces(java.lang.Integer num)
```
    Purpose: get a string with the number of specified spaces
    
    Parameters:
    
    num - Integer
    
    Returns:
    
    String with spaces
  - getChars
```
public static java.lang.String getChars(java.lang.Integer num,
                                        java.lang.String chars)
```
    Purpose: get a string with the number of specified sequenced 'chars'
    
    Parameters:
    
    num - Integer
    
    chars - String
    
    Returns:
    
    String with spaces
  - readfile
```
public static java.util.Collection readfile(java.lang.String filename)
                                     throws java.io.IOException
```
    read file based on 'filename', returns collection of lines with no CR or LF. The file is assumed to be in the default System character encoding.
    
    Parameters:
    
    filename, - String
    
    Returns:
    
    Collection (instance of type ArrayList)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getSystemBufferedFileReader(String), readBuffer(BufferedReader)
  - readRawFile
```
public static java.lang.StringBuffer readRawFile(java.lang.String filename)
                                          throws java.io.IOException
```
    read file based on 'filename', returns StringBuffer of file contents.
    The file is assumed to be in the default System character encoding.
    
    Parameters:
    
    filename, - String
    
    Returns:
    
    StringBuffer
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getSystemBufferedFileReader(String), readRawBuffer(BufferedReader)
  - readUTF8file
```
public static java.util.Collection readUTF8file(java.lang.String filename)
                                         throws java.io.IOException
```
    read file based on 'filename', returns collection of lines with no CR or LF. The file is assumed to be using UTF-8 character encoding.
    
    Parameters:
    
    filename, - String
    
    Returns:
    
    Collection (instance of type ArrayList)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getUTF8BufferedFileReader(String), readBuffer(BufferedReader)
  - readRawUTF8File
```
public static java.lang.StringBuffer readRawUTF8File(java.lang.String filename)
                                              throws java.io.IOException
```
    read file based on 'filename', returns StringBuffer of file contents.
    The file is assumed to be using UTF-8 character encoding.
    
    Parameters:
    
    filename, - String
    
    Returns:
    
    StringBuffer
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getUTF8BufferedFileReader(String), readRawBuffer(BufferedReader)
  - readEncodingfile
```
public static java.util.Collection readEncodingfile(java.lang.String filename,
                                                    java.lang.String encoding)
                                             throws java.io.IOException
```
    read file based on 'filename', returns collection of lines with no CR or LF. The file is assumed to be using character encoding indicated by parameter.
    
    Parameters:
    
    filename, - String
    
    encoding, - the character encoding used to read a file.
    
    Returns:
    
    Collection (instance of type ArrayList)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getUTF8BufferedFileReader(String), readBuffer(BufferedReader)
  - readEncodingMap
```
public static java.util.Map<java.lang.String,java.lang.String> readEncodingMap(java.lang.String filename,
                                                                               java.lang.String encoding)
                                                                        throws java.io.IOException
```
    read file based on 'filename', returns collection of lines with no CR or LF. The file is assumed to be using character encoding indicated by parameter.
    
    Parameters:
    
    filename, - String
    
    encoding, - the character encoding used to read a file.
    
    Returns:
    
    Collection (instance of type ArrayList)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    FileUtilities.getUTF8BufferedFileReader(String), readBuffer(BufferedReader)
  - encodeBase64Object
```
public static java.lang.String encodeBase64Object(java.lang.Object object)
                                           throws java.lang.IllegalThreadStateException
```
    Encode the object to a string with charset "UTF-8".
    
    Parameters:
    
    object, - Object an object must implements interface Serializable.
    
    Returns:
    
    String, the base64 encoded string with charset "UTF-8"
    
    Throws:
    
    java.lang.IllegalThreadStateException
    
    See Also:
    
    #decodeBase64Object(String)}
  - decodeBase64Object
```
public static java.lang.Object decodeBase64Object(java.lang.String base64String)
                                           throws java.lang.IllegalThreadStateException
```
    Decode a string to object with charset "UTF-8".
    
    Parameters:
    
    base64String, - String, the base64 encoded string with charset "UTF-8"
    
    Returns:
    
    Object, an object who implements interface Serializable.
    
    Throws:
    
    java.lang.IllegalThreadStateException
    
    See Also:
    
    #encodeBase64Object(Object)}
  - isMatchingMaps
```
public static boolean isMatchingMaps(java.util.Map<java.lang.String,java.lang.String> source,
                                     java.util.Map<java.lang.String,java.lang.String> target)
```
    Parameters:
    
    source -
    
    target -
    
    Returns:
    
    true if both Maps have the same number of keys and matching key values.
  - isMatchingTargetMapValues
```
public static boolean isMatchingTargetMapValues(java.util.Map<java.lang.String,java.lang.String> source,
                                                java.util.Map<java.lang.String,java.lang.String> target)
```
    Compares 2 Maps, but only cares about matching those key/value items that exist in the target/benchmark. The source can have additional key/value pairs that are ignored.
    
    Parameters:
    
    source - -- runtime Map to be compared against the target/benchmark.
    
    target - -- benchmark to be compared against.
    
    Returns:
    
    true if source map values match target map values for those keys in the target/benchmark.
  - readstring
```
public static java.util.Collection readstring(java.lang.String str)
                                       throws java.io.IOException
```
    read string, returns collection of lines with no CR or LF. This essentially splits the String at line separators into an array of Strings.
    
    Parameters:
    
    str, - String,
    
    Returns:
    
    Collection (instance of type ArrayList)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    StringReader, BufferedReader.readLine()
  - readBinaryFile
```
public static java.lang.StringBuffer readBinaryFile(java.lang.String filename)
                                             throws java.io.IOException
```
    Purpose: read Binary file based on 'filename', returns String
    
    Parameters:
    
    filename, - String
    
    Returns:
    
    String NOTE: I believe that there is a bug in the java class(es) BufferedReader/FileReader when reading certain characters from a binary file. Therefore, the implementation here is with the older BufferedInputStream/FileInputStream classes, which, through exhaustive testing, I find to do a better job of reading in binary characters.
    
    Throws:
    
    java.io.IOException
  - writefile
```
public static void writefile(java.lang.String filename,
                             java.util.Collection list)
                      throws java.io.IOException
```
    write to file 'filename' the toString() values contained in list. Each item is written as a separate line using '\n' as the line separator regardless of operating system. Values are written in the system default character encoding.
    
    Parameters:
    
    filename - String full absolute path filename of file to write.
    
    list - Collection of lines to write.
    
    Throws:
    
    java.io.FileNotFoundException - if file cannot be created for any reason.
    
    java.io.IOException - if an error occurs during write operations.
    
    See Also:
    
    FileUtilities.getSystemBufferedFileWriter(String), FileUtilities.writeCollectionToFile(BufferedWriter, Collection, String)
  - writeUTF8file
```
public static void writeUTF8file(java.lang.String filename,
                                 java.util.Collection list)
                          throws java.io.IOException
```
    Note: The file will be opened as UTF-8 OutputStreamWriter write to file 'filename' the toString() values contained in list. Each item is written as a separate line using '\n' as the line separator regardless of operating system. Values are written in the UTF-8 encoding.
    
    Parameters:
    
    filename - String full absolute path filename of file to write.
    
    list - Collection of lines to write.
    
    Throws:
    
    java.io.FileNotFoundException - if file cannot be created for any reason.
    
    java.io.IOException - if an error occurs during write operations.
    
    See Also:
    
    FileUtilities.getSystemBufferedFileWriter(String), FileUtilities.writeCollectionToFile(BufferedWriter, Collection, String)
  - writeEncodingfile
```
public static void writeEncodingfile(java.lang.String filename,
                                     java.util.Collection list,
                                     java.lang.String encoding)
                              throws java.io.IOException
```
    Note: The file will be opened as OutputStreamWriter with encoding write to file 'filename' the toString() values contained in list. Each item is written as a separate line using '\n' as the line separator regardless of operating system. Values are written in the encoding indicated by parameter
    
    Parameters:
    
    filename - String full absolute path filename of file to write.
    
    list - Collection of lines to write.
    
    encoding - Encoding is used to write a file.
    
    Throws:
    
    java.io.FileNotFoundException - if file cannot be created for any reason.
    
    java.io.IOException - if an error occurs during write operations.
    
    See Also:
    
    FileUtilities.getSystemBufferedFileWriter(String), FileUtilities.writeCollectionToFile(BufferedWriter, Collection, String)
  - convertCollectionToMap
```
public static java.util.Map<java.lang.String,java.lang.String> convertCollectionToMap(java.util.Collection<java.lang.String> contents,
                                                                                      java.lang.String sep)
```
    Convert a collection of text entries formatted as name=value into a Map file. Each item in the collection has potential linebreaks "normalized".
    
    Parameters:
    
    contents -
    
    sep - the separator used to delimit the name from the value
    
    Returns:
    
    Map
    
    See Also:
    
    normalizeLineBreaks(String)
  - writeEncodingProperties
```
public static void writeEncodingProperties(java.lang.String filename,
                                           java.util.Map<java.lang.String,java.lang.String> list,
                                           java.lang.String encoding)
                                    throws java.io.IOException
```
    Note: The file will be opened as OutputStreamWriter with encoding write to file 'filename' the toString() values contained in list. Each property is written as in a special format allowing for multi-line property values. Values are written in the encoding indicated by parameter
    
    Parameters:
    
    filename - String full absolute path filename of file to write.
    
    list - Properties to write.
    
    encoding - Encoding is used to write a file.
    
    Throws:
    
    java.io.FileNotFoundException - if file cannot be created for any reason.
    
    java.io.IOException - if an error occurs during write operations.
    
    See Also:
    
    FileUtilities.getSystemBufferedFileWriter(String), FileUtilities#writePropertiesFile(BufferedWriter, Properties)
  - writefile
```
@Deprecated
public static void writefile(java.lang.String filename,
                                          java.util.Collection list,
                                          java.lang.String delim)
                                   throws java.io.IOException
```
    Deprecated. for DatabaseUtils.writefile(String, Collection, String)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    DatabaseUtils.writefile(String, Collection, String)
  - getDBVal
```
@Deprecated
public static java.lang.String getDBVal(java.lang.Object m)
```
    Deprecated. for DatabaseUtils.getDBVal(Object)
    
    See Also:
    
    DatabaseUtils.getDBVal(Object)
  - leftTrimSpace
```
public static java.lang.String leftTrimSpace(java.lang.String text)
```
    Trims all chars below char (int) 32 EXCEPT for TAB char (int) 9 from the left side of the provided text string. Does not modify the input text string.
    
    Returns:
    
    a new trimmed string if changes were made, or the text string passed as input if no changes were made, or null if the provided text was null.
  - rightTrimSpace
```
public static java.lang.String rightTrimSpace(java.lang.String text)
```
    Trims all chars below char (int) 32 EXCEPT for TAB characters (int) 9 from the right side of the provided text string. Does not modify the input text string.
    
    Returns:
    
    a new trimmed string if changes were made, or the text string passed as input if no changes were made, or null if the provided text was null.
  - getTrimmedUnquotedStr
```
public static java.lang.String getTrimmedUnquotedStr(java.lang.String str)
```
    Purpose: This method takes a string trims it of leading and trailing spaces, non-breaking spaces, and tabs, and then strips one leading and/or trailing quotation mark(#34)--if they exist.
    
    Parameters:
    
    str, - String to unquote
    
    Returns:
    
    String result, null if str was null
  - concat
```
public static java.lang.String concat(java.lang.String s1,
                                      java.lang.String s2,
                                      java.lang.String s3)
```
    Purpose: concatenate strings
    
    Parameters:
    
    s1, - String
    
    s2, - String
    
    s3, - String
    
    Returns:
    
    s1+s2+s3
  - concatURL
```
public static java.lang.String concatURL(java.lang.String baseURL,
                                         java.lang.String relativeURI)
```
    Parameters:
    
    baseURL - String
    
    relativeURI - String
    
    Returns:
    
    String the concatenated URL string.
  - convertWildcardsToRegularExpression
```
public static java.lang.String convertWildcardsToRegularExpression(java.lang.String input)
```
    convert ? and * wildcarding to regular expression wildcarding .? and .*
  - matchRegex
```
public static boolean matchRegex(java.lang.String expression,
                                 java.lang.String value)
                          throws SAFSException
```
    Purpose: match a regular expression to a value.
    Assumptions: tries first jdk 1.4 built in java.util.regex.Pattern class, then the jakarta org.apache.regexp.RE class. If either are found, it tries to keep static methods and/or instances around so that reflection is minimized the next time around.
    
    Parameters:
    
    expression, - String
    
    value, - String
    
    Returns:
    
    boolean, true if match, false otherwise
    
    Throws:
    
    SAFSRegExException - if an error occurs.
    
    SAFSRegExNotFoundException - if no RegEx support class can be found.
    
    SAFSException
  - matchText
```
public static boolean matchText(java.lang.String actualText,
                                java.lang.String expectedText,
                                boolean partialMatch,
                                boolean ignoreCase)
```
    match a text(provided as fullstring, substing, regex, wildcard) against
    the actual text got from application component(list, menu, tree, tab etc.)
    
    Parameters:
    
    actualText - String, the actual text of the component's label
    
    expectedText - String, the expected text, it can be full-string, sub-string, regex or wildcard string.
    
    partialMatch - boolean, if the expectedText is provided as sub-string
    
    ignoreCase - boolean, if the texts are case in-sensitive to compare
    
    Returns:
    
    boolean, true if matched.
  - getSortArray
```
public static java.lang.String[] getSortArray(java.lang.String[] inp)
```
  - getInputToken
```
public static java.lang.String getInputToken(java.lang.String input,
                                             int n,
                                             java.lang.String sep)
                                      throws SAFSNullPointerException
```
    Purpose: get 0-based field N of input by tokenizing with sep. We use a SAFSStringTokenizer. The first field is field #0.
    
    Parameters:
    
    input, - String
    
    n, - int 0-based index
    
    sep, - String
    
    Returns:
    
    token
    
    Throws:
    
    SAFSNullPointerException - if input or sep are null
    
    java.lang.StringIndexOutOfBoundsException - if not found for index n
  - getFieldCount
```
public static int getFieldCount(java.lang.String input,
                                int startindex,
                                java.lang.String seps)
                         throws SAFSNullPointerException
```
    Purpose: Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
    
    Parameters:
    
    input, - String
    
    startindex, - int
    
    seps, - String
    
    Returns:
    
    count
    
    Throws:
    
    SAFSNullPointerException - if input or sep are null
  - arrayToList
```
public static <T> java.util.List<T> arrayToList(T[] array)
```
    As the List returned by Arrays.asList() does not support remove operation.
    So we provide this method ourselves.
    
    Parameters:
    
    array - T[], an array containing some value
    
    Returns:
    
    List, the converted list
  - getTrimmedTokenList
```
public static java.util.List<java.lang.String> getTrimmedTokenList(java.lang.String text,
                                                                   java.lang.String delimiter)
```
    Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string. If the tokens contain any leading/ending spaces, they will be removed.
    
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    Returns:
    
    List, a list of tokens
    
    See Also:
    
    getTrimmedTokenList(String, String, Character)
  - getTrimmedTokenList
```
public static java.util.List<java.lang.String> getTrimmedTokenList(java.lang.String text,
                                                                   java.lang.String delimiter,
                                                                   java.lang.Character escapeChar)
```
    Purpose: Get tokens of text separated by delimiter, delimiter will be considered as a whole string, if some token contains the delimiter, user needs to escape the delimiter. If the tokens contain any leading/ending spaces, they will be removed.
    
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    escapeChar - Character, the char to escape the delimiter
    
    Returns:
    
    List, a list of tokens
    
    See Also:
    
    getTokenList(String, String, Character)
  - getTokenList
```
public static java.util.List<java.lang.String> getTokenList(java.lang.String text,
                                                            java.lang.String delimiter)
```
    Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string
    Example: If delimiter is "->", text is "parent->child->grandChild", then the returned list will contains
    3 items: "parent", "child" and "grandChild".
    
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    Returns:
    
    List, a list of tokens
    
    See Also:
    
    getTokenList(String, String, Character)
  - getTokenList
```
public static java.util.List<java.lang.String> getTokenList(java.lang.String text,
                                                            java.lang.String delimiter,
                                                            java.lang.Character escapeChar)
```
    Purpose: Get tokens of text delimited by delimiter, delimiter will be considered as a whole string, if some token contains the delimiter, user needs to escape the delimiter.
    Example: If delimiter is "=", text is "css=input[name*='sf.c']", then the returned list will contains
    3 items: "css", "input[name*" and "'sf.c']";
    But if user wants "input[name*='sf.c']" as one whole token, then he needs to escape the delimiter,
    specify the text as css=input[name*\='sf.c'], and call this method with '\' for parameter escapeChar,
    then the result will be 2 items: "css" and "input[name*='sf.c']".
    Note: Nothing MUST NOT appear between 'escape char' and 'delimiter'.
    
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    escapeChar - Character, the char to escape the delimiter
    
    Returns:
    
    List, a list of tokens
  - getTokenArray
```
public static java.lang.String[] getTokenArray(java.lang.String text,
                                               java.lang.String delimiter)
```
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    Returns:
    
    an array of string tokens
    
    See Also:
    
    getTokenList(String, String, Character)
  - getTokenArray
```
public static java.lang.String[] getTokenArray(java.lang.String text,
                                               java.lang.String delimiter,
                                               java.lang.Character escapeChar)
```
    Parameters:
    
    text - String, the delimited string
    
    delimiter - String, the delimiter
    
    escapeChar - Character, the char to escape the delimiter
    
    Returns:
    
    an array of string tokens
    
    See Also:
    
    getTokenList(String, String, Character)
  - getLastDelimitedToken
```
public static java.lang.String getLastDelimitedToken(java.lang.String delimitedString,
                                                     java.lang.String delimiter)
```
    Parameters:
    
    delimitedString - String, the delimited string
    
    delimiter - String, the delimiter
    
    Returns:
    
    String, the last token of the delimited string
  - getDelimitedString
```
public static java.lang.String getDelimitedString(java.util.List<java.lang.String> list,
                                                  java.lang.String delimiter)
```
    Purpose: Get text strung delimited by delimiter from a list, delimiter will be considered as a whole string
    Example: If delimiter is "->", if the list contains 3 items, "parent" "child" "grandChild"
    the returned text is "parent->child->grandChild"
    
    Parameters:
    
    list -
    
    delimiter -
    
    Returns:
  - containsSepcialKeys
```
public static boolean containsSepcialKeys(java.lang.String value)
```
  - urlEncode
```
public static java.lang.String urlEncode(java.lang.String content)
```
    Encode URL or form-content. The encoding is CHARSET_UTF8, and the escape characters are URL_ENCODING_IGNORE_CHARACTERS.
    
    Parameters:
    
    content - String, the URL or form-content to encode
    
    Returns:
    
    String, the encoded string
    
    See Also:
    
    urlEncode(String, String, char[])
  - urlEncode
```
public static java.lang.String urlEncode(java.lang.String content,
                                         java.lang.String encoding)
```
    Encode URL or form-content. The escape characters are URL_ENCODING_IGNORE_CHARACTERS.
    
    Parameters:
    
    content - String, the URL or form-content to encode
    
    encoding - String, the encoding to use
    
    Returns:
    
    String, the encoded string
    
    See Also:
    
    urlEncode(String, String, char[])
  - urlEncode
```
public static java.lang.String urlEncode(java.lang.String content,
                                         java.lang.String encoding,
                                         char[] escapeChars)
```
    Encode URL or form-content following the rule defined at application/x-www-form-urlencoded
    
    Parameters:
    
    content - String, the URL or form-content to encode
    
    encoding - String, the encoding to use
    
    escapeChars - char[], an array of characters to escape, which means these characters will not be encoded.
    
    Returns:
    
    String, the encoded string
  - contains
```
public static boolean contains(java.lang.String content,
                               char[] characters)
```
    check if a string contains one of characters given by an array.
    
    Parameters:
    
    content - String, the string to check
    
    characters - char[], an array of characters
    
    Returns:
    
    boolean, if the content contains one of character in parameter characters.
  - arrayToString
```
public static java.lang.String arrayToString(java.lang.Object[] values)
```
    Convert an array to a string, which contains the array's value separated by a space.
    
    Parameters:
    
    values - Object[], the array to convert
    
    Returns:
    
    String, the array's value separated by a space.
    
    See Also:
    
    Arrays.toString(Object[])
  - arrayToString
```
public static java.lang.String arrayToString(java.lang.Object[] values,
                                             java.lang.String delimiter)
```
    Convert an array to a string, which contains the array's value separated by parameter delimiter.
```
 For example:
 String[] numbers = {"one", "two", "three"};
 System.out.println(arrayToString(numbers, "$"));//one$two$three
 System.out.println(arrayToString(numbers, "^"));//one^two^three
 
```
    Parameters:
    
    values - Object[], the array to convert
    
    delimiter - String, used to separate each value from the array in the final string.
    
    Returns:
    
    String, the array's value separated by parameter delimiter
  - convertNum
```
public static java.lang.Integer convertNum(java.lang.String num)
```
    Purpose: convertNum: convert into a number
    Assumptions: all exceptions are handled.
    
    Parameters:
    
    numStr, - String (indexed from 1, 1 will be subtracted from the number before returned)
    
    Returns:
    
    Integer if successful, null otherwise (if alpha chars instead of digits are encountered; or if number is less than one)
  - parseFloat
```
public static float parseFloat(java.lang.String floatNumber)
```
    Convert s String float number (such as 35%, 0.68, 23, 5.4 etc.) into float.
    
    Parameters:
    
    floatNumber - String, the String float number need to be converted
    
    Returns:
    
    float, the converted float number.
    NumberFormatException will be thrown out if the parameter is not valid.
  - extractCoordStringPair
```
@Deprecated
public static java.lang.String[] extractCoordStringPair(java.lang.String coords)
```
    Deprecated. call convertCoordsToArray(String, int), which is more generic.
    Extract coordinate String pair, String[], from coordinate string formats:
    - "x;y"
    - "x,y"
    - "x y"
    - "Coords=x;y"
    - "Coords=x,y"
    - "Coords=x y"
    Parameters:
    
    coords - String, x;y or x,y or Coords=x;y or Coords=x,y
    
    Returns:
    
    String[], String pair if successful, null otherwise
  - convertCoords
```
public static java.awt.Point convertCoords(java.lang.String[] coordsPair,
                                           java.awt.Rectangle compRect)
```
    Convert the coordinate (given by array of String) into java.awt.Point format.
    
    The 'coordinate' could be provided in 2 formats:
    It could be number, such as [12, 15], [5, 10]. With this format the second parameter 'compRect' is not needed (could be provided as null).
    Or it could be in percentage format, such as [30%, 45%], [0.25, 0.8], [-30%, -45%], [-0.25, -0.8]. With this format, the second parameter 'compRect' SHOULD be provided, and the width and height of component rectangle are necessary.
    
    Parameters:
    
    coordsPair - String[], the 2 dimension array representing the [x,y] coordinate.
    
    compRect - Rectangle, it represents the component relative to which the coordinate will be calculated.
    Only the width and height will be counted, the rectangle x,y position will not be used.
    NOTE: If 'compRect' is not null, then the parameter 'coordsPair' will be considered as offset, if the offset is between -1 and 1, the offset will be considered as percentage; otherwise, the offset will be considered as an absolute coordinate to add or minus.
    
    Returns:
    
    java.awt.Point, the converted coordinate relative to the component
  - convertCoords
```
public static java.awt.Point convertCoords(java.lang.String[] coordsPair)
```
    Convert the coordinate (given by array of String) into java.awt.Point format.
    
    Parameters:
    
    coordsPair - String[], a 2 dimension array containing [x,y] to be converted.
    
    Returns:
    
    java.awt.Point coordinate if successful, null otherwise
  - convertCoords
```
public static java.awt.Point convertCoords(java.lang.String coords)
```
    Convert coordinates string formats:
    - "x;y"
    - "x,y"
    - "x y"
    - "Coords=x;y"
    - "Coords=x,y"
    - "Coords=x y"
    into a java.awt.Point object.
    Subclasses may override to convert alternative values, such as Row and Column values as is done in org.safs.rational.CFTable
    Parameters:
    
    coords - String, x;y or x,y or Coords=x;y or Coords=x,y
    
    Returns:
    
    java.awt.Point if successful, null otherwise
    
    See Also:
    
    extractCoordStringPair(String), convertCoords(String[]), convertCoordsToArray(String, int)
  - convertLine
```
public static java.awt.Polygon convertLine(java.lang.String coords)
```
    Convert 2-point Line coordinates string of the formats:
    - "x1;y1;x2;y2"
    - "x1,y1,x2,y2"
    - "x1 y1 x2 y2"
    - "Coords=x1;y1;x2;y2"
    - "Coords=x1,y1,x2,y2"
    - "Coords=x1 y1 x2 y2"
    into a java.awt.Polygon object.
    Parameters:
    
    coords - String, x1;y1;x2;y2 or x1,y1,x2,y2 or Coords=x1;y1;x2;y2 or Coords=x1,y1,x2,y2
    
    Returns:
    
    Polygon if successful, null otherwise
  - convertCoordsToArray
```
public static java.lang.String[] convertCoordsToArray(java.lang.String coords,
                                                      int length)
```
    Convert coordinates string of the formats:
    - "x1;y1;x2;y2"
    - "x1,y1,x2,y2"
    - "x1 y1 x2 y2"
    - "x1;y1;x2;y2;x3;y3;x4;y4"
    - "Coords=x1;y1;x2;y2"
    - "Coords=x1,y1,x2,y2"
    - "Coords=x1 y1 x2 y2"
    - "Coords=x1 y1 x2 y2 x3 y3 x4 y4"
    into an array object.
    Parameters:
    
    coords - String, x1;y1;x2;y2 or x1,y1,x2,y2 or Coords=x1;y1;x2;y2 or Coords=x1,y1,x2,y2
    
    length - int, the number of token contained in the first parameter coords.
    
    Returns:
    
    String[] an array of coordinates if successful, null otherwise.
  - replaceChar
```
public static java.lang.String replaceChar(java.lang.String source,
                                           char toReplace,
                                           char by)
```
    Replace a certain char by a new char in the source string.
    
    Parameters:
    
    source - String, the source string
    
    toReplace - char, the char to replace
    
    by - char, the char used to replace the old char.
    
    Returns:
    
    String
  - replaceSeparator
```
public static java.lang.String[] replaceSeparator(java.lang.String originalSeparator,
                                                  java.lang.String... params)
```
    If the params contain the originalSeparator, then replace it by a different separator.
    
    Parameters:
    
    originalSeparator - String, the original separator to search in parameters
    
    params - String..., an array of parameter
    
    Returns:
    
    String[], an array of parameter with new separator
  - generatePositionSepeartor
```
public static java.lang.String generatePositionSepeartor(java.lang.String stepSeparator)
```
    Generate a separator different from 'step separator', and it can be used to separate
    the coordinates for the position parameter in a test record.
    
    Parameters:
    
    stepSeparator - String, the separator in the step test record.
    
    Returns:
    
    String, a separator different from 'step separator'
  - parseSeparator
```
public static java.lang.String parseSeparator(java.lang.String input)
```
    Parse a string to get the separator.
    - "x;y;width;height;status"
    - "x,y,width,height,status"
    - "x y width height status"
    - "x1;y1;x2;y2"
    - "x1,y1,x2,y2"
    - "x1 y1 x2 y2"
    Parameters:
    
    input - String, the string to parse
    
    Returns:
    
    String, the separator
  - getFirstLine
```
public static java.lang.String getFirstLine(java.lang.String content)
```
    Parameters:
    
    content - String, multiple lines, delimited by "\n"
    
    Returns:
    
    String, the first line of content
  - reverseArray
```
public static <T> boolean reverseArray(T[] array)
```
    Reverse an array.
    
    Parameters:
    
    array - T[], the array to reverse.
    
    Returns:
    
    boolean, true if the reverse has been done successfully.
  - deduceUnusedSeparatorString
```
public static java.lang.String deduceUnusedSeparatorString(java.lang.String expression)
```
    Decide what is the best separator to use for a record from a possible separator list: TestRecordData.POSSIBLE_SEPARATOR.
    
    Parameters:
    
    expression - String, to examine to find which of the separators does NOT exist inside the expression.
    
    Returns:
    
    a single String sep, or null if the expression contains a character of every possible separator.
  - deduceUsedSeparatorString
```
public static java.lang.String deduceUsedSeparatorString(java.lang.String expression)
```
    Deduce the separator used in the expression, it tries each possible separator in list TestRecordData.POSSIBLE_SEPARATOR and return the first used one.
    
    Parameters:
    
    expression - String, to examine to find which separator does exist inside the expression.
    
    Returns:
    
    a single String sep, or null if the expression does NOT contain any character of possible separators.
  - getUniqueSep
```
public static java.lang.String getUniqueSep(java.lang.String sep,
                                            java.lang.String command,
                                            java.lang.String... params)
```
    Get a separator NOT appear in command neither in params; if no such separator
    can be found, then the default separator will be return.
    
    Parameters:
    
    sep - String, the default separator
    
    command - String, the command
    
    params - String[], the parameters
    
    Returns:
    
    String, an appropriate separator
  - removeWrappingDoubleQuotes
```
public static java.lang.String removeWrappingDoubleQuotes(java.lang.String expression)
```
    Remove the leading and ending double quote.
    
    Parameters:
    
    expression -
    
    Returns:
    
    String
    
    See Also:
    
    #processExpression(String), #processExpression(String, String)
  - quote
```
public static java.lang.String quote(java.lang.String parameter)
```
    Add double-quote around a string value. For "combine-word", the result is "\"combine-word\"";
    
    Parameters:
    
    parameter - String, the string to be double-quoted.
    
    Returns:
    
    String
  - isQuoted
```
public static boolean isQuoted(java.lang.String value)
```
    Test if the value is double-quoted or not.
    
    Parameters:
    
    value - String, the string value to be tested.
    
    Returns:
    
    boolean, true if the value is double-quoted.
  - normalizeLineBreaks
```
public static java.lang.String normalizeLineBreaks(java.lang.String source)
```
    Normalize potential line breaks:
```
   CRLF,
   CARRIAGE_RETURN,
 
```
    into a single uniform NEW_LINE linebreak.
    Parameters:
    
    source -
    
    Returns:
    
    String with all linebreaks normalized to NEW_LINE.
  - breakXpath
```
public static java.lang.String[] breakXpath(java.lang.String xpath,
                                            boolean onlyLeaf,
                                            boolean rootToLeaf)
```
    Break the xpath into multiple xparts by slash and return these xparts as an array.
    The slash between quote or double-quote will not be considered as separator of xpart.
    
    Parameters:
    
    xpath - String, the xpath
    
    onlyLeaf - boolean, if we only need to get the leaf
    
    rootToLeaf - boolean, true if we want the list begins with root, ends with leaf; false otherwise.
    
    Returns:
    
    String[] the array containing xparts of an xpath
  - getParentXpath
```
public static java.lang.String getParentXpath(java.lang.String xpath)
```
    Return the parent part of an xpath. If this xpath doesn't have a parent then "" or "//" etc. will be returned.
    
    Parameters:
    
    xpath - String, the xpath to parse
    
    Returns:
    
    String, the parent part of an xpath
  - getSystemProperty
```
public static java.lang.String getSystemProperty(java.lang.String property,
                                                 ConfigureInterface config,
                                                 java.lang.String section,
                                                 java.lang.String key,
                                                 java.lang.String... defaultValue)
```
```
 Get the value of a property from system properties and Set a value from the configuration to System-Properties.
 If the System-Properties contains the 'property',
   keep the value in the System-Properties (don't override by the value from ConfigureInterface).
 Otherwise,
   if the System-Properties does NOT contain the 'property', then get the value from the ConfigureInterface,
   if the value is null or empty, assign the 'default value' if it is provided. Finally set this value to System-Properties.
 
```
    Parameters:
    
    property - String, The property name in System-Properties.
    
    config - ConfigureInterface, containing the configuration initial parameters
    
    section - String, The section name in the ConfigureInterface
    
    key - String, The key name in the ConfigureInterface
    
    defaultValue - String[], String[0] is the default value if no value can be got from system-properties and config.
    
    Returns:
    
    String, the value of the property.
  - isValid
```
public static boolean isValid(java.lang.String value)
```
    Parameters:
    
    value - String, the string value to test
    
    Returns:
    
    boolean, true if the value is not null and is not empty.
  - parseBoolean
```
public static boolean parseBoolean(java.lang.String booleanString)
                            throws SAFSParamException
```
    Parameters:
    
    booleanString, - the boolean string to parse.
    
    Returns:
    
    boolean, the boolean value, parsed result of the parameter 'booleanString'.
    
    Throws:
    
    SAFSParamException - if the parameter 'booleanString' is not a valid boolean string.
  - generateUniqueName
```
public static java.lang.String generateUniqueName(java.lang.String prefix)
```
    Generate a unique name. For example, it can be used as a javascript variable name
    when calling functions in JavaScriptFunctions to avoid the conflict with variables defined
    in the Application Under Test.
    
    Parameters:
    
    prefix - String, the prefix of the unique name
    
    Returns:
    
    String, the unique name
  - replaceJVMOptionValue
```
public static java.lang.String replaceJVMOptionValue(java.lang.String jvmOptions,
                                                     java.lang.String option,
                                                     java.lang.String value)
```
    Replace the value of an option in the whole JVM options.
    
    Parameters:
    
    jvmOptions - String, the JVM options to modify
    
    option - String, the JVM option to replace
    
    value - String, the new value to use
    
    Returns:
    
    String, the options replaced by new value
  - getMemoryAddress
```
public static java.lang.String getMemoryAddress(java.lang.Object object)
```
    Get the object's memory address according to the method hashCode().
    Note: The method hashCode() should not be overridden.
    
    Parameters:
    
    object - Object, the object to get memory address for.
    
    Returns:
    
    String, the memory address
  - toStringWithAddress
```
public static java.lang.String toStringWithAddress(java.lang.Object object)
```
    Parameters:
    
    object - Object, the object to get string
    
    Returns:
    
    String, the object's string format with memory address.
  - getStackInfo
```
public static java.lang.String getStackInfo(java.util.Stack<?> stack)
```
    Parameters:
    
    stack - Stack, a stack holding some objects.
    
    Returns:
    
    String, the string format of the stack,
    
    See Also:
    
    toStringWithAddress(Object)
  - wildcardToRegex
```
public static java.lang.String wildcardToRegex(java.lang.String wildcard)
```
    Convert the wildcard string to regex expression.
    
    Parameters:
    
    wildcard - String, the wildcard string.
    
    Returns:
    
    String, the regex string
  - wildcardToRegex
```
public static java.lang.String wildcardToRegex(java.lang.String wildcard,
                                               boolean matchLineBegin,
                                               boolean matchLineEnd)
```
    Convert the wildcard string to regex expression.
    The wildcard * represents zero or more characters. It will be replaced by .*
    The wildcard ? represents ONE of any characters. It will be replaced by .
    
    Parameters:
    
    wildcard - String, the wildcard string
    
    matchLineBegin - boolean, add ^ at the beginning of regex string
    
    matchLineEnd - boolean, add $ at the end of regex string
    
    Returns:
    
    String, the converted regex expression
  - processEmbeddedVariables
```
public static java.lang.String processEmbeddedVariables(java.lang.String stringContainingVariables)
```
    Replace the embedded variables inside a string.
    Embedded variables are in the form %VARIABLE_NAME% and will be sought as System Properties, or System Environment variables.
    
    Parameters:
    
    stringContainingVariables - String
    
    Returns:
    
    String, the new string with the variable replaced by its value.
  - stripFromEnv
```
public static java.lang.String stripFromEnv(java.lang.String envVar,
                                            java.lang.String[] toRemoves)
```
    Parameters:
    
    envVar - String, the environment variable's name, like "CLASSPATH", "PATH" etc.
    
    toRemoves - String[], an array of items to strip. It is partial matched, for example {"rational_ft.jar", "bfg.jar"}.
    
    Returns:
    
    String, the stripped value of the environment variable.
  - initIndependantLogByConsole
```
public static void initIndependantLogByConsole()
```
  - main
```
public static void main(java.lang.String[] args)
```
    java -ea org.safs.StringUtils
    
    Parameters:
    
    args -

Class StringUtils

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.tools.stringutils.StringUtilities

Field Summary

Fields inherited from class org.safs.tools.stringutils.StringUtilities

Constructor Summary

Method Summary

Methods inherited from class org.safs.tools.stringutils.StringUtilities

Methods inherited from class java.lang.Object

Field Detail

CHAR_DOT

CHAR_STAR

CHAR_SLASH

CHAR_QUOTE

CHAR_DOUBLE_QUOTE

CHAR_BACK_SLASH

CHAR_NUMBER

CHAR_COLON

CHAR_EQUAL

CHAR_AND

CHAR_INTERROGATION

CHAR_CARET

CHAR_DOLLAR

CHAR_PLUS

CHAR_MINUS

CHAR_COMMA

CHAR_SEMI_COLON

CHAR_PERCENTAGE

CHAR_SPACE

WILDCARD_CHARS

REGEX_CHARACTER_ANY

REGEX_CHARACTER_MATCH_MANY

REGEX_CHARACTER_MATCH_ONE

REGEX_ESCAPE_CHARACTER

SLASH

QUOTE

DOUBLE_QUOTE

BACK_SLASH

NUMBER

COLON

DOT

EQUAL

AND

INTERROGATION

CARET

DOLLAR

PLUS

MINUS

COMMA

SEMI_COLON

PERCENTAGE

SPACE

maxBytesPerRead

DEFAULT_BUFFER_SIZE

specialKeys

LOCAL_HOST

LOCAL_HOST_IP

CASE_INSENSITIVE

CASEINSENSITIVE

NEW_LINE

CRLF

CARRIAGE_RETURN

CHARSET_UTF8

KEY_UTF8_CHARSET

SYSTEM_PROPERTY_PROXY_HOST

SYSTEM_PROPERTY_PROXY_PORT

SYSTEM_PROPERTY_PROXY_BYPASS

SYSTEM_PROPERTY_NON_PROXY_HOSTS

PROPERTY_START

URL_ENCODING_IGNORE_CHARACTERS

DEFAULT_X_COORDINATE

DEFAULT_Y_COORDINATE

Constructor Detail

StringUtils

Method Detail

findMatchIndex

findExactMatchIndex

isCaseSensitive

isCaseContainsMatch

getSpaces