StringUtils (Spikeify Taskqueue 0.1.2 API)

java.lang.Object
- com.spikeify.taskqueue.utils.StringUtils

public final class StringUtils
extends Object

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static List<String>`	`asListOfChars(String value)`
`static int`	`compare(String one, String two)` Compares two strings with `String.compare()`.
`static boolean`	`equals(String original, String compare)` compares two strings if equal (`String.equals` method)
`static boolean`	`equals(String original, String compare, boolean ignoreCase)` compares two strings if equal (`String.equals` or `String.equalsIgnoreCase` method)
`static List<String>`	`getWords(String text)` Extracts words from text removing non alpha characters
`static boolean`	`isNullOrEmpty(String value)` Checks if string is `null` or `empty == ""`
`static boolean`	`isNullOrEmptyTrimmed(String value)` Checks if string is null, empty or contains only spaces
`static boolean`	`isWord(String word)` Checks if given string is a single word (doesn't accepts words with "-" as a single word!)
`static String`	`join(HashMap<String,String> params, String separator)`
`static String`	`join(List<?> list, String separator)` Joins list of string items to a single string, where items are separated with a defined separator.
`static String`	`join(Object[] args, String separator)` Joins list of string items to a single string, where items are separated with a defined separator.
`static String`	`join(Set<String> items, String separator)` Joins list of string items to a single string, where items are separated with a defined separator.
`static String`	`toStringOrNull(Object value)`
`static String`	`trim(String value)` null resilient trim
`static String`	`trimAll(String text, String toBeTrimmed)`
`static String`	`trimDoubleSpaces(String value)` Additionally to outer `trim()` double spaces are removed.
`static String`	`trimEnd(String text)` Trims only end of text
`static String`	`trimInner(String value)` Additionally to outer `trim()` all inner spaces are removed.
`static String`	`trimStart(String text)`
`static String`	`trimTextDown(String text, int size)` Reduces text to max given size preserving words
`static String`	`trimToNull(String text)` Trims down text to null if empty

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

- Method Detail
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(String value)
```
    Checks if string is null or empty == ""
    
    Parameters:
    
    value - string to test
    
    Returns:
    
    true if null or empty, false otherwise.
  - isNullOrEmptyTrimmed
```
public static boolean isNullOrEmptyTrimmed(String value)
```
    Checks if string is null, empty or contains only spaces
    
    Parameters:
    
    value - string to test
    
    Returns:
    
    true if null, empty or spaces only, false otherwise.
  - equals
```
public static boolean equals(String original,
                             String compare)
```
    compares two strings if equal (String.equals method)
    
    Parameters:
    
    original - string to compare against
    
    compare - string to compare to
    
    Returns:
    
    true if equal or both null, false otherwise
  - equals
```
public static boolean equals(String original,
                             String compare,
                             boolean ignoreCase)
```
    compares two strings if equal (String.equals or String.equalsIgnoreCase method)
    
    Parameters:
    
    original - string to compare against
    
    compare - string to compare to
    
    ignoreCase - true equalsIgnoreCase is used, false equals is used
    
    Returns:
    
    true if equal or both null, false otherwise
  - compare
```
public static int compare(String one,
                          String two)
```
    Compares two strings with String.compare(). Method allows null values.
    
    Parameters:
    
    one - to compare
    
    two - to compare
    
    Returns:
    
    0 if both null, -1 if one is null, 1 if two is null, otherwise String.compare() is called
  - trim
```
public static String trim(String value)
```
    null resilient trim
    
    Parameters:
    
    value - trims value or returns null if null
    
    Returns:
    
    null or trimmed value (empty string is left empty)
  - trimDoubleSpaces
```
public static String trimDoubleSpaces(String value)
```
    Additionally to outer trim() double spaces are removed.
    
    Parameters:
    
    value - to remove double spaces from
    
    Returns:
    
    value with single spaces if any
  - trimInner
```
public static String trimInner(String value)
```
    Additionally to outer trim() all inner spaces are removed.
    
    Parameters:
    
    value - to remove inner spaces from
    
    Returns:
    
    value with single spaces if any
  - trimEnd
```
public static String trimEnd(String text)
```
    Trims only end of text
    
    Parameters:
    
    text - to be trimmed at the end
    
    Returns:
    
    trimmed text or original if no changes were applied
  - trimStart
```
public static String trimStart(String text)
```
  - trimAll
```
public static String trimAll(String text,
                             String toBeTrimmed)
```
  - trimToNull
```
public static String trimToNull(String text)
```
    Trims down text to null if empty
    
    Parameters:
    
    text - to be trimmed
    
    Returns:
    
    text or null if empty
  - join
```
public static String join(List<?> list,
                          String separator)
```
    Joins list of string items to a single string, where items are separated with a defined separator.
    
    Parameters:
    
    list - to join into string
    
    separator - to be used between elements
    
    Returns:
    
    items joined into a single string
  - join
```
public static String join(Object[] args,
                          String separator)
```
    Joins list of string items to a single string, where items are separated with a defined separator.
    
    Parameters:
    
    args - to join into string
    
    separator - to be used between elements
    
    Returns:
    
    items joined into a single string
  - join
```
public static String join(Set<String> items,
                          String separator)
```
    Joins list of string items to a single string, where items are separated with a defined separator.
    
    Parameters:
    
    items - to join into string
    
    separator - to be used between elements
    
    Returns:
    
    items joined into a single string
  - join
```
public static String join(HashMap<String,String> params,
                          String separator)
```
  - getWords
```
public static List<String> getWords(String text)
```
    Extracts words from text removing non alpha characters
    
    Parameters:
    
    text - to extract words from
    
    Returns:
    
    list of found words or empty list if none found
  - trimTextDown
```
public static String trimTextDown(String text,
                                  int size)
```
    Reduces text to max given size preserving words
    
    Parameters:
    
    text - to trim down
    
    size - max desired size
    
    Returns:
    
    trimmed down text with "..." or original text if fitting size
  - toStringOrNull
```
public static String toStringOrNull(Object value)
```
  - asListOfChars
```
public static List<String> asListOfChars(String value)
```
  - isWord
```
public static boolean isWord(String word)
```
    Checks if given string is a single word (doesn't accepts words with "-" as a single word!)
    
    Parameters:
    
    word - to test
    
    Returns:
    
    true if word, false otherwise

Class StringUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isNullOrEmpty

isNullOrEmptyTrimmed

equals

equals

compare

trim

trimDoubleSpaces

trimInner

trimEnd

trimStart

trimAll

trimToNull

join

join

join

join

getWords

trimTextDown

toStringOrNull

asListOfChars

isWord