StringUtils (Apache Juneau 7.2.2)

java.lang.Object
- org.apache.juneau.internal.StringUtils

public final class StringUtils
extends Object

Reusable string utility methods.

Constructor Summary

Constructors
Constructor and Description

StringUtils()

Constructors
Constructor and Description
`StringUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`asString(Object o)` Calls `Object.toString()` on the specified object if it's not null.
`static String[]`	`asStrings(Object... o)` Converts an array of objects to an array of strings.
`static byte[]`	`base64Decode(String in)` BASE64-decodes the specified string.
`static String`	`base64DecodeToString(String in)` Shortcut for calling `base64Decode(String)` and converting the result to a UTF-8 encoded string.
`static String`	`base64Encode(byte[] in)` BASE64-encodes the specified byte array.
`static String`	`base64EncodeToString(String in)` Shortcut for calling `base64Encode(in.getBytes("UTF-8"))`
`static char`	`charAt(String s, int i)` Returns the character at the specified index in the string without throwing exceptions.
`static int`	`compare(String s1, String s2)` Compares two strings, but gracefully handles nulls.
`static boolean`	`contains(String value, CharSequence substring)` Same as `String.contains(CharSequence)` except returns null if the value is null.
`static boolean`	`containsAny(String s, char... chars)` Returns true if the specified string contains any of the specified characters.
`static String`	`decodeHex(String s)` Debug method for rendering non-ASCII character sequences.
`static String`	`emptyIfNull(Object o)` Returns an empty string if the specified object is null.
`static String`	`emptyIfNull(String s)` Returns an empty string if the specified string is null.
`static boolean`	`endsWith(String s, char... c)` Same as `endsWith(String, char)` except check for multiple characters.
`static boolean`	`endsWith(String s, char c)` An efficient method for checking if a string ends with a character.
`static String`	`escapeChars(String s, AsciiSet escaped)` Escapes the specified characters in the string.
`static char`	`firstChar(String s)` Returns the first character in the specified string.
`static String`	`firstNonEmpty(String... s)` Returns the first non-null, non-empty string in the list.
`static char`	`firstNonWhitespaceChar(String s)` Returns the first non-whitespace character in the string.
`static String`	`format(String pattern, Object... args)` Similar to `MessageFormat.format(String, Object...)` except allows you to specify POJO arguments.
`static byte[]`	`fromHex(String hex)` Converts a hexadecimal character string to a byte array.
`static String`	`fromHexToUTF8(String hex)` Converts a hexadecimal byte stream (e.g.
`static byte[]`	`fromSpacedHex(String hex)` Same as `fromHex(String)` except expects spaces between the byte strings.
`static String`	`fromSpacedHexToUTF8(String hex)` Converts a space-deliminted hexadecimal byte stream (e.g.
`static String`	`generateUUID(int numchars)` Generated a random UUID with the specified number of characters.
`static String`	`getAuthorityUri(String s)` Given an absolute URI, returns just the authority portion (e.g.
`static long`	`getDuration(String s)` Parses a duration string.
`static String`	`getField(int fieldNum, String s, char delim)` Returns the specified field in a delimited string without splitting the string.
`static String`	`getField(int fieldNum, String s, char delim, String def)` Same as `getField(int, String, char)` except allows you to specify the default value.
`static Pattern`	`getMatchPattern(String s)` Converts a string containing "*" meta characters with a regular expression pattern.
`static String`	`getNumberedLines(String s)` Takes in a string, splits it by lines, and then prepends each line with line numbers.
`static String`	`getNumberedLines(String s, int start, int end)` Same as `getNumberedLines(String)` except only returns the specified lines.
`static String`	`getStackTrace(Throwable t)` Convenience method for getting a stack trace as a string.
`static int`	`indexOf(String s, char... c)` Same as `String.indexOf(int)` except allows you to check for multiple characters.
`static boolean`	`isAbsoluteUri(String s)` Efficiently determines whether a URL is of the pattern "xxx://xxx"
`static boolean`	`isDecimal(String s)` Returns true if the specified string is numeric.
`static boolean`	`isEmpty(Object s)` Returns true if specified string is null or it's `Object.toString()` method returns an empty string.
`static boolean`	`isEmpty(String s)` Returns true if specified string is null or empty.
`static boolean`	`isEquals(String s1, String s2)` Tests two strings for equality, but gracefully handles nulls.
`static boolean`	`isFirstNumberChar(char c)` Returns true if the specified character is a valid first character for a number.
`static boolean`	`isFloat(String s)` Returns true if the specified string is a floating point number.
`static boolean`	`isJson(String s)` Returns true if the specified string is valid JSON.
`static boolean`	`isNotEmpty(Object s)` Returns true if specified string is not null or it's `Object.toString()` method doesn't return an empty string.
`static boolean`	`isNotEmpty(String s)` Returns true if specified string is not null or empty.
`static boolean`	`isNotEquals(String s1, String s2)` Tests two strings for non-equality, but gracefully handles nulls.
`static boolean`	`isNumeric(String s)` Returns true if this string can be parsed by `parseNumber(String, Class)`.
`static boolean`	`isObjectList(Object o, boolean ignoreWhitespaceAndComments)` Returns true if the specified string appears to be an JSON array.
`static boolean`	`isObjectMap(Object o, boolean ignoreWhitespaceAndComments)` Returns true if the specified string appears to be a JSON object.
`static boolean`	`isOneOf(String s, String... values)` Returns true if the specified string is one of the specified values.
`static boolean`	`isUri(String s)` Efficiently determines whether a URL is of the pattern "xxx:/xxx".
`static String`	`join(Collection<?> tokens, char d)` Join the specified tokens into a delimited string.
`static String`	`join(Collection<?> tokens, String d)` Join the specified tokens into a delimited string.
`static StringBuilder`	`join(Collection<?> tokens, String d, StringBuilder sb)` Joins the specified tokens into a delimited string and writes the output to the specified string builder.
`static String`	`join(int[] tokens, char d)` Join the specified tokens into a delimited string.
`static String`	`join(int[] tokens, String d)` Join the specified tokens into a delimited string.
`static String`	`join(Object[] tokens, char d)` Joins the specified tokens into a delimited string.
`static StringBuilder`	`join(Object[] tokens, char d, StringBuilder sb)` Join the specified tokens into a delimited string and writes the output to the specified string builder.
`static String`	`join(Object[] tokens, String separator)` Join the specified tokens into a delimited string.
`static String`	`joine(Collection<?> tokens, char d)` Same as `join(Collection, char)` but escapes the delimiter if found in the tokens.
`static String`	`joine(Object[] tokens, char d)` Same as `join(Object[], char)` except escapes the delimiter character if found in the tokens.
`static StringBuilder`	`joine(Object[] tokens, char d, StringBuilder sb)` Same as `join(Object[], char, StringBuilder)` but escapes the delimiter character if found in the tokens.
`static String`	`joinnl(Object[] tokens)` Joins tokens with newlines.
`static char`	`lastNonWhitespaceChar(String s)` Returns the last non-whitespace character in the string.
`static String`	`nullIfEmpty(String s)` Returns null if the specified string is null or empty.
`static Character`	`parseCharacter(Object o)` Converts a `String` to a `Character`
`static int`	`parseIntWithSuffix(String s)` Converts a string containing a possible multiplier suffix to an integer.
`static Calendar`	`parseIsoCalendar(String date)` Parses an ISO8601 string into a calendar.
`static Date`	`parseIsoDate(String date)` Parses an ISO8601 string into a date.
`static ObjectList`	`parseListOrCdl(String s)` Parses a string that can consist of either a JSON array or comma-delimited list.
`static long`	`parseLongWithSuffix(String s)` Converts a string containing a possible multiplier suffix to a long.
`static Number`	`parseNumber(ParserReader r, Class<? extends Number> type)` Parses a number from the specified reader stream.
`static Number`	`parseNumber(String s, Class<? extends Number> type)` Parses a number from the specified string.
`static String`	`parseNumberString(ParserReader r)` Reads a numeric string from the specified reader.
`static boolean`	`pathStartsWith(String path, String pathPrefix)` Returns true if the specified path string is prefixed with the specified prefix.
`static boolean`	`pathStartsWith(String path, String[] pathPrefixes)` Same as `pathStartsWith(String, String)` but returns true if at least one prefix matches.
`static String`	`repeat(int count, String pattern)` Creates a repeated pattern.
`static String`	`replaceUnicodeSequences(String s)` Replaces "\\uXXXX" character sequences with their unicode characters.
`static String`	`replaceVars(String s, Map<String,Object> m)` Simple utility for replacing variables of the form "{key}" with values in the specified map.
`static String[]`	`split(String s)` Shortcut for calling `split(s, ',')`
`static String[]`	`split(String[] s, char c)` Same as `split(String, char)` except splits all strings in the input and returns a single result.
`static String[]`	`split(String s, char c)` Splits a character-delimited string into a string array.
`static String[]`	`split(String s, char c, int limit)` Same as `split(String, char)` but limits the number of tokens returned.
`static List<String>`	`splitEqually(String s, int size)` Splits a string into equally-sized parts.
`static Map<String,String>`	`splitMap(String s, boolean trim)` Splits a list of key-value pairs into an ordered map.
`static String[]`	`splitQuoted(String s)` Splits a space-delimited string with optionally quoted arguments.
`static boolean`	`startsWith(String s, char c)` An efficient method for checking if a string starts with a character.
`static String`	`toHex(byte[] bytes)` Converts a byte array into a simple hexadecimal character string.
`static char[]`	`toHex2(int num)` Converts the specified number into a 2 hexadecimal characters.
`static char[]`	`toHex4(int num)` Converts the specified number into a 4 hexadecimal characters.
`static char[]`	`toHex8(long num)` Converts the specified number into a 8 hexadecimal characters.
`static String`	`toIsoDate(Calendar c)` Converts the specified object to an ISO8601 date string.
`static String`	`toIsoDateTime(Calendar c)` Converts the specified object to an ISO8601 date-time string.
`static String`	`toLowerCase(String s)` Null-safe `String.toLowerCase()`.
`static String`	`toSpacedHex(byte[] bytes)` Same as `toHex(byte[])` but puts spaces between the byte strings.
`static URI`	`toURI(Object o)` Converts the specified object to a URI.
`static String`	`trim(String s)` Same as `String.trim()` but prevents `NullPointerExceptions`.
`static String`	`trimEnd(String s)` Trims whitespace characters from the end of the specified string.
`static String`	`trimSlashes(String s)` Trims '/' characters from both the start and end of the specified string.
`static String`	`trimStart(String s)` Trims whitespace characters from the beginning of the specified string.
`static String`	`trimTrailingSlashes(String s)` Trims '/' characters from the end of the specified string.
`static StringBuffer`	`trimTrailingSlashes(StringBuffer s)` Trims '/' characters from the end of the specified string.
`static String`	`unEscapeChars(String s, AsciiSet escaped)` Removes escape characters from the specified characters.
`static String`	`unicodeSequence(char c)` Creates an escaped-unicode sequence (e.g.
`static String`	`urlDecode(String s)` Decodes a `application/x-www-form-urlencoded` string using `UTF-8` encoding scheme.
`static String`	`urlEncode(Object o)` Shortcut for calling `URLEncoder.encode(o.toString(), "UTF-8")`.
`static String`	`urlEncode(String s)` Encodes a `application/x-www-form-urlencoded` string using `UTF-8` encoding scheme.
`static String`	`urlEncodeLax(String s)` Same as `urlEncode(String)` except only escapes characters that absolutely need to be escaped.
`static String`	`urlEncodePath(Object o)` Similar to `urlEncode(Object)` but doesn't encode "/" characters.

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

- Constructor Detail
  - StringUtils
```
public StringUtils()
```
- Method Detail
  - parseNumber
```
public static Number parseNumber(ParserReader r,
                                 Class<? extends Number> type)
                          throws Exception
