StrUtil (Fujion Common Library 3.1.0 API)

java.lang.Object
- org.fujion.common.StrUtil

```
public class StrUtil
extends Object
```
Utility methods for managing strings.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CRLF`
`static String`	`CRLF2`
`static String`	`DQT`
`static String`	`LINE_TERMINATOR`
`static String`	`SQT`
`static Charset`	`UTF8`
`static String`	`UTF8_STR`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areEqual(String s1, String s2, boolean caseSensitive)` Returns true if two strings are equal.
`static int`	`compare(String s1, String s2)` Null-safe, case-sensitive comparison of two strings.
`static int`	`compareIgnoreCase(String s1, String s2)` Null-safe, case-insensitive comparison of two strings.
`static String`	`enquoteDouble(String value)` Surround value with double quotes if not already so.
`static String`	`enquoteSingle(String value)` Surround value with single quotes if not already so.
`static int`	`extractInt(String value)` Extracts an integer portion at the beginning of a string.
`static String`	`extractIntPrefix(String value)` Extracts an integer portion at the beginning of a string.
`static String`	`formatMessage(String msg, Locale locale, Object... args)` Formats a message.
`static String`	`formatMessage(String msg, Object... args)` Formats a message.
`static String`	`fromList(Iterable<?> list)` Builds a newline-delimited string from a list.
`static String`	`fromList(Iterable<?> list, String delimiter)` Builds a delimited string from a list.
`static String`	`fromList(Iterable<?> list, String delimiter, String dflt)` Builds a delimited string from a list.
`static String`	`getLabel(String id, Locale locale, Object... args)` Returns a formatted message given a label identifier.
`static String`	`getLabel(String id, Object... args)` Returns a formatted message given a label identifier.
`static String`	`piece(String text, String delimiter)` Returns the first piece of text as delimited by delimiter.
`static String`	`piece(String text, String delimiter, int position)` Returns the specified piece of text as delimited by delimiter.
`static String`	`piece(String text, String delimiter, int start, int end)` Performs the equivalent of the MUMPS piece function.
`static String[]`	`split(String text, String delimiter)` Splits a string using the specified delimiter.
`static String[]`	`split(String text, String delimiter, int count)` Splits a string using the specified delimiter.
`static String[]`	`split(String text, String delimiter, int count, boolean nonull)` Splits a string using the specified delimiter.
`static StringBuilder`	`strAppend(StringBuilder sb, String value)` Append a value to a string builder, using specified separator.
`static StringBuilder`	`strAppend(StringBuilder sb, String value, String separator)` Append a value to a string builder, using specified separator.
`static String`	`strAppend(String text, String value)` Append a value to a text string, using default separator (comma).
`static String`	`strAppend(String text, String value, String separator)` Append a value to a text string, using specified separator.
`static String`	`stripQuotes(String value)` Strip enclosing quotes (double or single) from a string.
`static String`	`strTruncate(String value, int maxLength)` Truncates a string if it exceeds a maximum length, appending an ellipsis to the end.
`static boolean`	`toBoolean(String text)` Converts a text value to a boolean result.
`static String`	`toCamelCaseLower(String text)` Converts a string to lower camel case using whitespace and underscores as word boundaries.
`static String`	`toCamelCaseUpper(String text)` Converts a string to upper camel case using whitespace and underscores as word boundaries.
`static String`	`toDelimitedStr(String delimiter, Object... params)` Converts a parameter list into a delimited string
`static double`	`toDouble(String text)` Converts a text value to a double.
`static int`	`toInt(String text)` Converts a text value to an integer.
`static List<String>`	`toList(String text)` Converts a string containing a '\n'-delimited list of elements to a string list.
`static List<String>`	`toList(String text, List<String> list)` Converts a string containing a '\n'-delimited list of elements to a string list.
`static List<String>`	`toList(String text, List<String> list, String delimiter)` Converts a string containing a delimited list of elements to a string list.
`static List<String>`	`toList(String text, String delimiter)` Converts a string containing a delimited list of elements to a string list.
`static long`	`toLong(String text)` Converts a text value to a long integer.
`static String`	`xlate(String text, String from, String to)` Replaces one set of characters with another.

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

- Field Detail
  - CRLF
```
public static final String CRLF
```
    See Also:
    
    Constant Field Values
  - CRLF2
```
public static final String CRLF2
```
    See Also:
    
    Constant Field Values
  - LINE_TERMINATOR
