JStringUtils (ca.jeb:common-java 2014.10.01 API)

java.lang.Object
- ca.jeb.common.infra.JStringUtils

public final class JStringUtils
extends Object

Common String Util methods.

Author:: Erick Bourgeois

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BACKSLASH`
`static String`	`COMMA`
`static String`	`EMPTY` Shortcut EMPTY for our projects.
`static String`	`FORWARD_SLASH`
`static String`	`GET`
`static String`	`HYPHEN`
`static String`	`IS`
`static String`	`NEW_LINE`
`static String`	`PERCENT`
`static String`	`PERIOD`
`static String`	`PLUS`
`static String`	`QUESTION_MARK`
`static String`	`SHORT_NO`
`static String`	`SHORT_YES`
`static String`	`TAB`
`static String`	`UNDERSCORE`
`static Charset`	`UTF8_CHARSET`
`static String`	`WILD_CARD`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`compare(String str1, String str2)` This compares two strings with both possible null values.
`static String`	`convertInputStreamToString(InputStream is, String charset)` To convert the InputStream to String we use the BufferedReader.readLine() method.
`static String`	`decode(byte[] bytes, Charset charset)` Decode an array of bytes as UTF8.
`static byte[]`	`encode(String string, Charset charset)`
`static String`	`getNonNullValue(String string)` This returns an empty string if null is passed, returns the original string otherwise.
`static boolean`	`hasDigit(String str)` Returns true if this string contains digits, false otherwise.
`static boolean`	`hasValue(String string)` Returns true if the string has any kind of value.
`static boolean`	`isNullOrEmpty(String string)` Returns true if the provided string is null or empty.
`static String`	`join(Collection<?> collection, String separator)` Join a collection or list of elements, using the separator provided.
`static String`	`ltrim(String source)` Remove spaces from the beginning.
`static String`	`pad(String rawString, int length, char padChar)` Pad string with a character at end of text.
`static String`	`rtrim(String source)` Remove trailing whitespace.
`static String`	`safeTrim(String str)` This method will trim all non-null strings, if the supplied string is null, then return `EMPTY`.
`static List<String>`	`split(String str, String separatorChars)` Split a string into a `List` of Strings, given the String of "seperator" characters.
`static String`	`upperCaseFirst(String str)` Upper case the first character of the supplied string.

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

- Field Detail
  - EMPTY
```
public static final String EMPTY
```
    Shortcut EMPTY for our projects.
    
    See Also:
    
    Constant Field Values
  - WILD_CARD
```
public static final String WILD_CARD
```
    See Also:
    
    Constant Field Values
  - UNDERSCORE
```
public static final String UNDERSCORE
```
    See Also:
    
    Constant Field Values
  - HYPHEN
```
public static final String HYPHEN
```
    See Also:
    
    Constant Field Values
  - BACKSLASH
```
public static final String BACKSLASH
```
    See Also:
    
    Constant Field Values
  - QUESTION_MARK
```
public static final String QUESTION_MARK
```
    See Also:
    
    Constant Field Values
  - NEW_LINE
```
public static final String NEW_LINE
```
    See Also:
    
    Constant Field Values
  - TAB
```
public static final String TAB
```
    See Also:
    
    Constant Field Values
  - SHORT_NO
```
public static final String SHORT_NO
```
    See Also:
    
    Constant Field Values
  - SHORT_YES
```
public static final String SHORT_YES
```
    See Also:
    
    Constant Field Values
  - PERCENT
```
public static final String PERCENT
```
    See Also:
    
    Constant Field Values
  - FORWARD_SLASH
```
public static final String FORWARD_SLASH
```
    See Also:
    
    Constant Field Values
  - PLUS
```
public static final String PLUS
```
    See Also:
    
    Constant Field Values
  - COMMA
```
public static final String COMMA
```
    See Also:
    
    Constant Field Values
  - PERIOD
```
public static final String PERIOD
```
    See Also:
    
    Constant Field Values
  - GET
```
public static final String GET
```
    See Also:
    
    Constant Field Values
  - IS
```
public static final String IS
```
    See Also:
    
    Constant Field Values
  - UTF8_CHARSET
```
public static final Charset UTF8_CHARSET
```
- Method Detail
  - safeTrim
```
public static String safeTrim(String str)
```
    This method will trim all non-null strings, if the supplied string is null, then return EMPTY.
    
    Parameters:
    
    str - - the string to trim
    
    Returns:
    
    String
  - ltrim
```
public static String ltrim(String source)
```
    Remove spaces from the beginning.
    
    Parameters:
    
    source -
    
    Returns:
    
    the trimmed String
  - rtrim
```
public static String rtrim(String source)
```
    Remove trailing whitespace.
    
    Parameters:
    
    source -
    
    Returns:
    
    the trimmed String
  - hasDigit
```
public static boolean hasDigit(String str)
```
    Returns true if this string contains digits, false otherwise.
    
    Parameters:
    
    str -
    
    Returns:
    
    hasDigit Boolean
  - pad
```
public static String pad(String rawString,
                         int length,
                         char padChar)
