Strings (SIRIUS kernel 12.0-rc9 API)

java.lang.Object
- sirius.kernel.commons.Strings

```
public class Strings
extends Object
```
Provides various helper methods for dealing with Java Strings
The Value class provides some additional methods for working with nullable strings like Value.left(int), Value.toLowerCase() etc.
This class can and should not be instantiated, as all methods are static.

See Also:

Value

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`apply(String format, Object... arguments)` Formats the given pattern string `format` with the given `arguments`.
`static boolean`	`areEqual(Object left, Object right)` Compares the given `Strings` just like `String.compareTo(String)` but with graceful handling for `null` values.
`static boolean`	`equalIgnoreCase(String left, String right)` Compares the given `Strings` while treating upper- and lowercase characters as equal.
`static String`	`firstFilled(String... values)` Returns the first non empty value of the given array.
`static String`	`generateCode(int length)` Generates a string of the given length, containing random character.
`static String`	`generatePassword()` Generates a random password with 7 characters length.
`static boolean`	`isEmpty(Object string)` Checks if the string representation of the given object is "" or `null`.
`static boolean`	`isFilled(Object string)` Checks if the string representation of the given object is neither "" nor `null`.
`static String`	`join(Iterable<?> list, String separator)` Returns a string concatenation of the given lists items.
`static String`	`join(Map<?,?> source)` Returns a string representation of the given map.
`static String`	`join(String separator, String... parts)`
`static String`	`leftPad(String input, String padding, int minLength)` Pads the given string on the left side to the given length using the given padding.
`static String`	`limit(Object input, int length)` Limits the length of the given string to the given length.
`static String`	`limit(Object input, int length, boolean showEllipsis)` Limits the length of the given string to the given length.
`static String`	`reduceCharacters(String term)` Removes all umlauts and other decorated latin characters.
`static String`	`replaceAll(Pattern regEx, String input, Function<String,String> replacement)` Replaces all occurrences of the given regular expression by the result of the given replacement function.
`static String`	`replaceUmlautsToHtml(String input)` Replaces german umlauts to HTML entities as some email clients fail otherwise.
`static String`	`rightPad(String input, String padding, int minLength)` Pads the given string on the right side to the given length using the given padding.
`static String`	`shorten(String string, int numChars)` shortens a string to the given number of chars, cutting of at most half of the string and adding ... if something has been cut of.
`static Tuple<String,String>`	`split(String input, String separator)` Splits the given string at the first occurrence of the separator.
`static Tuple<String,String>`	`splitAtLast(String input, String separator)` Splits the given string at the last occurrence of the separator.
`static String`	`toString(Object object)` Returns a string representation of the given object while gracefully handling `null` values.
`static String`	`trim(Object object)` Returns a trimmed version of the given object's string representation.
`static String`	`urlEncode(String value)` Returns an url encoded representation of the given `value` with `UTF-8` as character encoding.

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

- Method Detail
  - isEmpty
```
public static boolean isEmpty(@Nullable
                              Object string)
```
    Checks if the string representation of the given object is "" or null.
    
    Parameters:
    
    string - the object which is to be checked
    
    Returns:
    
    true if string is null or "", false otherwise
  - isFilled
```
public static boolean isFilled(@Nullable
                               Object string)
```
    Checks if the string representation of the given object is neither "" nor null.
    
    Parameters:
    
    string - the object which is to be checked
    
    Returns:
    
    true if string is not null and not "", false otherwise
  - equalIgnoreCase
```
public static boolean equalIgnoreCase(@Nullable
                                      String left,
                                      @Nullable
                                      String right)
```
    Compares the given Strings while treating upper- and lowercase characters as equal.
    This is essentially the same as left.equalsIgnoreCase(right) while gracefully handling null values.
    
    Parameters:
    
    left - the first string to be compared
    
    right - the second string to be compared with
    
    Returns:
    
    true if both values are empty or if both strings are equal while ignoring their case - false otherwise
  - areEqual
```
public static boolean areEqual(@Nullable
                               Object left,
                               @Nullable
                               Object right)
```
    Compares the given Strings just like String.compareTo(String) but with graceful handling for null values.
    
    Parameters:
    
    left - the first string to be compared
    
    right - the second string to be compared with
    
    Returns:
    
    true if both values are empty or if both strings are equal - false otherwise
  - toString