```
    Parses a number from the specified reader stream.
    Parameters:
    
    r - The reader to parse the string from.
    type - The number type to created. Can be any of the following:
    
    Integer
    Double
    Float
    Long
    Short
    Byte
    BigInteger
    BigDecimal
    If null, uses the best guess.
    Returns:
    
    The parsed number.
    
    Throws:
    
    IOException - If a problem occurred trying to read from the reader.
    
    Exception
  - parseNumberString
```
public static String parseNumberString(ParserReader r)
                                throws Exception
```
    Reads a numeric string from the specified reader.
    
    Parameters:
    
    r - The reader to read form.
    
    Returns:
    
    The parsed number string.
    
    Throws:
    
    Exception
  - parseNumber
```
public static Number parseNumber(String s,
                                 Class<? extends Number> type)
                          throws ParseException
```
    Parses a number from the specified string.
    Parameters:
    
    s - The string to parse the number from.
    type - The number type to created. Can be any of the following:
    
    Integer
    Double
    Float
    Long
    Short
    Byte
    BigInteger
    BigDecimal
    If null or Number, uses the best guess.
    Returns:
    
    The parsed number, or null if the string was null.
    
    Throws:
    
    ParseException
  - parseCharacter
```
public static Character parseCharacter(Object o)
                                throws ParseException