```
public static final String LINE_TERMINATOR
```
    See Also:
    
    Constant Field Values
  - DQT
```
public static final String DQT
```
    See Also:
    
    Constant Field Values
  - SQT
```
public static final String SQT
```
    See Also:
    
    Constant Field Values
  - UTF8
```
public static final Charset UTF8
```
  - UTF8_STR
```
public static final String UTF8_STR
```
- Method Detail
  - split
```
public static String[] split(String text,
                             String delimiter)
```
    Splits a string using the specified delimiter.
    
    Parameters:
    
    text - The string to split.
    
    delimiter - The delimiter for the split operation.
    
    Returns:
    
    A string array containing the split values. The returned array is guaranteed not to contain null values by replacing every occurrence of a null value with an empty string.
  - split
```
public static String[] split(String text,
                             String delimiter,
                             int count)
```
    Splits a string using the specified delimiter.
    
    Parameters:
    
    text - The string to split.
    
    delimiter - The delimiter for the split operation.
    
    count - Specifies a minimum number of elements to be returned. If the result of the split operation results in fewer elements, the returned array is expanded to contain the minimum number of elements.
    
    Returns:
    
    A string array containing the split values. The returned array is guaranteed not to contain null values by replacing every occurrence of a null value with an empty string.
  - split
```
public static String[] split(String text,
                             String delimiter,
                             int count,
                             boolean nonull)
```
    Splits a string using the specified delimiter.
    
    Parameters:
    
    text - The string to split.
    
    delimiter - The delimiter for the split operation.
    
    count - Specifies a minimum number of elements to be returned. If the result of the split operation results in fewer elements, the returned array is expanded to contain the minimum number of elements.
    
    nonull - If true, the returned array is guaranteed not to contain null values by replacing every occurrence of a null value with an empty string.
    
    Returns:
    
    A string array containing the split values.
  - strTruncate
```
public static String strTruncate(String value,
                                 int maxLength)
```
    Truncates a string if it exceeds a maximum length, appending an ellipsis to the end.
    
    Parameters:
    
    value - String value to modify.
    
    maxLength - Maximum length for string.
    
    Returns:
    
    Original string if less than or equal to the maximum length. Otherwise, a truncated string with an ellipsis appended.
  - strAppend
```
public static StringBuilder strAppend(StringBuilder sb,
                                      String value)
```
    Append a value to a string builder, using specified separator.
    
    Parameters:
    
    sb - StringBuilder instance to append to.
    
    value - Value to append.
    
    Returns:
    
    The StringBuilder instance (for chaining).
  - strAppend
```
public static StringBuilder strAppend(StringBuilder sb,
                                      String value,
                                      String separator)
```
    Append a value to a string builder, using specified separator.
    
    Parameters:
    
    sb - StringBuilder instance to append to.
    
    value - Value to append.
    
    separator - String to use as separator.
    
    Returns:
    
    The StringBuilder instance (for chaining).
  - strAppend
```
public static String strAppend(String text,
                               String value)
```
    Append a value to a text string, using default separator (comma).
    
    Parameters:
    
    text - Text string to append to.
    
    value - Value to append.
    
    Returns:
    
    Text string with value appended.
  - strAppend
```
public static String strAppend(String text,
                               String value,
                               String separator)
```
    Append a value to a text string, using specified separator.
    
    Parameters:
    
    text - Text string to append to.
    
    value - Value to append.
    
    separator - String to use as separator.
    
    Returns:
    
    Text string with value appended.
  - toDelimitedStr
```
public static String toDelimitedStr(String delimiter,
                                    Object... params)
```
    Converts a parameter list into a delimited string
    
    Parameters:
    
    delimiter - Delimiter to use.
    
    params - The parameter list.
    
    Returns:
    
    Parameters as a delimited string.
  - piece
```
public static String piece(String text,
                           String delimiter)
```
    Returns the first piece of text as delimited by delimiter.
    
    Parameters:
    
    text - Text to piece.
    
    delimiter - Delimiter for piecing.
    
    Returns:
    
    First piece of text.
  - piece
```
public static String piece(String text,
                           String delimiter,
                           int position)
```
    Returns the specified piece of text as delimited by delimiter.
    
    Parameters:
    
    text - Text to piece.
    
    delimiter - Delimiter for piecing.
    
    position - Position of piece to extract.
    
    Returns:
    
    The requested text piece.
  - piece
