Strings (Concourse Java API)

Object
- Strings

Deprecated.
in version 0.9.6; use AnyStrings instead
```
@Deprecated
public final class Strings
extends Object
```
Yet another collection of utility functions for Strings that tries to add new functionality or optimize existing ones.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`ensureEndsWith(String string, String suffix)` Deprecated. Ensure that `string` ends with `suffix` by appending it to `string` if and only if it is not already the last sequence of characters in the string.
`static String`	`ensureStartsWith(String string, String prefix)` Deprecated. Ensure that `string` starts with `prefix` by prepending it to `string` if and only if it is not already the first sequence of characters in the string.
`static String`	`ensureWithinQuotes(String string)` Deprecated. Ensure that `string` is surrounded by quotes.
`static String`	`ensureWithinQuotesIfNeeded(String string, char delimiter)` Deprecated. Wrap `string` within quotes if it is necessary to do so.
`static String`	`escapeInner(String string, char... characters)` Deprecated. Efficiently escape inner occurrences of each of the `characters` within the `string`, if necessary.
`static String`	`format(String pattern, Object... params)` Deprecated. Perform string substitution and formatting in a manner that is similar to the SLF4J library.
`static Set<String>`	`getAllSubStrings(String string)` Deprecated. Return a set that contains every possible substring of `string` excluding pure whitespace strings.
`static boolean`	`isSubString(String needle, String haystack)` Deprecated. An optimized version of `String.contains(CharSequence)` to see if `needle` is a substring of `haystack`.
`static boolean`	`isValidJson(String json)` Deprecated. in version 0.9.6; use `com.cinchapi.concourse.util.DataServices#jsonParser()#parse()`
`static boolean`	`isWithinQuotes(String string)` Deprecated. Return `true` if `string` both starts and ends with single or double quotes.
`static String`	`join(char separator, Object... args)` Deprecated. Concatenates the `string` representation of all the `args`, separated by the `separator` char in an efficient manner.
`static String`	`join(String separator, Object... args)` Deprecated. Concatenates the `string` representation of all the `args`, separated by the `separator` string in an efficient manner.
`static String`	`joinSimple(Object... args)` Deprecated. Concatenates the toString values of all the `args` in an efficient manner.
`static String`	`joinWithSpace(Object... args)` Deprecated. Concatenates the toString values of all the `args`, separated by whitespace in an efficient manner.
`static String`	`replaceUnicodeConfusables(String string)` Deprecated. Replace all instances of "confusable" unicode characters with a canoncial/normalized character.
`static String[]`	`splitButRespectQuotes(String string)` Deprecated. in version 0.5.0, use `QuoteAwareStringSplitter` instead.
`static List<String>`	`splitCamelCase(String string)` Deprecated. Split a camel case `string` into tokens that represent the distinct words.
`static String[]`	`splitStringByDelimiterButRespectQuotes(String string, String delimiter)` Deprecated. Split a string on a delimiter as long as that delimiter is not wrapped in double or single quotes.
`static Boolean`	`tryParseBoolean(String value)` Deprecated. This method efficiently tries to parse `value` into a `Boolean` object if possible.
`static Number`	`tryParseNumber(String value)` Deprecated. This method efficiently tries to parse `value` into a `Number` object if possible.
`static Number`	`tryParseNumberStrict(String value)` Deprecated. A stricter version of `tryParseNumber(String)` that does not parse strings that masquerade as numbers (i.e.
`static String`	`valueOfCached(char c)` Deprecated. Similar to the `String.valueOf(char)` method, but this one will return a cached copy of the string for frequently used characters.

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

- Method Detail
  - ensureEndsWith
```
public static String ensureEndsWith(String string,
                                    String suffix)
```
    Deprecated.
    
    Ensure that string ends with suffix by appending it to string if and only if it is not already the last sequence of characters in the string.
    
    Parameters:
    
    string - the String to that should end with suffix
    
    suffix - the String of characters with which string should end
    
    Returns:
    
    string if it already ends with suffix or a new String that contains suffix appended to string
  - ensureStartsWith
```
public static String ensureStartsWith(String string,
                                      String prefix)
```
    Deprecated.
    
    Ensure that string starts with prefix by prepending it to string if and only if it is not already the first sequence of characters in the string.
    
    Parameters:
    
    string - the String to that should start with prefix
    
    prefix - the String of characters with which string should start
    
    Returns:
    
    string if it already begins with prefix or a new String that contains prefix prepended to string
  - ensureWithinQuotes
```
public static String ensureWithinQuotes(String string)
```
    Deprecated.
    
    Ensure that string is surrounded by quotes. If that is not the case, alter the string so that it is and return the altered form.
    Calling isWithinQuotes(String) on the result of this method will always return true.
    
    Parameters:
    
    string - the string that must be quoted
    
    Returns:
    
    string or string surrounded by quotes if it is not already
  - ensureWithinQuotesIfNeeded
```
public static String ensureWithinQuotesIfNeeded(String string,
                                                char delimiter)
```
    Deprecated.
    Wrap string within quotes if it is necessary to do so. Otherwise, return the original string.
    The original string will be wrapped in quotes and returned as such if:
    - it is not already wrapped within quotes, and
    - delimiter appears at least once
    If those conditions are met, the original string will be wrapped in either
    - double quotes if a single quote appears in the original string, or
    - single quotes if a double quote appears in the original string, or
    - double quotes if both a single and double quote appear in the original string; furthermore, all instances of double quotes within the original string will be escaped
    Parameters:
    
    string - the string to potentially quote
    
    delimiter - the delimiter that determines whether quoting should happen
    
    Returns:
    
    the original string or a properly quoted alternative
  - escapeInner
```
public static String escapeInner(String string,
                                 char... characters)
```
    Deprecated.
    
    Efficiently escape inner occurrences of each of the characters within the string, if necessary.
    Escaped characters are prepended with the backslash ('\') character.
    
    An "inner occurrence" for a character is one that is not at the head or tail of the string.
    
    Parameters:
    
    string - the string to escape
    
    characters - the characters to escape within the string
    
    Returns:
    
    the escaped string
  - replaceUnicodeConfusables
```
public static String replaceUnicodeConfusables(String string)
```
    Deprecated.
    
    Replace all instances of "confusable" unicode characters with a canoncial/normalized character.
    See http://www.unicode.org/Public/security/revision-03/confusablesSummary. txt for a list of characters that are considered to be confusable.
    
    Parameters:
    
    string - the String in which the replacements should occur
    
    Returns:
    
    a String free of confusable unicode characters
  - format
```
public static String format(String pattern,
                            Object... params)
```
    Deprecated.
    Perform string substitution and formatting in a manner that is similar to the SLF4J library.
```
 Strings#format("Bob is very {} because he has no {}", "brave", "fear") = "Bob is very brave because he has no fear"
 
```
    NOTE: This method is less efficient than using a StringBuilder and manually appending variable arguments for interpolation. This is provided for convenience, but don't use it for anything that is performance critical.
    Parameters:
    
    pattern - the message pattern which will be parsed and formatted
    
    params - an array of arguments to be substituted in place of formatting anchors
    
    Returns:
    
    The formatted message
  - getAllSubStrings
```
public static Set<String> getAllSubStrings(String string)
```
    Deprecated.
    
    Return a set that contains every possible substring of string excluding pure whitespace strings.
    
    Parameters:
    
    string - the string to divide into substrings
    
    Returns:
    
    the set of substrings
  - isSubString
```
public static boolean isSubString(String needle,
                                  String haystack)
```
    Deprecated.
    
    An optimized version of String.contains(CharSequence) to see if needle is a substring of haystack.
    
    Parameters:
    
    needle - the substring for which to search
    
    haystack - the string in which to search for the substring
    
    Returns:
    
    true if needle is a substring
  - isValidJson
```
@Deprecated
public static boolean isValidJson(String json)
```
    Deprecated. in version 0.9.6; use com.cinchapi.concourse.util.DataServices#jsonParser()#parse()
    
    Return true if the json string is valid, otherwise return false.
    
    Parameters:
    
    json - a json formatted string
    
    Returns:
    
    true if the json is valid
  - isWithinQuotes
```
public static boolean isWithinQuotes(String string)
```
    Deprecated.
    
    Return true if string both starts and ends with single or double quotes.
    
    Parameters:
    
    string -
    
    Returns:
    
    true if the string is between quotes
  - join
```
public static String join(char separator,
                          Object... args)
```
    Deprecated.
    
    Concatenates the string representation of all the args, separated by the separator char in an efficient manner.
    
    Parameters:
    
    separator - the separator to place between each of the args
    
    args - the args to join
    
    Returns:
    
    the resulting String
  - join
```
public static String join(String separator,
                          Object... args)
```
    Deprecated.
    
    Concatenates the string representation of all the args, separated by the separator string in an efficient manner.
    
    Parameters:
    
    separator - the separator to place between each of the args
    
    args - the args to join
    
    Returns:
    
    the resulting String
  - joinSimple
```
public static String joinSimple(Object... args)
```
    Deprecated.
    
    Concatenates the toString values of all the args in an efficient manner.
    
    Parameters:
    
    args -
    
    Returns:
    
    the resulting String
  - joinWithSpace
```
public static String joinWithSpace(Object... args)
```
    Deprecated.
    
    Concatenates the toString values of all the args, separated by whitespace in an efficient manner.
    
    Parameters:
    
    args -
    
    Returns:
    
    the resulting String
  - splitButRespectQuotes
```
@Deprecated
public static String[] splitButRespectQuotes(String string)
```
    Deprecated. in version 0.5.0, use QuoteAwareStringSplitter instead.
    
    Split a string, using whitespace as a delimiter, as long as the whitespace is not wrapped in double or single quotes.
    
    Parameters:
    
    string -
    
    Returns:
    
    the tokens that result from the split
  - splitCamelCase
```
public static List<String> splitCamelCase(String string)
```
    Deprecated.
    Split a camel case string into tokens that represent the distinct words.
    
    Example
    Parameters:
    
    string -
    
    Returns:
    
    a list of tokens after splitting the string on camel case word boundaries
  - splitStringByDelimiterButRespectQuotes
```
public static String[] splitStringByDelimiterButRespectQuotes(String string,
                                                              String delimiter)
```
    Deprecated.
    
    Split a string on a delimiter as long as that delimiter is not wrapped in double or single quotes.
    If delimiter is a single character string, it is more efficient to use a StringSplitter as opposed to this method.
    
    Parameters:
    
    string - the string to split
    
    delimiter - the delimiting string/regex on which the input string is split
    
    Returns:
    
    the tokens that result from the split
  - tryParseBoolean
```
public static Boolean tryParseBoolean(String value)
```
    Deprecated.
    
    This method efficiently tries to parse value into a Boolean object if possible. If the string is not a boolean, then the method returns null as quickly as possible.
    
    Parameters:
    
    value -
    
    Returns:
    
    a Boolean object that represents the string or null if it is not possible to parse the string into a boolean
  - tryParseNumber
```
@Nullable
public static Number tryParseNumber(String value)
```
    Deprecated.
    
    This method efficiently tries to parse value into a Number object if possible. If the string is not a number, then the method returns null as quickly as possible.
    
    Parameters:
    
    value -
    
    Returns:
    
    a Number object that represents the string or null if it is not possible to parse the string into a number
  - tryParseNumberStrict
```
@Nullable
public static Number tryParseNumberStrict(String value)
```
    Deprecated.
    
    A stricter version of tryParseNumber(String) that does not parse strings that masquerade as numbers (i.e. 3.124D). Instead this method will only parse the string into a Number if it contains characters that are either a decimal digit, a decimal separator or a negative sign.
    
    Parameters:
    
    value -
    
    Returns:
    
    a Number object that represents the string or null if it is not possible to parse the string into a number
  - valueOfCached
```
public static String valueOfCached(char c)
```
    Deprecated.
    
    Similar to the String.valueOf(char) method, but this one will return a cached copy of the string for frequently used characters.
    
    Parameters:
    
    c - the character to convert
    
    Returns:
    
    a string of length 1 containing the input char

Class Strings

Method Summary

Methods inherited from class Object

Method Detail

ensureEndsWith

ensureStartsWith

ensureWithinQuotes

ensureWithinQuotesIfNeeded

escapeInner

replaceUnicodeConfusables

format

getAllSubStrings

isSubString

isValidJson

isWithinQuotes

join

join

joinSimple

joinWithSpace

splitButRespectQuotes

splitCamelCase

Example

splitStringByDelimiterButRespectQuotes

tryParseBoolean

tryParseNumber

tryParseNumberStrict

valueOfCached