```
    Converts a String to a Character
    
    Parameters:
    
    o - The string to convert.
    
    Returns:
    
    The first character of the string if the string is of length 0, or null if the string is null or empty.
    
    Throws:
    
    ParseException - If string has a length greater than 1.
  - isNumeric
```
public static boolean isNumeric(String s)
```
    Returns true if this string can be parsed by parseNumber(String, Class).
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if this string can be parsed without causing an exception.
  - isFirstNumberChar
```
public static boolean isFirstNumberChar(char c)
```
    Returns true if the specified character is a valid first character for a number.
    
    Parameters:
    
    c - The character to test.
    
    Returns:
    
    true if the specified character is a valid first character for a number.
  - isFloat
```
public static boolean isFloat(String s)
```
    Returns true if the specified string is a floating point number.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if the specified string is a floating point number.
  - isDecimal
```
public static boolean isDecimal(String s)
```
    Returns true if the specified string is numeric.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if the specified string is numeric.
  - getStackTrace
```
public static String getStackTrace(Throwable t)
```
    Convenience method for getting a stack trace as a string.
    
    Parameters:
    
    t - The throwable to get the stack trace from.
    
    Returns:
    
    The same content that would normally be rendered via t.printStackTrace()
  - join
```
public static String join(Object[] tokens,
                          String separator)
```
    Join the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    separator - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - join
```
public static String join(int[] tokens,
                          String d)
```
    Join the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - join
```
public static String join(Collection<?> tokens,
                          String d)
```
    Join the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - join
```
public static StringBuilder join(Collection<?> tokens,
                                 String d,
                                 StringBuilder sb)
```
    Joins the specified tokens into a delimited string and writes the output to the specified string builder.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    sb - The string builder to append the response to.
    
    Returns:
    
    The same string builder passed in as sb.
  - join
```
public static String join(Object[] tokens,
                          char d)
```
    Joins the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - joine
```
public static String joine(Object[] tokens,
                           char d)
```
    Same as join(Object[], char) except escapes the delimiter character if found in the tokens.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - join
```
public static StringBuilder join(Object[] tokens,
                                 char d,
                                 StringBuilder sb)
```
    Join the specified tokens into a delimited string and writes the output to the specified string builder.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    sb - The string builder to append the response to.
    
    Returns:
    
    The same string builder passed in as sb.
  - joine
```
public static StringBuilder joine(Object[] tokens,
                                  char d,
                                  StringBuilder sb)
```
    Same as join(Object[], char, StringBuilder) but escapes the delimiter character if found in the tokens.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    sb - The string builder to append the response to.
    
    Returns:
    
    The same string builder passed in as sb.
  - join
```
public static String join(int[] tokens,
                          char d)
```
    Join the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - join
```
public static String join(Collection<?> tokens,
                          char d)
```
    Join the specified tokens into a delimited string.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - joine
```
public static String joine(Collection<?> tokens,
                           char d)
