StringTools (intarsys runtime library)

java.lang.Object
- de.intarsys.tools.string.StringTools

```
public class StringTools
extends Object
```
A tool class for the handling of strings.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CR`
`static String`	`CRLF`
`static String`	`DATEFORMAT_SIMPLE`
`static String`	`EMPTY` An empty string constant
`static Map<Character,String>`	`ESCAPES`
`static String`	`FORMAT_D`
`static String`	`FORMAT_F`
`static String`	`FORMAT_I`
`static String`	`FORMAT_P`
`static String`	`FORMAT_S`
`static String`	`FORMAT_T`
`static String`	`LF`
`static String`	`LS`
`static String`	`SPACE` An single space constant

Constructor Summary

Constructors
Constructor and Description

StringTools()

Constructors
Constructor and Description
`StringTools()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`breakForced(String value, int max, String breakPattern)`
`static String`	`capitalize(String text)` Capitalizes the first letter of the text.
`static void`	`clear(char[] value)` clear character array content.
`static String`	`decapitalize(String text)` De-Capitalizes the first letter of the text.
`static String`	`format(Object value, String format)` Create a string representation and format `value` according to the instructions in `format`.
`static String`	`getCommonPrefix(String a, String b, boolean ignoreCase)` Get the common prefix contained both in a and b.
`static String`	`getFirstLine(String text)` The first line of text (all characters up to the first occurrence of either "\n" or "\r".
`static String`	`getLeading(String value, int count)`
`static int`	`getLineCount(String text)` The number of lines in `text`.
`static String`	`getOptionValue(String option, String[] args)` Get a value for the command line option pattern "-
`static String`	`getTrailing(String value, int count)`
`static boolean`	`isEmpty(char[] value)` `true` if `value` is "empty" in any respect.
`static boolean`	`isEmpty(String value)` `true` if `value` is "empty" in any respect.
`static boolean`	`isNumeric(String value)` `true` if `value` seems to be a numeric value.
`static String`	`join(List<String> elements, String separator)` Joins a List of Strings to a single one.
`static String`	`join(String[] elements, String separator)` Joins an array of Strings to a single one.
`static String`	`padLeft(String value, int count)`
`static String`	`padRight(String value, int count)`
`static String[]`	`parseCommandline(String line)` Parse a commandline string with the default escape character.
`static String[]`	`parseCommandline(String line, char escape)` Parse a commandline string.
`static String`	`pathAppend(String prefix, String separator, String name)` Create a new path from the concatenation of prefix and name.
`static String`	`quote(String value)`
`static String`	`safeString(Object object)` Create a string representation of `object` that is guaranteed not to fail in any case.
`static byte[]`	`toByteArray(String value)` Create a byte array from the string.
`static String`	`toCamelCase(String value, String allowed)` Convert value to camel case notation.
`static String`	`toString(byte[] value)` Create a string from the byte array.
`static String`	`trimAlphaNumeric(String value)` Create a string containing only the alphanumeric content of `value`.
`static String`	`trimLeft(String value)` Create a new string from `value` without leading whitespace.
`static String`	`trimRight(String value)` Create a new string from `value` without trailing whitespace.
`static String`	`unquote(String value)` Remove the quotes around a string.

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

- Field Detail
  - CR
```
public static final String CR
```
    See Also:
    Constant Field Values
  - CRLF
```
public static final String CRLF
```
    See Also:
    Constant Field Values
  - LF
```
public static final String LF
```
    See Also:
    Constant Field Values
  - LS
```
public static final String LS
```
  - DATEFORMAT_SIMPLE
```
public static final String DATEFORMAT_SIMPLE
```
    See Also:
    Constant Field Values
  - EMPTY
```
public static final String EMPTY
```
    An empty string constant
    
    See Also:
    Constant Field Values
  - FORMAT_D
```
public static final String FORMAT_D
```
    See Also:
    Constant Field Values
  - FORMAT_F
```
public static final String FORMAT_F
```
    See Also:
    Constant Field Values
  - FORMAT_I
```
public static final String FORMAT_I
```
    See Also:
    Constant Field Values
  - FORMAT_P
```
public static final String FORMAT_P
```
    See Also:
    Constant Field Values
  - FORMAT_T
```
public static final String FORMAT_T
```
    See Also:
    Constant Field Values
  - FORMAT_S
```
public static final String FORMAT_S
```
    See Also:
    Constant Field Values
  - SPACE
```
public static final String SPACE
```
    An single space constant
    
    See Also:
    Constant Field Values
  - ESCAPES
```
public static final Map<Character,String> ESCAPES
```
- Constructor Detail
  - StringTools
```
public StringTools()
```
- Method Detail
  - breakForced
```
public static String breakForced(String value,
                 int max,
                 String breakPattern)
```
  - capitalize
```
public static String capitalize(String text)
```
    Capitalizes the first letter of the text.
    
    Parameters:
    text -
    
    Returns:
    a capitalized version of the text
  - clear
```
public static void clear(char[] value)
```
    clear character array content.
    
    Parameters:
    value - The value to be cleared
  - decapitalize
```
public static String decapitalize(String text)
```
    De-Capitalizes the first letter of the text.
    
    Parameters:
    text -
    
    Returns:
    a de-capitalized version of the text
  - format
```
public static String format(Object value,
            String format)
```
    Create a string representation and format value according to the instructions in format.
    If value is null, the empty string is returned.
  - getCommonPrefix
```
public static String getCommonPrefix(String a,
                     String b,
                     boolean ignoreCase)
```
    Get the common prefix contained both in a and b. Example:
```
 a "foo"
 b "bar"
 -> ""
 
```
```
 a "gnu"
 b "gnat"
 -> "gn"
 
```
    Parameters:
    a -
    b -
    ignoreCase -
    
    Returns:
    The common prefix contained both in a and b.
  - getFirstLine
```
public static String getFirstLine(String text)
```
    The first line of text (all characters up to the first occurrence of either "\n" or "\r".
    
    Parameters:
    text - The text where the first line is looked up.
    
    Returns:
    The first line of text
  - getLeading
```
public static String getLeading(String value,
                int count)
```
  - getLineCount
```
public static int getLineCount(String text)
```
    The number of lines in text. This is 1 + the number of "\n" in text.
    
    Parameters:
    text - The text where the lines are counted.
    
    Returns:
    The number of lines in text. This is 1 + the number of "\n" in text.
  - getOptionValue
```
public static String getOptionValue(String option,
                    String[] args)
```
    Get a value for the command line option pattern "-
    
    Parameters:
    option - the name of the option
    args - command line args to search
    
    Returns:
    the options value or null
  - getTrailing
```
public static String getTrailing(String value,
                 int count)
```
  - isEmpty
```
public static boolean isEmpty(char[] value)
```
    true if value is "empty" in any respect.
    This is the case when value == null, value has no characters or only whitespace.
    
    Parameters:
    value - The value to be inspected for emptyness.
    
    Returns:
    true if value is "empty" in any respect.
  - isEmpty
```
public static boolean isEmpty(String value)
```
    true if value is "empty" in any respect.
    This is the case when value == null, value has no characters or only whitespace.
    
    Parameters:
    value - The value to be inspected for emptyness.
    
    Returns:
    true if value is "empty" in any respect.
  - isNumeric
```
public static boolean isNumeric(String value)
```
    true if value seems to be a numeric value. To qualify only the first character is examined. value qualifies as numeric if the first character is a digit, a "+", a "-" or a ".".
    
    Parameters:
    value -
    
    Returns:
    true if value seems to be numeric.
  - join
```
public static String join(List<String> elements,
          String separator)
```
    Joins a List of Strings to a single one. All elements are separated by the separator.
    
    Parameters:
    elements - List of Strings
    separator - a String used as a separator between two elements, e.g. "\n" for a new line. May be null.
    
    Returns:
    the joined string
  - join
```
public static String join(String[] elements,
          String separator)
```
    Joins an array of Strings to a single one. All elements are separated by the separator.
    
    Parameters:
    elements - array of Strings
    separator - a String used as a separator between two elements, e.g. "\n" for a new line. May be null.
    
    Returns:
    the joined string
  - padLeft
```
public static String padLeft(String value,
             int count)
```
  - padRight
```
public static String padRight(String value,
              int count)
```
  - parseCommandline
```
public static String[] parseCommandline(String line)
```
    Parse a commandline string with the default escape character.
    
    Parameters:
    line - The commandline string.
    
    Returns:
    The array of string tokens in the commandline string.
  - parseCommandline
```
public static String[] parseCommandline(String line,
                        char escape)
```
    Parse a commandline string.
    
    Parameters:
    line - The commandline string.
    
    Returns:
    The array of string tokens in the commandline string.
  - pathAppend
```
public static String pathAppend(String prefix,
                String separator,
                String name)
```
    Create a new path from the concatenation of prefix and name.
    
    Parameters:
    prefix -
    separator -
    name -
    
    Returns:
    The new path
  - quote
```
public static String quote(String value)
```
  - safeString
```
public static String safeString(Object object)
```
    Create a string representation of object that is guaranteed not to fail in any case.
    
    Parameters:
    object - The object to be printed.
    
    Returns:
    Create a string representation of object that is guaranteed not to fail in any case.
  - toByteArray
```
public static byte[] toByteArray(String value)
```
    Create a byte array from the string. This is simply a fast version of getBytes, ignoring any encoding.
    If you use this, you should be sure you will encounter valid ascii characters only!
    
    Parameters:
    value -
    
    Returns:
    A byte array created from value, ignoring high byte.
  - toCamelCase
```
public static String toCamelCase(String value,
                 String allowed)
```
    Convert value to camel case notation.
    value is tokenized at non alphanumeric characters, separator characters are ignored. all tokens are converted to lowercase and then for all tokens except the first the first character is uppercased.
    The implementation tries to detect if value is already a camel case string and preserves it.
    
    Parameters:
    value -
    
    Returns:
    value in camel case notation
  - toString
```
public static String toString(byte[] value)
```
    Create a string from the byte array. This is simply a fast version of new String(), ignoring any encoding.
    If you use this, you should be sure you will encounter valid ascii characters only!
    
    Parameters:
    value -
    
    Returns:
    A string created from the byte values in value.
  - trimAlphaNumeric
```
public static String trimAlphaNumeric(String value)
```
    Create a string containing only the alphanumeric content of value.
    
    Parameters:
    value - The string to be trimmed.
    
    Returns:
    A string containing only the alphanumeric content of value.
  - trimLeft
```
public static String trimLeft(String value)
```
    Create a new string from value without leading whitespace.
    
    Parameters:
    value - The string to be stripped.
    
    Returns:
    A copy of value with leading whitespace stripped.
  - trimRight
```
public static String trimRight(String value)
```
    Create a new string from value without trailing whitespace.
    
    Parameters:
    value - The string to be stripped.
    
    Returns:
    A copy of value with trailing whitespace stripped.
  - unquote
```
public static String unquote(String value)
                      throws IOException
```
    Remove the quotes around a string. Any character escaped by "\" within the quoted string is embedded unescaped.
    
    Parameters:
    value -
    
    Returns:
    
    Throws:
    
    IOException

Class StringTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CR

CRLF

LF

LS

DATEFORMAT_SIMPLE

EMPTY

FORMAT_D

FORMAT_F

FORMAT_I

FORMAT_P

FORMAT_T

FORMAT_S

SPACE

ESCAPES

Constructor Detail

StringTools

Method Detail

breakForced

capitalize

clear

decapitalize

format

getCommonPrefix

getFirstLine

getLeading

getLineCount

getOptionValue

getTrailing

isEmpty

isEmpty

isNumeric

join

join

padLeft

padRight

parseCommandline

parseCommandline

pathAppend

quote

safeString

toByteArray

toCamelCase

toString

trimAlphaNumeric

trimLeft

trimRight

unquote