```
public static String piece(String text,
                           String delimiter,
                           int start,
                           int end)
```
    Performs the equivalent of the MUMPS piece function.
    
    Parameters:
    
    text - Text to piece.
    
    delimiter - Delimiter for piecing.
    
    start - First piece to return.
    
    end - Last piece to return.
    
    Returns:
    
    The requested text pieces.
  - extractInt
```
public static int extractInt(String value)
```
    Extracts an integer portion at the beginning of a string. Parsing stops when a non-digit character or the end of the string is encountered.
    
    Parameters:
    
    value - String value to parse
    
    Returns:
    
    The integer value at the beginning of the string.
  - extractIntPrefix
```
public static String extractIntPrefix(String value)
```
    Extracts an integer portion at the beginning of a string. Parsing stops when a non-digit character or the end of the string is encountered.
    
    Parameters:
    
    value - String value to parse
    
    Returns:
    
    The integer prefix (as a string) of the parsed string.
  - stripQuotes
```
public static String stripQuotes(String value)
```
    Strip enclosing quotes (double or single) from a string.
    
    Parameters:
    
    value - Input value.
    
    Returns:
    
    Input value without the enclosing quotes.
  - enquoteDouble
```
public static String enquoteDouble(String value)
```
    Surround value with double quotes if not already so.
    
    Parameters:
    
    value - Value to enquote.
    
    Returns:
    
    Enquoted value (or null if value was null).
  - enquoteSingle
```
public static String enquoteSingle(String value)
```
    Surround value with single quotes if not already so.
    
    Parameters:
    
    value - Value to enquote.
    
    Returns:
    
    Enquoted value (or null if value was null).
  - compare
```
public static int compare(String s1,
                          String s2)
```
    Null-safe, case-sensitive comparison of two strings.
    
    Parameters:
    
    s1 - First string to compare.
    
    s2 - Second string to compare.
    
    Returns:
    
    Result of comparison.
  - compareIgnoreCase
```
public static int compareIgnoreCase(String s1,
                                    String s2)
```
    Null-safe, case-insensitive comparison of two strings.
    
    Parameters:
    
    s1 - First string to compare.
    
    s2 - Second string to compare.
    
    Returns:
    
    Result of comparison.
  - areEqual
```
public static boolean areEqual(String s1,
                               String s2,
                               boolean caseSensitive)
```
    Returns true if two strings are equal.
    
    Parameters:
    
    s1 - First string to compare.
    
    s2 - Second string to compare.
    
    caseSensitive - If true, perform a case-sensitive comparison.
    
    Returns:
    
    True if the two strings are equal.
  - toBoolean
```
public static boolean toBoolean(String text)
```
    Converts a text value to a boolean result.
    
    Parameters:
    
    text - Value to convert. Non-zero numeric values or values beginning with a T, t, Y, or y evaluate to true.
    
    Returns:
    
    The result of the conversion.
  - toInt
```
public static int toInt(String text)
```
    Converts a text value to an integer.
    
    Parameters:
    
    text - Value to convert.
    
    Returns:
    
    The result of the conversion.
  - toLong
```
public static long toLong(String text)
```
    Converts a text value to a long integer.
    
    Parameters:
    
    text - Value to convert.
    
    Returns:
    
    The result of the conversion.
  - toDouble
```
public static double toDouble(String text)
```
    Converts a text value to a double.
    
    Parameters:
    
    text - Value to convert.
    
    Returns:
    
    The result of the conversion.
  - toList
```
public static List<String> toList(String text)
```
    Converts a string containing a '\n'-delimited list of elements to a string list.
    
    Parameters:
    
    text - The string containing the '\n'-delimited elements.
    
    Returns:
    
    A list containing the parsed elements.
  - toList
```
public static List<String> toList(String text,
                                  String delimiter)
```
    Converts a string containing a delimited list of elements to a string list.
    
    Parameters:
    
    text - The string containing the delimited elements.
    
    delimiter - The delimiter that separates the elements in the input string.
    
    Returns:
    
    A list containing the parsed elements.
  - toList
```
public static List<String> toList(String text,
                                  List<String> list)
```
    Converts a string containing a '\n'-delimited list of elements to a string list.
    
    Parameters:
    
    text - The string containing the '\n'-delimited elements.
    
    list - The string list that will receive the parsed elements. If null, a new list is created. If not null, the list is cleared before adding elements.
    
    Returns:
    
    A list containing the parsed elements. If the input list was not null, that instance is returned. Otherwise, a newly created list is returned.
  - toList