```
    Same as join(Collection, char) but escapes the delimiter if found in the tokens.
    
    Parameters:
    
    tokens - The tokens to join.
    
    d - The delimiter.
    
    Returns:
    
    The delimited string. If tokens is null, returns null.
  - joinnl
```
public static String joinnl(Object[] tokens)
```
    Joins tokens with newlines.
    
    Parameters:
    
    tokens - The tokens to concatenate.
    
    Returns:
    
    A string with the specified tokens contatenated with newlines.
  - split
```
public static String[] split(String s)
```
    Shortcut for calling split(s, ',')
    
    Parameters:
    
    s - The string to split. Can be null.
    
    Returns:
    
    The tokens, or null if the string was null.
  - split
```
public static String[] split(String s,
                             char c)
```
    Splits a character-delimited string into a string array.
    Does not split on escaped-delimiters (e.g. "\,"); Resulting tokens are trimmed of whitespace.
    NOTE: This behavior is different than the Jakarta equivalent. split("a,b,c",',') -> {"a","b","c"} split("a, b ,c ",',') -> {"a","b","c"} split("a,,c",',') -> {"a","","c"} split(",,",',') -> {"","",""} split("",',') -> {} split(null,',') -> null split("a,b\,c,d", ',', false) -> {"a","b\,c","d"} split("a,b\\,c,d", ',', false) -> {"a","b\","c","d"} split("a,b\,c,d", ',', true) -> {"a","b,c","d"}
    
    Parameters:
    
    s - The string to split. Can be null.
    
    c - The character to split on.
    
    Returns:
    
    The tokens, or null if the string was null.
  - split
```
public static String[] split(String s,
                             char c,
                             int limit)
```
    Same as split(String, char) but limits the number of tokens returned.
    
    Parameters:
    
    s - The string to split. Can be null.
    
    c - The character to split on.
    
    limit - The maximum number of tokens to return.
    
    Returns:
    
    The tokens, or null if the string was null.
  - split
```
public static String[] split(String[] s,
                             char c)
```
    Same as split(String, char) except splits all strings in the input and returns a single result.
    
    Parameters:
    
    s - The string to split. Can be null.
    
    c - The character to split on.
    
    Returns:
    
    The tokens.
  - splitMap
```
public static Map<String,String> splitMap(String s,
                                          boolean trim)
```
    Splits a list of key-value pairs into an ordered map.
    Example:
    String in = "foo=1;bar=2"; Map m = StringUtils.splitMap(in, ';', '=', true);
    
    Parameters:
    
    s - The string to split.
    
    trim - Trim strings after parsing.
    
    Returns:
    
    The parsed map. Never null.
  - containsAny
```
public static boolean containsAny(String s,
                                  char... chars)
```
    Returns true if the specified string contains any of the specified characters.
    
    Parameters:
    
    s - The string to test.
    
    chars - The characters to look for.
    
    Returns:
    
    true if the specified string contains any of the specified characters.
    false if the string is null.
  - splitQuoted
```
public static String[] splitQuoted(String s)
```
    Splits a space-delimited string with optionally quoted arguments.
    Examples:
    - "foo" => ["foo"]
    - " foo " => ["foo"]
    - "foo bar baz" => ["foo","bar","baz"]
    - "foo 'bar baz'" => ["foo","bar baz"]
    - "foo \"bar baz\"" => ["foo","bar baz"]
    - "foo 'bar\'baz'" => ["foo","bar'baz"]
    Parameters:
    
    s - The input string.
    
    Returns:
    
    The results, or null if the input was null.
    An empty string results in an empty array.
  - isEmpty
```
public static boolean isEmpty(String s)
```
    Returns true if specified string is null or empty.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if specified string is null or empty.
  - isEmpty
```
public static boolean isEmpty(Object s)
```
    Returns true if specified string is null or it's Object.toString() method returns an empty string.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if specified string is null or it's Object.toString() method returns an empty string.
  - isNotEmpty
```
public static boolean isNotEmpty(String s)
```
    Returns true if specified string is not null or empty.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if specified string is not null or empty.
  - isNotEmpty
```
public static boolean isNotEmpty(Object s)
```
    Returns true if specified string is not null or it's Object.toString() method doesn't return an empty string.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    true if specified string is not null or it's Object.toString() method doesn't return an empty string.
  - nullIfEmpty
```
public static String nullIfEmpty(String s)
```
    Returns null if the specified string is null or empty.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    null if the specified string is null or empty, or the same string if not.
  - emptyIfNull
```
public static String emptyIfNull(String s)
```
    Returns an empty string if the specified string is null.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    An empty string if the specified string is null, or the same string otherwise.
  - emptyIfNull
```
public static String emptyIfNull(Object o)
```
    Returns an empty string if the specified object is null.
    
    Parameters:
    
    o - The object to check.
    
    Returns:
    
    An empty string if the specified object is null, or the object converted to a string using String.toString().
  - unEscapeChars
```
public static String unEscapeChars(String s,
                                   AsciiSet escaped)
```
    Removes escape characters from the specified characters.
    
    Parameters:
    
    s - The string to remove escape characters from.
    
    escaped - The characters escaped.
    
    Returns:
    
    A new string if characters were removed, or the same string if not or if the input was null.
  - escapeChars
```
public static String escapeChars(String s,
                                 AsciiSet escaped)
```
    Escapes the specified characters in the string.
    
    Parameters:
    
    s - The string with characters to escape.
    
    escaped - The characters to escape.
    
    Returns:
    
    The string with characters escaped, or the same string if no escapable characters were found.
  - decodeHex
```
public static String decodeHex(String s)
```
    Debug method for rendering non-ASCII character sequences.
    
    Parameters:
    
    s - The string to decode.
    
    Returns:
    
    A string with non-ASCII characters converted to "[hex]" sequences.
  - startsWith
```
public static boolean startsWith(String s,
                                 char c)
