StringUtils (XDEV Application Framework 6.0.0 API)

java.lang.Object
- xdev.util.StringUtils

```
public final class StringUtils
extends Object
```
The StringUtils class provides utility methods for String handling.

Since:

2.0

Author:

XDEV Software

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StringUtils.ParameterProvider
Provides String parameter values for the format method.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StringUtils.ParameterProvider` Provides `String` parameter values for the format method.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LINEFEED` line feed constant used in StringUtils.
`static String`	`NEWLINE` newline constant used in StringUtils.
`static String`	`TAB` tab constant used in StringUtils.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`charAt(String str, int index)` Gets the character at `index` as new String.
`static String`	`concat(String separator, Collection<?> values)` Returns a `String` representation of all elements of the provided `Collection` `values` separated by the specified `separator`.
`static String`	`concat(String separator, Object... values)` Returns a `String` representation of all elements of the provided `values` separated by the specified `separator`.
`static boolean`	`contains(String str, String search)` Returns `true` if and only if `String` `str` contains the specified `String` `search`.
`static String`	`create(String source, int count)` Creates a new `String` with the value of n (provided `count`) times the provided `String` `str`.
`static XdevList<String>`	`explode(String str, String separator)` Splits a the `String` `str` at every separator `String` `separator`.
`static XdevList<String>`	`explode(String str, String separator, boolean returnDelimiters)` Splits a the `String` `str` at every separator `String` `separator`.
`static String`	`format(String str, Map<String,String> params)` Formats the `String` `str` by replacing the variables with values provided by `params`.
`static String`	`format(String str, StringUtils.ParameterProvider parameterProvider)` Formats the `String` `str` by replacing the variables with values provided by `parameterProvider`.
`static int`	`getUnicodeNr(char ch)` Returns the unicode number for the prodvied `ch`.
`static int`	`getUnicodeNr(String str)` Returns the unicode number for the prodvied `String` `str`.
`static String`	`getUnicodeString(int number)` Returns the unicode character for the provided number.
`static String`	`implode(Collection<?> list, String separator)` Deprecated. replaced by `concat(String, Collection)`
`static String`	`replaceAll(String source, String search, String replacement)` Replaces each substring of the given `String` `source` that matches the given `String` `search` with the given `String` `replacement`.
`static String`	`substr(String str, int start, int length)` Returns a new string that is a substring of `str`.

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

- Field Detail
  - NEWLINE
```
public static final String NEWLINE
```
    newline constant used in StringUtils.
    
    See Also:
    
    Constant Field Values
  - LINEFEED
```
public static final String LINEFEED
```
    line feed constant used in StringUtils.
    
    See Also:
    
    Constant Field Values
  - TAB
```
public static final String TAB
```
    tab constant used in StringUtils.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - charAt
```
public static String charAt(String str,
                            int index)
                     throws NullPointerException,
                            IndexOutOfBoundsException
```
    Gets the character at index as new String.
    Examples:
    StringUtils.charAt("XDEV", 0) returns "X" StringUtils.charAt("Bar", 2) returns "r" StringUtils.charAt("Hello XDEV3", 6) returns "X"
    Parameters:
    
    str - the String to get the character from.
    
    index - the position of the character. 0 <= index < length of str. The first character has index 0.
    
    Returns:
    
    the character at the specified index of str. The first char value is at index 0.
    
    Throws:
    
    NullPointerException - if str is null
    
    IndexOutOfBoundsException - if the index argument is negative or not less than the length of str.
  - contains
```
public static boolean contains(String str,
                               String search)
                        throws NullPointerException
```
    Returns true if and only if String str contains the specified String search. This method is case sensitive.
    Examples:
    StringUtils.contains("Hello XDEV3", "beta") returns false StringUtils.contains("Hello XDEV3", "Xdev3") returns false StringUtils.contains("Hello XDEV3", "XDEV3") returns true
    Parameters:
    
    str - the String to search in
    
    search - the String to search for
    
    Returns:
    
    true if String str contains search, false otherwise
    
    Throws:
    
    NullPointerException - if str is null
    
    NullPointerException - if search is null
  - substr