```
@Nullable
public static String toString(@Nullable
                                        Object object)
```
    Returns a string representation of the given object while gracefully handling null values.
    Internally this method calls Object.toString(). For locale aware or locale fixed methods, NLS.toUserString(Object) and NLS.toMachineString(Object) can be used.
    
    Parameters:
    
    object - the object to be converted to string.
    
    Returns:
    
    the string representation of the given object or null if object was null.
  - apply
```
public static String apply(String format,
                           Object... arguments)
```
    Formats the given pattern string format with the given arguments.
    This is just a delegate to String.format(String, Object...). It is however defined in this class to forces all framework parts to use the same formatting mechanism (and not MessageFormat etc.).
    This method is intended to be used for format short strings or non-translated log messages etc. For more complex messages and especially for translated strings, a Formatter should be used.
    
    Parameters:
    
    format - the format pattern to be used
    
    arguments - the parameters for be used for replacement
    
    Returns:
    
    a formatted string as defined in String#format
    
    See Also:
    
    String.format(String, Object...), Formatter, NLS.fmtr(String)
  - firstFilled
```
public static String firstFilled(String... values)
```
    Returns the first non empty value of the given array.
    This can be used to provide a default value or to check several sources for a value, e.g.:
```
 
         String s = Strings.firstFilled(System.getProperty("foo.test"),
                                        System.getProperty("test"),
                                        "default");
 
 
```
    Parameters:
    
    values - an array of string values to be scanned
    
    Returns:
    
    the first value of values which is filled. Returns null if all are empty or if no values where passed in
  - urlEncode
```
public static String urlEncode(@Nullable
                               String value)
```
    Returns an url encoded representation of the given value with UTF-8 as character encoding.
    
    Parameters:
    
    value - the value to be encoded.
    
    Returns:
    
    an url encoded representation of value, using UTF-8 as character encoding.
  - split
```
public static Tuple<String,String> split(String input,
                                         String separator)
```
    Splits the given string at the first occurrence of the separator.
    If the given input is empty, a tuple with null as first and second component will be returned.
    
    Parameters:
    
    input - the input to be split
    
    separator - the separator used to split at
    
    Returns:
    
    a Tuple containing the part before the separator as first and the part after the separator as second component
  - splitAtLast
```
public static Tuple<String,String> splitAtLast(String input,
                                               String separator)
```
    Splits the given string at the last occurrence of the separator.
    If the given input is empty, a tuple with null as first and second component will be returned.
    
    Parameters:
    
    input - the input to be split
    
    separator - the separator used to split at
    
    Returns:
    
    a Tuple containing the part before the separator as first and the part after the separator as second component
  - limit
```
public static String limit(@Nullable
                           Object input,
                           int length)
```
    Limits the length of the given string to the given length.
    
    Parameters:
    
    input - the object which string representation should be limited to the given length
    
    length - the max. number of characters to return
    
    Returns:
    
    a part of the string representation of the given input. If input is shorter than length, the full value is returned. If input is null, "" is returned.
  - limit
```
public static String limit(@Nullable
                           Object input,
                           int length,
                           boolean showEllipsis)
```
    Limits the length of the given string to the given length.
    
    Parameters:
    
    input - the object which string representation should be limited to the given length
    
    length - the max. number of characters to return
    
    showEllipsis - whether to append three dots if input is longer than length
    
    Returns:
    
    a part of the string representation of the given input. If input is shorter than length, the full value is returned. If input is null, "" is returned.
  - join
```
@Nonnull
public static String join(@Nullable
                                   Map<?,?> source)
```
    Returns a string representation of the given map.
    Keys and values are separated by a colon (:) and entries by a new line.
    
    Parameters:
    
    source - to map to be converted to a string
    
    Returns:
    
    a string representation of the given map, or "" if the map was null
  - join
```
@Nonnull
public static String join(@Nullable
                                   Iterable<?> list,
                                   @Nonnull
                                   String separator)
```
    Returns a string concatenation of the given lists items.
    Generates a string which contains the string representation of each item separated by the given separator. The conversion method for the list items used is NLS.toMachineString(Object). This method will filter empty values ("" or null) and ignore those.
    
    Parameters:
    
    list - the list items to join
    
    separator - the separator to place between the items
    
    Returns:
    
    a string of all items joined together and separated by the given separator. Returns "" is the list was null or empty.
  - join