```
public static List<String> toList(String text,
                                  List<String> list,
                                  String delimiter)
```
    Converts a string containing a delimited list of elements to a string list.
    
    Parameters:
    
    text - The string containing the delimited elements.
    
    list - The string list that will receive the parsed elements. If null, a new list is created. If not null, the list is cleared before adding elements.
    
    delimiter - The delimiter that separates the elements in the input string.
    
    Returns:
    
    A list containing the parsed elements. If the input list was not null, that instance is returned. Otherwise, a newly created list is returned.
  - fromList
```
public static String fromList(Iterable<?> list)
```
    Builds a newline-delimited string from a list.
    
    Parameters:
    
    list - The list of strings to concatenate.
    
    Returns:
    
    A string contains the list of elements separated by the newline character.
  - fromList
```
public static String fromList(Iterable<?> list,
                              String delimiter)
```
    Builds a delimited string from a list.
    
    Parameters:
    
    list - The list of strings to concatenate.
    
    delimiter - The delimiter to use to separate elements.
    
    Returns:
    
    A string contains the list of elements separated by the specified delimiter.
  - fromList
```
public static String fromList(Iterable<?> list,
                              String delimiter,
                              String dflt)
```
    Builds a delimited string from a list.
    
    Parameters:
    
    list - The list of strings to concatenate.
    
    delimiter - The delimiter to use to separate elements.
    
    dflt - The default value to use if a list entry is null.
    
    Returns:
    
    A string contains the list of elements separated by the specified delimiter.
  - toCamelCaseUpper
```
public static String toCamelCaseUpper(String text)
```
    Converts a string to upper camel case using whitespace and underscores as word boundaries.
    
    Parameters:
    
    text - Text to convert.
    
    Returns:
    
    Text as upper camel case.
  - toCamelCaseLower
```
public static String toCamelCaseLower(String text)
```
    Converts a string to lower camel case using whitespace and underscores as word boundaries.
    
    Parameters:
    
    text - Text to convert.
    
    Returns:
    
    Text as lower camel case.
  - xlate
```
public static String xlate(String text,
                           String from,
                           String to)
```
    Replaces one set of characters with another. Each character in the from parameter is replaced by the character in the corresponding position in the to parameter. If no corresponding character is present, the character is removed instead.
    
    Parameters:
    
    text - The string to modify.
    
    from - The list of characters to be replaced.
    
    to - The list of replacement characters.
    
    Returns:
    
    The modified input string.
  - formatMessage
```
public static String formatMessage(String msg,
                                   Locale locale,
                                   Object... args)
```
    Formats a message. If the message begins with "@", the remainder is assumed to be a label name that is resolved.
    
    Parameters:
    
    msg - Message to format or, if starts with "@", a label reference.
    
    locale - Optional locale
    
    args - Optional replaceable parameters.
    
    Returns:
    
    The formatted message.
  - formatMessage
```
public static String formatMessage(String msg,
                                   Object... args)
```
    Formats a message. If the message begins with "@", the remainder is assumed to be a label identifier that is resolved.
    
    Parameters:
    
    msg - Message to format or, if starts with "@", a label reference.
    
    args - Optional replaceable parameters.
    
    Returns:
    
    The formatted message.
  - getLabel
```
public static String getLabel(String id,
                              Object... args)
```
    Returns a formatted message given a label identifier.
    
    Parameters:
    
    id - A label identifier.
    
    args - Optional replaceable parameters.
    
    Returns:
    
    The formatted label.
  - getLabel
```
public static String getLabel(String id,
                              Locale locale,
                              Object... args)
```
    Returns a formatted message given a label identifier. Recognizes line continuation with backslash characters.
    
    Parameters:
    
    id - A label identifier.
    
    locale - The locale.
    
    args - Optional replaceable parameters.
    
    Returns:
    
    The formatted label.

Class StrUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CRLF

CRLF2

LINE_TERMINATOR

DQT

SQT

UTF8

UTF8_STR

Method Detail

split

split

split

strTruncate

strAppend

strAppend

strAppend

strAppend

toDelimitedStr

piece

piece

piece

extractInt

extractIntPrefix

stripQuotes

enquoteDouble

enquoteSingle

compare

compareIgnoreCase

areEqual

toBoolean

toInt

toLong

toDouble

toList

toList

toList

toList

fromList

fromList

fromList

toCamelCaseUpper

toCamelCaseLower

xlate

formatMessage

formatMessage

getLabel

getLabel