```
public static String substr(String str,
                            int start,
                            int length)
                     throws NullPointerException,
                            IndexOutOfBoundsException
```
    Returns a new string that is a substring of str. The substring begins with the character at the specified index start and contains the following number of characters specified by length.
    Examples:
    StringUtils.substr("New York",4,4) returns "York" StringUtils.substr("New York",0,3) returns "New"
    Parameters:
    
    str - the String to operate on
    
    start - the beginning index, inclusive.
    
    length - the length of the substring
    
    Returns:
    
    the specified substring.
    
    Throws:
    
    NullPointerException - if str is null
    
    IndexOutOfBoundsException - if start is negative or greater than the length of str. If length is negative or greater than the length of str - start.
  - replaceAll
```
public static String replaceAll(String source,
                                String search,
                                String replacement)
                         throws NullPointerException
```
    Replaces each substring of the given String source that matches the given String search with the given String replacement.
    Hint: The String source remains unchanged. All operations take place on a newly created String that is returned by this method.
    
    Examples:
    StringUtils.replaceAll("This is a String","is","at") returns "That at a String" StringUtils.replaceAll("In Betatest","In","For") returns "For Betatest"
    Parameters:
    
    source - String to search in
    
    search - String to search for
    
    replacement - String to replace the String search with
    
    Returns:
    
    the result of the replace operation
    
    Throws:
    
    NullPointerException - if source, search or replacement are null.
  - explode
```
public static XdevList<String> explode(String str,
                                       String separator)
```
    Splits a the String str at every separator String separator.
    Examples:
    XdevList<String> expected = new XdevList<String>(); expected.add("Hello"); expected.add("XDEV3"); XdevList<String> actual = StringUtils.explode("Hello,XDEV3",","); Assert.assertEquals(expected,actual);
    This method is a alias for StringUtils.explode(str, separator, false)
    Parameters:
    
    str - the String to be split
    
    separator - the separator
    
    Returns:
    
    XdevList containing all parts of the given String str split at every separator String separator.
    
    See Also:
    
    explode(String, String, boolean)
  - explode
```
public static XdevList<String> explode(String str,
                                       String separator,
                                       boolean returnDelimiters)
                                throws NullPointerException
```
    Splits a the String str at every separator String separator.
    Examples:
    StringUtils.explode("XDEV IDE based on java", " ", true) returns a list with 9 elements StringUtils.explode("XDEV IDE based on java", " ", false) returns a list with 5 elements XdevList expected = new XdevList(); expected.add("Hello"); expected.add("world"); expected.add("and"); expected.add("space"); XdevList actual = StringUtils.explode("Hello,world,and,space", ",",false);
    Parameters:
    
    str - the String to be split
    
    separator - the separator
    
    returnDelimiters - if true the separator is returned as independent element in the list; otherwise it is not.
    
    Returns:
    
    XdevList containing all parts of the given String str split at every separator String separator.
    
    Throws:
    
    NullPointerException - if eighter str or separator is null
    
    See Also:
    
    explode(String, String), concat(String, Collection), concat(String, Object...)
  - implode
```
@Deprecated
public static String implode(Collection<?> list,
                                         String separator)
                                  throws NullPointerException
```
    Deprecated. replaced by concat(String, Collection)
    
    Throws:
    
    NullPointerException
  - create
```
public static String create(String source,
                            int count)
                     throws NullPointerException,
                            IllegalArgumentException
```
    Creates a new String with the value of n (provided count) times the provided String str.
    Examples:
    StringUtils.create("Hello!",3); returns "Hello!Hello!Hello!" StringUtils.create("XDEV!",2); returns "XDEV!XDEV!" StringUtils.create("XDEV!XDEV2!XDEV3",1); returns "XDEV!XDEV2!XDEV3" *
    Parameters:
    
    source - String to use as source for the new String
    
    count - how many times should the provided String be repeated. Count is valid for >= 0.
    
    Returns:
    
    a new String with the value of n (provided count) times the provided String str.
    
    Throws:
    
    NullPointerException - if source is null
    
    IllegalArgumentException - if count is not valid (<0)
  - getUnicodeString