```
@Nonnull
public static String join(@Nonnull
                                   String separator,
                                   @Nonnull
                                   String... parts)
```
  - generatePassword
```
public static String generatePassword()
```
    Generates a random password with 7 characters length.
    
    Returns:
    
    a randomly generated password.
  - generateCode
```
public static String generateCode(int length)
```
    Generates a string of the given length, containing random character.
    
    Parameters:
    
    length - the desired length of the generated string.
    
    Returns:
    
    a string with the given length, consisting of random characters.
  - replaceUmlautsToHtml
```
public static String replaceUmlautsToHtml(String input)
```
    Replaces german umlauts to HTML entities as some email clients fail otherwise. Using UTF-8 as encoding this shouldn't normally be necessary and is just there to support legacy software.
    
    Parameters:
    
    input - the input to escape
    
    Returns:
    
    a string where all known (supported) umlauts are replaced by HTML entities
  - reduceCharacters
```
public static String reduceCharacters(String term)
```
    Removes all umlauts and other decorated latin characters.
    
    Parameters:
    
    term - the term to reduce characters in
    
    Returns:
    
    the term with all decorated latin characters replaced
  - trim
```
public static String trim(Object object)
```
    Returns a trimmed version of the given object's string representation. And empty string '' will always be null.
    
    Parameters:
    
    object - the input to be converted into a string and then trimmed
    
    Returns:
    
    a trimmed version of the string representation of the given object. Returns null if an empty string was given.
  - shorten
```
public static String shorten(String string,
                             int numChars)
```
    shortens a string to the given number of chars, cutting of at most half of the string and adding ... if something has been cut of.
    
    Parameters:
    
    string - string to be cut of
    
    numChars - new maximum length of string
    
    Returns:
    
    the shortened string
  - replaceAll
```
public static String replaceAll(Pattern regEx,
                                String input,
                                Function<String,String> replacement)
```
    Replaces all occurrences of the given regular expression by the result of the given replacement function.
    The regular expression is expected to have one explicit matching group which will be used as input for the replacement function.
    To replace all occurrences of #{X} by NLS.get("X") one could use: Strings.replaceAll(Pattern.compile("#\\{([^\\}]+)\\"), someText, NLS::get)}
    
    Parameters:
    
    regEx - the regular expression to replace in the given input
    
    input - the input to scan
    
    replacement - the replacement function which transforms the first group of the match into the string used as replacement for the whole match.
    
    Returns:
    
    the input string where are occurrences of the given regular expression have been replaced by the result of the replacement function.
  - leftPad
```
public static String leftPad(String input,
                             String padding,
                             int minLength)
```
    Pads the given string on the left side to the given length using the given padding.
    Note that if padding consists of several characters, the final string might be longer than minLength as no substring but only the full value of padding is used to pad. Implementation detail: This method checks if padding is necessary at all. If not, it directly returns the given input. This should enable inlining and therefore create a fast path if no padding is necessary.
    
    Parameters:
    
    input - the input to pad
    
    padding - the padding to use
    
    minLength - the minimal length to reach
    
    Returns:
    
    a string which is at least minLength characters long
  - rightPad
```
public static String rightPad(String input,
                              String padding,
                              int minLength)
```
    Pads the given string on the right side to the given length using the given padding.
    Note that if padding consists of several characters, the final string might be longer than minLength as no substring but only the full value of padding is used to pad. Implementation detail: This method checks if padding is necessary at all. If not, it directly returns the given input. This should enable inlining and therefore create a fast path if no padding is necessary.
    
    Parameters:
    
    input - the input to pad
    
    padding - the padding to use
    
    minLength - the minimal length to reach
    
    Returns:
    
    a string which is at least minLength characters long

Class Strings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isEmpty

isFilled

equalIgnoreCase

areEqual

toString

apply

firstFilled

urlEncode

split

splitAtLast

limit

limit

join

join

join

generatePassword

generateCode

replaceUmlautsToHtml

reduceCharacters

trim

shorten

replaceAll

leftPad

rightPad