```
    An efficient method for checking if a string starts with a character.
    
    Parameters:
    
    s - The string to check. Can be null.
    
    c - The character to check for.
    
    Returns:
    
    true if the specified string is not null and starts with the specified character.
  - endsWith
```
public static boolean endsWith(String s,
                               char c)
```
    An efficient method for checking if a string ends with a character.
    
    Parameters:
    
    s - The string to check. Can be null.
    
    c - The character to check for.
    
    Returns:
    
    true if the specified string is not null and ends with the specified character.
  - endsWith
```
public static boolean endsWith(String s,
                               char... c)
```
    Same as endsWith(String, char) except check for multiple characters.
    
    Parameters:
    
    s - The string to check. Can be null.
    
    c - The characters to check for.
    
    Returns:
    
    true if the specified string is not null and ends with the specified character.
  - toHex2
```
public static final char[] toHex2(int num)
```
    Converts the specified number into a 2 hexadecimal characters.
    
    Parameters:
    
    num - The number to convert to hex.
    
    Returns:
    
    A char[2] containing the specified characters.
  - toHex4
```
public static final char[] toHex4(int num)
```
    Converts the specified number into a 4 hexadecimal characters.
    
    Parameters:
    
    num - The number to convert to hex.
    
    Returns:
    
    A char[4] containing the specified characters.
  - toHex8
```
public static final char[] toHex8(long num)
```
    Converts the specified number into a 8 hexadecimal characters.
    
    Parameters:
    
    num - The number to convert to hex.
    
    Returns:
    
    A char[8] containing the specified characters.
  - isEquals
```
public static boolean isEquals(String s1,
                               String s2)
```
    Tests two strings for equality, but gracefully handles nulls.
    
    Parameters:
    
    s1 - String 1.
    
    s2 - String 2.
    
    Returns:
    
    true if the strings are equal.
  - isNotEquals
```
public static boolean isNotEquals(String s1,
                                  String s2)
```
    Tests two strings for non-equality, but gracefully handles nulls.
    
    Parameters:
    
    s1 - String 1.
    
    s2 - String 2.
    
    Returns:
    
    true if the strings are not equal.
  - base64EncodeToString
```
public static String base64EncodeToString(String in)
```
    Shortcut for calling base64Encode(in.getBytes("UTF-8"))
    
    Parameters:
    
    in - The input string to convert.
    
    Returns:
    
    The string converted to BASE-64 encoding.
  - base64Encode
```
public static String base64Encode(byte[] in)
```
    BASE64-encodes the specified byte array.
    
    Parameters:
    
    in - The input byte array to convert.
    
    Returns:
    
    The byte array converted to a BASE-64 encoded string.
  - base64DecodeToString
```
public static String base64DecodeToString(String in)
```
    Shortcut for calling base64Decode(String) and converting the result to a UTF-8 encoded string.
    
    Parameters:
    
    in - The BASE-64 encoded string to decode.
    
    Returns:
    
    The decoded string.
  - base64Decode
```
public static byte[] base64Decode(String in)
```
    BASE64-decodes the specified string.
    
    Parameters:
    
    in - The BASE-64 encoded string.
    
    Returns:
    
    The decoded byte array.
  - generateUUID
```
public static String generateUUID(int numchars)
```
    Generated a random UUID with the specified number of characters.
    Characters are composed of lower-case ASCII letters and numbers only.
    This method conforms to the restrictions for hostnames as specified in RFC 952 Since each character has 36 possible values, the square approximation formula for the number of generated IDs that would produce a 50% chance of collision is: sqrt(36^N). Dividing this number by 10 gives you an approximation of the number of generated IDs needed to produce a <1% chance of collision.
    For example, given 5 characters, the number of generated IDs need to produce a <1% chance of collision would be: sqrt(36^5)/10=777
    
    Parameters:
    
    numchars - The number of characters in the generated UUID.
    
    Returns:
    
    A new random UUID.
  - trim
```
public static String trim(String s)
```
    Same as String.trim() but prevents NullPointerExceptions.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    The trimmed string, or null if the string was null.
  - parseIsoDate
```
public static Date parseIsoDate(String date)
                         throws IllegalArgumentException
```
    Parses an ISO8601 string into a date.
    Supports any of the following formats:
    yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddThh, yyyy-MM-ddThh:mm, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ss.SSS
    
    Parameters:
    
    date - The date string.
    
    Returns:
    
    The parsed date.
    
    Throws:
    
    IllegalArgumentException
  - parseIsoCalendar
```
public static Calendar parseIsoCalendar(String date)
                                 throws IllegalArgumentException
```
    Parses an ISO8601 string into a calendar.
    Supports any of the following formats:
    yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddThh, yyyy-MM-ddThh:mm, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ss.SSS
    
    Parameters:
    
    date - The date string.
    
    Returns:
    
    The parsed calendar.
    
    Throws:
    
    IllegalArgumentException
  - toIsoDate
```
public static String toIsoDate(Calendar c)
```
    Converts the specified object to an ISO8601 date string.
    
    Parameters:
    
    c - The object to convert.
    
    Returns:
    
    The converted object.
  - toIsoDateTime
```
public static String toIsoDateTime(Calendar c)
```
    Converts the specified object to an ISO8601 date-time string.
    
    Parameters:
    
    c - The object to convert.
    
    Returns:
    
    The converted object.
  - replaceVars
```
public static String replaceVars(String s,
                                 Map<String,Object> m)
