Strings (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.common.Strings

```
public final class Strings
extends Object
```
The helper class with String-related utilities.

Author:

vgr

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`capitalize(String name)` Returns a new string with the first character in upper case.
`static String`	`checkNotBlank(String string, String stringName)` Deprecated. use `Assert.checkNotBlank(String, String)`
`static String`	`emptyToNull(String string)` If the string is `empty`, returns `null`, otherwise returns the given string.
`static List<String>`	`getTokens(String css)` Returns a list of trimmed tokens from given token list.
`static boolean`	`isEmpty(String string)` Returns `true` if the `string` argument is `null` or it contains whitespace characters only, otherwise returns `false`.
`static boolean`	`isNotEmpty(String string)` Returns `false` if the `string` argument is `null` or it contains whitespace characters only, otherwise returns `true`.
`static String`	`join(Iterable<?> iterable, String separator)` Joins given list of items with given separator.
`static String`	`join(Object[] array, String separator)` Joins given list of items with given separator.
`static StringBuilder`	`join(StringBuilder builder, Iterable<?> iterable, String separator)` Joins given iterable of items with given separator.
`static StringBuilder`	`join(StringBuilder builder, Object[] array, String separator)` Joins given array of items with given separator.
`static String`	`limitLength(String str, int maxLength)` Limits the length of a string to a given length if the length of the string is greater then the maximal desired length.
`static String`	`ltrim(String s)` Returns the left-side trim of the given string.
`static String`	`nullToEmpty(String string)` If the given string is `null`, returns an empty string, otherwise returns the given string.
`static String`	`rtrim(String s)` Returns the right-side trim of the given string.
`static String`	`toNullAwareString(String string)` Returns given string with enclosing apostrophes (e.g. `'manager'`) if the string argument is not null, otherwise it returns `null` (string).

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

- Method Detail
  - checkNotBlank
```
@Deprecated
public static String checkNotBlank(String string,
                                               String stringName)
```
    Deprecated. use Assert.checkNotBlank(String, String)
    
    Returns given string if it is not "blank" (i.e. it is not null and does not contain just whitespace characters).
    
    Parameters:
    
    string - the string to check if it is not blank
    
    stringName - the name of the string variable that is checked (used for displaying in a thrown exception)
    
    Returns:
    
    given string if it is not blank
    
    Throws:
    
    NullPointerException - (unchecked) if the string argument is null
    
    IllegalArgumentException - (unchecked) if the string argument contains just whitespace characters
  - isEmpty
```
public static boolean isEmpty(String string)
```
    Returns true if the string argument is null or it contains whitespace characters only, otherwise returns false. This method is the complement of the isNotEmpty(String) method.
    
    Parameters:
    
    string - any String instance. Can be null
    
    Returns:
    
    true if the string argument is null or it contains whitespace characters only, otherwise false
  - isNotEmpty
```
public static boolean isNotEmpty(String string)
```
    Returns false if the string argument is null or it contains whitespace characters only, otherwise returns true. This method is the complement of the isEmpty(String) method.
    
    Parameters:
    
    string - any String instance. Can be null
    
    Returns:
    
    false if the string argument is null or it contains whitespace characters only, otherwise true
  - nullToEmpty
```
public static String nullToEmpty(String string)
```
    If the given string is null, returns an empty string, otherwise returns the given string.
    
    Parameters:
    
    string -
    
    Returns:
    
    a given string if it is non-null, or an empty string
  - emptyToNull
```
public static String emptyToNull(String string)
```
    If the string is empty, returns null, otherwise returns the given string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the given string or null
  - toNullAwareString
```
public static String toNullAwareString(String string)
```
    Returns given string with enclosing apostrophes (e.g. 'manager') if the string argument is not null, otherwise it returns null (string).
    
    Parameters:
    
    string - the string to be checked for null
    
    Returns:
    
    given string with enclosing apostrophes or the null (string) if the string argument is null
  - getTokens
```
public static List<String> getTokens(String css)
```
    Returns a list of trimmed tokens from given token list.
    
    Parameters:
    
    css - a comma-separated list of strings, may be null
    
    Returns:
    
    tokenized list, never null, may be empty.
  - join
```
public static String join(Object[] array,
                          String separator)
```
    Joins given list of items with given separator. No spaces are added - for example to join ["foo", "bar", "baz"] as "foo, bar, baz", just call join(["foo", "bar", "baz"], ", ") (note the space after comma.
    null items are represented as empty strings.
    
    Parameters:
    
    array - the items, not null. String.valueOf(Object) is used on the items to convert it to string.
    
    separator - the separator character to use
    
    Returns:
    
    the joined String, null if null array input
  - join
```
public static StringBuilder join(StringBuilder builder,
                                 Object[] array,
                                 String separator)
```
    Joins given array of items with given separator. null elements are represented by empty string.
    
    Parameters:
    
    builder - not null
    
    array - not null
    
    separator -
    
    Returns:
    
    the builder
  - join
```
public static String join(Iterable<?> iterable,
                          String separator)
```
    Joins given list of items with given separator. No spaces are added - for example to join ["foo", "bar", "baz"] as "foo, bar, baz", just call join(["foo", "bar", "baz"], ", ") (note the space after comma.
    null items are represented as empty strings.
    
    Parameters:
    
    iterable - the items, not null. String.valueOf(Object) is used on the items to convert it to string.
    
    separator - the separator character to use, not null.
    
    Returns:
    
    the joined String, null if null array input
  - join
```
public static StringBuilder join(StringBuilder builder,
                                 Iterable<?> iterable,
                                 String separator)
```
    Joins given iterable of items with given separator. null elements are represented by empty string.
    
    Parameters:
    
    builder - not null
    
    iterable - not null
    
    separator -
    
    Returns:
    
    the builder
  - limitLength
```
public static String limitLength(String str,
                                 int maxLength)
```
    Limits the length of a string to a given length if the length of the string is greater then the maximal desired length. Characters beyond the maximal desired length are cut off.
    
    Parameters:
    
    str - the string the length of which should be limited to the maximal length
    
    maxLength - the desired maximal length of the string
    
    Returns:
    
    the start of the given string with the maximal possible length limited only by the maxLength parameter. If the string is null then null is returned.
    
    Throws:
    
    IllegalArgumentException - if the maxLength is negative
  - ltrim
```
public static String ltrim(String s)
```
    Returns the left-side trim of the given string.
    
    Parameters:
    
    s -
    
    Returns:
    
    the left-side trim of the given string
  - rtrim
```
public static String rtrim(String s)
```
    Returns the right-side trim of the given string.
    
    Parameters:
    
    s -
    
    Returns:
    
    the right-side trim of the given string
  - capitalize
```
public static String capitalize(String name)
```
    Returns a new string with the first character in upper case.
    
    Parameters:
    
    name -
    
    Returns:
    
    name with first upper case first letter

Class Strings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkNotBlank

isEmpty

isNotEmpty

nullToEmpty

emptyToNull

toNullAwareString

getTokens

join

join

join

join

limitLength

ltrim

rtrim

capitalize