```
public static String getUnicodeString(int number)
```
    Returns the unicode character for the provided number.
    Examples:
    StringUtils.getUnicodeString(65) returns "A" StringUtils.getUnicodeString(75) returns "K"
    Parameters:
    
    number - of the unicode character
    
    Returns:
    
    the unicode character for the provided number.
  - getUnicodeNr
```
public static int getUnicodeNr(String str)
                        throws IllegalArgumentException
```
    Returns the unicode number for the prodvied String str.
    Examples:
    StringUtils.getUnicodeNr("A") returns 65 StringUtils.getUnicodeNr("H") returns 72
    Parameters:
    
    str - String to get the unicode number for. Str must have length = 1.
    
    Returns:
    
    the unicode number for the prodvied String str.
    
    Throws:
    
    IllegalArgumentException - if String has length != 1
  - getUnicodeNr
```
public static int getUnicodeNr(char ch)
```
    Returns the unicode number for the prodvied ch.
    Examples:
    StringUtils.getUnicodeNr('A') returns 65 StringUtils.getUnicodeNr('F') returns 70
    Parameters:
    
    ch - to get the unicode number for.
    
    Returns:
    
    the unicode number for the prodvied ch.
  - concat
```
public static String concat(String separator,
                            Collection<?> values)
                     throws NullPointerException
```
    Returns a String representation of all elements of the provided Collection values separated by the specified separator.
    Examples:
    StringUtils.concat(", ", new XdevList<String>("Miami","Atalanta","Vegas","LA")); returns "Miami, Atalanta, Vegas, LA" StringUtils.concat("-", new XdevList("Rom","Munich","Berlin","Madrid")) returns "Rom-Munich-Berlin-Madrid"
    Parameters:
    
    separator - String to separated the list elements.
    
    values - the Collection to concat
    
    Returns:
    
    a String representation of all elements of the provided Collection values separated by the specified separator.
    
    Throws:
    
    NullPointerException - if values or separator is null
    
    See Also:
    
    concat(String, Object...), explode(String, String), explode(String, String, boolean)
  - concat
```
public static String concat(String separator,
                            Object... values)
                     throws NullPointerException
```
    Returns a String representation of all elements of the provided values separated by the specified separator.
    Examples:
    StringUtils.concat(", ", new XdevList<String>("Miami","Atalanta","Vegas","LA")); returns "Miami, Atalanta, Vegas, LA" StringUtils.concat(".", new XdevList("Wien","Graz","Frankfurt","Dublin")); returns "Wien.Graz.Frankfurt.Dublin"
    Parameters:
    
    separator - String to separated the list elements.
    
    values - the values to concat
    
    Returns:
    
    a String representation of all elements of the provided values separated by the specified separator.
    
    Throws:
    
    NullPointerException - if values or separator is null
    
    See Also:
    
    concat(String, Collection), explode(String, String), explode(String, String, boolean)
  - format
```
public static String format(String str,
                            Map<String,String> params)
```
    Formats the String str by replacing the variables with values provided by params.
    For more information see format(String, ParameterProvider)
    
    Parameters:
    
    str - the String to format
    
    params - the parameter Map
    
    Returns:
    
    a formatted String
  - format
```
public static String format(String str,
                            StringUtils.ParameterProvider parameterProvider)
```
    Formats the String str by replacing the variables with values provided by parameterProvider.
    Variables have the format {$variableName}.
```
 Given: parameter provider (name -> Peter, color -> blue)
 Result of format("{$name} loves the color {$color}.",provider) is "Peter loves the color blue".
 
```
    Parameters:
    
    str - the String to format
    
    parameterProvider - the StringUtils.ParameterProvider
    
    Returns:
    
    a formatted String

Class StringUtils

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEWLINE

LINEFEED

TAB

Method Detail

charAt

contains

substr

replaceAll

explode

explode

implode

create

getUnicodeString

getUnicodeNr

getUnicodeNr

concat

concat

format

format