```
    Simple utility for replacing variables of the form "{key}" with values in the specified map.
    Nested variables are supported in both the input string and map values.
    If the map does not contain the specified value, the variable is not replaced.
    null values in the map are treated as blank strings.
    
    Parameters:
    
    s - The string containing variables to replace.
    
    m - The map containing the variable values.
    
    Returns:
    
    The new string with variables replaced, or the original string if it didn't have variables in it.
  - pathStartsWith
```
public static boolean pathStartsWith(String path,
                                     String pathPrefix)
```
    Returns true if the specified path string is prefixed with the specified prefix.
    Example:
    
    pathStartsWith("foo", "foo"); // true pathStartsWith("foo/bar", "foo"); // true pathStartsWith("foo2", "foo"); // false pathStartsWith("foo2", ""); // false
    
    Parameters:
    
    path - The path to check.
    
    pathPrefix - The prefix.
    
    Returns:
    
    true if the specified path string is prefixed with the specified prefix.
  - pathStartsWith
```
public static boolean pathStartsWith(String path,
                                     String[] pathPrefixes)
```
    Same as pathStartsWith(String, String) but returns true if at least one prefix matches.
    
    Parameters:
    
    path - The path to check.
    
    pathPrefixes - The prefixes.
    
    Returns:
    
    true if the specified path string is prefixed with any of the specified prefixes.
  - replaceUnicodeSequences
```
public static String replaceUnicodeSequences(String s)
```
    Replaces "\\uXXXX" character sequences with their unicode characters.
    
    Parameters:
    
    s - The string to replace unicode sequences in.
    
    Returns:
    
    A string with unicode sequences replaced.
  - unicodeSequence
```
public static String unicodeSequence(char c)
```
    Creates an escaped-unicode sequence (e.g. "\\u1234") for the specified character.
    
    Parameters:
    
    c - The character to create a sequence for.
    
    Returns:
    
    An escaped-unicode sequence.
  - getField
```
public static String getField(int fieldNum,
                              String s,
                              char delim)
```
    Returns the specified field in a delimited string without splitting the string.
    Equivalent to the following:
    String in = "0,1,2"; String[] parts = in.split(","); String p1 = (parts.length > 1 ? parts[1] : "");
    
    Parameters:
    
    fieldNum - The field number. Zero-indexed.
    
    s - The input string.
    
    delim - The delimiter character.
    
    Returns:
    
    The field entry in the string, or a blank string if it doesn't exist or the string is null.
  - getField
```
public static String getField(int fieldNum,
                              String s,
                              char delim,
                              String def)
```
    Same as getField(int, String, char) except allows you to specify the default value.
    
    Parameters:
    
    fieldNum - The field number. Zero-indexed.
    
    s - The input string.
    
    delim - The delimiter character.
    
    def - The default value if the field does not exist.
    
    Returns:
    
    The field entry in the string, or the default value if it doesn't exist or the string is null.
  - asString
```
public static String asString(Object o)
```
    Calls Object.toString() on the specified object if it's not null.
    
    Parameters:
    
    o - The object to convert to a string.
    
    Returns:
    
    The object converted to a string, or null if the object was null.
  - asStrings
```
public static String[] asStrings(Object... o)
```
    Converts an array of objects to an array of strings.
    
    Parameters:
    
    o - The array of objects to convert to strings.
    
    Returns:
    
    A new array of objects converted to strings.
  - fromHexToUTF8
```
public static String fromHexToUTF8(String hex)
```
    Converts a hexadecimal byte stream (e.g. "34A5BC") into a UTF-8 encoded string.
    
    Parameters:
    
    hex - The hexadecimal string.
    
    Returns:
    
    The UTF-8 string.
  - fromSpacedHexToUTF8
```
public static String fromSpacedHexToUTF8(String hex)
```
    Converts a space-deliminted hexadecimal byte stream (e.g. "34 A5 BC") into a UTF-8 encoded string.
    
    Parameters:
    
    hex - The hexadecimal string.
    
    Returns:
    
    The UTF-8 string.
  - toHex
```
public static String toHex(byte[] bytes)
```
    Converts a byte array into a simple hexadecimal character string.
    
    Parameters:
    
    bytes - The bytes to convert to hexadecimal.
    
    Returns:
    
    A new string consisting of hexadecimal characters.
  - toSpacedHex
```
public static String toSpacedHex(byte[] bytes)
```
    Same as toHex(byte[]) but puts spaces between the byte strings.
    
    Parameters:
    
    bytes - The bytes to convert to hexadecimal.
    
    Returns:
    
    A new string consisting of hexadecimal characters.
  - fromHex
```
public static byte[] fromHex(String hex)
```
    Converts a hexadecimal character string to a byte array.
    
    Parameters:
    
    hex - The string to convert to a byte array.
    
    Returns:
    
    A new byte array.
  - fromSpacedHex
```
public static byte[] fromSpacedHex(String hex)
```
    Same as fromHex(String) except expects spaces between the byte strings.
    
    Parameters:
    
    hex - The string to convert to a byte array.
    
    Returns:
    
    A new byte array.
  - repeat
```
public static String repeat(int count,
                            String pattern)
```
    Creates a repeated pattern.
    
    Parameters:
    
    count - The number of times to repeat the pattern.
    
    pattern - The pattern to repeat.
    
    Returns:
    
    A new string consisting of the repeated pattern.
  - trimStart
```
public static String trimStart(String s)
```
    Trims whitespace characters from the beginning of the specified string.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    The trimmed string, or null if the string was null.
  - trimEnd
```
public static String trimEnd(String s)
```
    Trims whitespace characters from the end of the specified string.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    The trimmed string, or null if the string was null.
  - isOneOf
```
public static boolean isOneOf(String s,
                              String... values)