```
    Pad string with a character at end of text.
    
    Parameters:
    
    rawString -
    
    length - - total length of the desired string
    
    padChar - - character to pad at the end of the text.
    
    Returns:
    
    the padded String
  - convertInputStreamToString
```
public static String convertInputStreamToString(InputStream is,
                                                String charset)
                                         throws IOException
```
    To convert the InputStream to String we use the BufferedReader.readLine() method. We iterate until the BufferedReader return null which means there's no more data to read. Each line will appended to a StringBuilder and returned as String.
    
    Parameters:
    
    is - - InputStream
    
    charset - - String, the character set
    
    Returns:
    
    String
    
    Throws:
    
    IOException
  - upperCaseFirst
```
public static String upperCaseFirst(String str)
```
    Upper case the first character of the supplied string.
    
    Parameters:
    
    str - - String
    
    Returns:
    
    String
  - join
```
public static String join(Collection<?> collection,
                          String separator)
```
    Join a collection or list of elements, using the separator provided. For example, this could be used to join a list of strings by a comma, i.e. ",".
    
    Parameters:
    
    collection - - Collection>?<
    
    separator - - String
    
    Returns:
    
    String - The joined string
  - split
```
public static List<String> split(String str,
                                 String separatorChars)
```
    Split a string into a List of Strings, given the String of "seperator" characters.
    
    Parameters:
    
    str -
    
    separatorChars -
    
    Returns:
    
    the split String as a List
  - decode
```
public static String decode(byte[] bytes,
                            Charset charset)
```
    Decode an array of bytes as UTF8.
    
    Parameters:
    
    bytes - - byte[]
    
    Returns:
    
    String
  - encode
```
public static byte[] encode(String string,
                            Charset charset)
```
    Parameters:
    
    string -
    
    charset -
    
    Returns:
    
    the encoded string as a byte array
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(@Nullable
                                    String string)
```
    Returns true if the provided string is null or empty.
    
    Parameters:
    
    string -
    
    Returns:
    
    isNullOrEmpty boolean
  - hasValue
```
public static boolean hasValue(String string)
```
    Returns true if the string has any kind of value.
    
    Parameters:
    
    string -
    
    Returns:
    
    hasValue boolean
  - compare
```
public static boolean compare(@Nullable
                              String str1,
                              @Nullable
                              String str2)
```
    This compares two strings with both possible null values.
    
    Parameters:
    
    str1 -
    
    str2 -
    
    Returns:
  - getNonNullValue
```
public static String getNonNullValue(String string)
```
    This returns an empty string if null is passed, returns the original string otherwise.
    
    Parameters:
    
    string -
    
    Returns:
    
    getNonNullValue string

Class JStringUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

WILD_CARD

UNDERSCORE

HYPHEN

BACKSLASH

QUESTION_MARK

NEW_LINE

TAB

SHORT_NO

SHORT_YES

PERCENT

FORWARD_SLASH

PLUS

COMMA

PERIOD

GET

IS

UTF8_CHARSET

Method Detail

safeTrim

ltrim

rtrim

hasDigit

pad

convertInputStreamToString

upperCaseFirst

join

split

decode

encode

isNullOrEmpty

hasValue

compare

getNonNullValue