```
    Returns true if the specified string is one of the specified values.
    
    Parameters:
    
    s - The string to test. Can be null.
    
    values - The values to test. Can contain null.
    
    Returns:
    
    true if the specified string is one of the specified values.
  - trimSlashes
```
public static String trimSlashes(String s)
```
    Trims '/' characters from both the start and end of the specified string.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    A new trimmed string, or the same string if no trimming was necessary.
  - trimTrailingSlashes
```
public static String trimTrailingSlashes(String s)
```
    Trims '/' characters from the end of the specified string.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    A new trimmed string, or the same string if no trimming was necessary.
  - trimTrailingSlashes
```
public static StringBuffer trimTrailingSlashes(StringBuffer s)
```
    Trims '/' characters from the end of the specified string.
    
    Parameters:
    
    s - The string to trim.
    
    Returns:
    
    The same string buffer.
  - urlEncode
```
public static String urlEncode(Object o)
```
    Shortcut for calling URLEncoder.encode(o.toString(), "UTF-8").
    
    Parameters:
    
    o - The object to encode.
    
    Returns:
    
    The URL encoded string, or null if the object was null.
  - urlEncodePath
```
public static String urlEncodePath(Object o)
```
    Similar to urlEncode(Object) but doesn't encode "/" characters.
    
    Parameters:
    
    o - The object to encode.
    
    Returns:
    
    The URL encoded string, or null if the object was null.
  - urlDecode
```
public static String urlDecode(String s)
```
    Decodes a application/x-www-form-urlencoded string using UTF-8 encoding scheme.
    
    Parameters:
    
    s - The string to decode.
    
    Returns:
    
    The decoded string, or null if input is null.
  - urlEncode
```
public static String urlEncode(String s)
```
    Encodes a application/x-www-form-urlencoded string using UTF-8 encoding scheme.
    
    Parameters:
    
    s - The string to encode.
    
    Returns:
    
    The encoded string, or null if input is null.
  - urlEncodeLax
```
public static String urlEncodeLax(String s)
```
    Same as urlEncode(String) except only escapes characters that absolutely need to be escaped.
    
    Parameters:
    
    s - The string to escape.
    
    Returns:
    
    The encoded string, or null if input is null.
  - splitEqually
```
public static List<String> splitEqually(String s,
                                        int size)
```
    Splits a string into equally-sized parts.
    
    Parameters:
    
    s - The string to split.
    
    size - The token sizes.
    
    Returns:
    
    The tokens, or null if the input was null.
  - firstNonWhitespaceChar
```
public static char firstNonWhitespaceChar(String s)
```
    Returns the first non-whitespace character in the string.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    The first non-whitespace character, or 0 if the string is null, empty, or composed of only whitespace.
  - lastNonWhitespaceChar
```
public static char lastNonWhitespaceChar(String s)
```
    Returns the last non-whitespace character in the string.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    The last non-whitespace character, or 0 if the string is null, empty, or composed of only whitespace.
  - charAt
```
public static char charAt(String s,
                          int i)
```
    Returns the character at the specified index in the string without throwing exceptions.
    
    Parameters:
    
    s - The string.
    
    i - The index position.
    
    Returns:
    
    The character at the specified index, or 0 if the index is out-of-range or the string is null.
  - isAbsoluteUri
```
public static boolean isAbsoluteUri(String s)
```
    Efficiently determines whether a URL is of the pattern "xxx://xxx"
    
    Parameters:
    
    s - The string to test.
    
    Returns:
    
    true if it's an absolute path.
  - isUri
```
public static boolean isUri(String s)
```
    Efficiently determines whether a URL is of the pattern "xxx:/xxx".
    The pattern matched is: [a-z]{2,}\:\/.*
    Note that this excludes filesystem paths such as "C:/temp".
    
    Parameters:
    
    s - The string to test.
    
    Returns:
    
    true if it's an absolute path.
  - getAuthorityUri
```
public static String getAuthorityUri(String s)
```
    Given an absolute URI, returns just the authority portion (e.g. "http://hostname:port")
    
    Parameters:
    
    s - The URI string.
    
    Returns:
    
    Just the authority portion of the URI.
  - toURI
```
public static URI toURI(Object o)
```
    Converts the specified object to a URI.
    
    Parameters:
    
    o - The object to convert to a URI.
    
    Returns:
    
    A new URI, or the same object if the object was already a URI, or
  - firstNonEmpty
```
public static String firstNonEmpty(String... s)
```
    Returns the first non-null, non-empty string in the list.
    
    Parameters:
    
    s - The strings to test.
    
    Returns:
    
    The first non-empty string in the list, or null if they were all null or empty.
  - indexOf
```
public static int indexOf(String s,
                          char... c)
```
    Same as String.indexOf(int) except allows you to check for multiple characters.
    
    Parameters:
    
    s - The string to check.
    
    c - The characters to check for.
    
    Returns:
    
    The index into the string that is one of the specified characters.
  - format
```
public static String format(String pattern,
                            Object... args)
```
    Similar to MessageFormat.format(String, Object...) except allows you to specify POJO arguments.
    
    Parameters:
    
    pattern - The string pattern.
    
    args - The arguments.
    
    Returns:
    
    The formatted string.
  - parseIntWithSuffix
```
public static int parseIntWithSuffix(String s)
```
    Converts a string containing a possible multiplier suffix to an integer.
    The string can contain any of the following multiplier suffixes:
    - "K" - x 1024
    - "M" - x 1024*1024
    - "G" - x 1024*1024*1024
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed value.
  - parseLongWithSuffix
```
public static long parseLongWithSuffix(String s)
```
    Converts a string containing a possible multiplier suffix to a long.
    The string can contain any of the following multiplier suffixes:
    - "K" - x 1024
    - "M" - x 1024*1024
    - "G" - x 1024*1024*1024
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed value.
  - contains
```
public static boolean contains(String value,
                               CharSequence substring)
```
    Same as String.contains(CharSequence) except returns null if the value is null.
    
    Parameters:
    
    value - The string to check.
    
    substring - The value to check for.
    
    Returns:
    
    true if the value contains the specified substring.
  - isObjectList
```
public static boolean isObjectList(Object o,
                                   boolean ignoreWhitespaceAndComments)
```
    Returns true if the specified string appears to be an JSON array.
    
    Parameters:
    
    o - The object to test.
    
    ignoreWhitespaceAndComments - If true, leading and trailing whitespace and comments will be ignored.
    
    Returns:
    
    true if the specified string appears to be a JSON array.
  - parseListOrCdl
```
public static ObjectList parseListOrCdl(String s)
                                 throws ParseException
```
    Parses a string that can consist of either a JSON array or comma-delimited list.
    The type of string is auto-detected.
    
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed string.
    
    Throws:
    
    ParseException
  - isJson
```
public static boolean isJson(String s)
```
    Returns true if the specified string is valid JSON.
    Leading and trailing spaces are ignored.
    Leading and trailing comments are not allowed.
    
    Parameters:
    
    s - The string to test.
    
    Returns:
    
    true if the specified string is valid JSON.
  - isObjectMap
```
public static boolean isObjectMap(Object o,
                                  boolean ignoreWhitespaceAndComments)
```
    Returns true if the specified string appears to be a JSON object.
    
    Parameters:
    
    o - The object to test.
    
    ignoreWhitespaceAndComments - If true, leading and trailing whitespace and comments will be ignored.
    
    Returns:
    
    true if the specified string appears to be a JSON object.
  - getNumberedLines
```
public static String getNumberedLines(String s)
```
    Takes in a string, splits it by lines, and then prepends each line with line numbers.
    
    Parameters:
    
    s - The string.
    
    Returns:
    
    The string with line numbers added.
  - getNumberedLines
```
public static String getNumberedLines(String s,
                                      int start,
                                      int end)
```
    Same as getNumberedLines(String) except only returns the specified lines.
    Out-of-bounds values are allowed and fixed.
    
    Parameters:
    
    s - The string.
    
    start - The starting line (1-indexed).
    
    end - The ending line (1-indexed).
    
    Returns:
    
    The string with line numbers added.
  - compare
```
public static int compare(String s1,
                          String s2)
```
    Compares two strings, but gracefully handles nulls.
    
    Parameters:
    
    s1 - The first string.
    
    s2 - The second string.
    
    Returns:
    
    The same as String.compareTo(String).
  - firstChar
```
public static char firstChar(String s)
```
    Returns the first character in the specified string.
    
    Parameters:
    
    s - The string to check.
    
    Returns:
    
    The first character in the string, or 0 if the string is null or empty.
  - getMatchPattern
```
public static Pattern getMatchPattern(String s)
```
    Converts a string containing "*" meta characters with a regular expression pattern.
    
    Parameters:
    
    s - The string to create a pattern from.
    
    Returns:
    
    A regular expression pattern.
  - toLowerCase
```
public static String toLowerCase(String s)
```
    Null-safe String.toLowerCase().
    
    Parameters:
    
    s - The string to convert to lower case.
    
    Returns:
    
    The string converted to lower case, or null if the string was null.
  - getDuration
```
public static long getDuration(String s)
```
    Parses a duration string.
    Examples:
    - "1000" - 1000 milliseconds.
    - "10s" - 10 seconds.
    - "10 sec" - 10 seconds.
    - "10 seconds" - 10 seconds.
    Use any of the following suffixes:
    - None (time in milliseconds).
    - "s"/"sec"/"second"/"seconds"
    - "m"/"min"/"minutes"/"seconds"
    - "h"/"hour"/"hours"
    - "d"/"day"/"days"
    - "w"/"week"/"weeks"
    Suffixes are case-insensitive.
    Whitespace is ignored.
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The time in milliseconds, or -1 if the string is empty or null.

Class StringUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringUtils

Method Detail

parseNumber

parseNumberString

parseNumber

parseCharacter

isNumeric

isFirstNumberChar

isFloat

isDecimal

getStackTrace

join

join

join

join

join

joine

join

joine

join

join

joine

joinnl

split

split

split

split

splitMap

containsAny

splitQuoted

isEmpty

isEmpty

isNotEmpty

isNotEmpty

nullIfEmpty

emptyIfNull

emptyIfNull

unEscapeChars

escapeChars

decodeHex

startsWith

endsWith

endsWith

toHex2

toHex4

toHex8

isEquals

isNotEquals

base64EncodeToString

base64Encode

base64DecodeToString

base64Decode

generateUUID

trim

parseIsoDate

parseIsoCalendar

toIsoDate

toIsoDateTime

replaceVars

pathStartsWith

Example:

pathStartsWith

replaceUnicodeSequences

unicodeSequence

getField

getField

asString

asStrings

fromHexToUTF8

fromSpacedHexToUTF8

toHex

toSpacedHex

fromHex

fromSpacedHex

repeat