StringUtils (jaulp.lang 4.0.0 API)

java.lang.Object
- de.alpharogroup.string.StringUtils

```
public final class StringUtils
extends Object
```
Utility class for the use of String object.

Version:

1.0

Author:

Asterios Raptis

Constructor Summary

Constructors
Constructor and Description

StringUtils()

Constructors
Constructor and Description
`StringUtils()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`convertCharsToUnicodeChars(String s, boolean toLowerCase)` Deprecated. use instead `StringExtensions.toUnicodeChars(String, boolean)`
`static byte[]`	`convertToBytearray(char[] source)` Converts the given chararray to a bytearray.
`static char[]`	`convertToCharArray(byte[] source)` Convert the given byte array to char array.
`static Character`	`convertUnicodeStringToCharacter(String theUnicodeString)` Converts the given unicode String object to character object.
`static byte[]`	`decodeHex(char[] data)` Decode hex.
`static char[]`	`encodeHex(byte[] data)` Encode hex.
`static String`	`getAttributName(String name)` Gets the Attribut-name without brackets.
`static String`	`getIndex(String name)` Gets the first index from the brackets.
`static String`	`getItemNumber(String name)` Gets the ItemNumber from the String name.
`static String`	`getLastCharacter(String str)` Deprecated. use instead `StringExtensions.lastCharacter(String)`
`static String`	`getStringAfterUnderscore(String element)` The Method getStringAfterUnderscore(String) gets the substring after the first underscore.
`static String`	`getStringBeforeUnderscore(String element)` The Method getStringBeforeUnderscore(String) gets the substring before the first underscore.
`static String`	`getValue(Map<String,String> data, String key, String defaultValue)` Gets the value from the given map and if it does not exist or is empty the given default value will be returned.
`static boolean`	`isNullOrEmpty(String str)` Deprecated. use instead `StringExtensions.isNullOrEmpty(String)`
`static boolean`	`isNumber(String testString)` Deprecated. use instead `StringExtensions.isNumber(String)`
`static String`	`putQuotesToString(String s)` Deprecated. use instead `StringExtensions.addDoubleQuotationMarks(String)`
`static String`	`readLine(String stringWithCarriageReturns)` Reads the given String till it finds a carriage return and returns it.
`static String[]`	`removeEmptyString(String[] words)` Removes empty Strings from the given string array and gives it back.
`static String`	`removeNewlineCharacters(String subject)` Removes the newline characters from the given String.
`static String`	`removeQuotationMarks(String s)` Deprecated. use instead `StringExtensions.addDoubleQuotationMarks(String)`
`static String`	`replaceAll(String original, String[] findString, String replaceWith)` Replaces all occurrences of a String within another String.
`static String`	`replaceAll(String original, String findString, String replaceWith)` Replaces all occurrences of a String within another String.
`static String`	`replaceEach(String input, String searchRegexPattern, String replace)` Replace each occurences from the search pattern(regex) with the given replace String of the given input String.
`static String`	`setFirstCharacterToLowerCase(String fieldName)` Deprecated. use instead `StringExtensions.firstCharacterToLowerCase(String)`
`static String`	`setFirstCharacterToUpperCase(String fieldName)` Deprecated. use instead `StringExtensions.firstCharacterToUpperCase(String)`
`static char`	`toHex(int i)` To hex.
`static String`	`toUnicode(String toUnicode, boolean toLowerCase)` Converts all characters from the given String to unicodes characters encoded like \uxxxx.

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

- Constructor Detail
  - StringUtils
```
public StringUtils()
```
- Method Detail
  - convertCharsToUnicodeChars
```
@Deprecated
public static String convertCharsToUnicodeChars(String s,
                                                            boolean toLowerCase)
```
    Deprecated. use instead StringExtensions.toUnicodeChars(String, boolean)
    
    Converts all characters from the given String to unicodes characters encoded like \uxxxx. Note: empty characters and symbols are not converted. See test for examples.
    
    Parameters:
    
    s - The String to convert.
    
    toLowerCase - If true the letters from the unicode characters are lower case.
    
    Returns:
    
    The converted String.
  - convertToBytearray
```
public static final byte[] convertToBytearray(char[] source)
```
    Converts the given chararray to a bytearray.
    
    Parameters:
    
    source - the source.
    
    Returns:
    
    the byte[]
  - convertToCharArray
```
public static char[] convertToCharArray(byte[] source)
```
    Convert the given byte array to char array.
    
    Parameters:
    
    source - the source.
    
    Returns:
    
    the char[]
  - convertUnicodeStringToCharacter
```
public static Character convertUnicodeStringToCharacter(String theUnicodeString)
```
    Converts the given unicode String object to character object.
    Example: the given unicode String object is "\u03A9"
    the return character object would be "Ω".
    
    Parameters:
    
    theUnicodeString - the the unicode string
    
    Returns:
    
    the converted character object.
  - decodeHex
```
public static byte[] decodeHex(char[] data)
                        throws org.apache.commons.codec.DecoderException
```
    Decode hex.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the byte[]
    
    Throws:
    
    org.apache.commons.codec.DecoderException - the decoder exception
  - encodeHex
```
public static char[] encodeHex(byte[] data)
```
    Encode hex.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the char[]
  - getAttributName
```
public static final String getAttributName(String name)
```
    Gets the Attribut-name without brackets. For example: If "indio[5][1]" is the given String than the name is "indio" and the first index is "5" and the second is "1". Than the Method returns "indio".
    
    Parameters:
    
    name - The name with brackets.
    
    Returns:
    
    The name without brackets.
  - getIndex
```
public static final String getIndex(String name)
```
    Gets the first index from the brackets. For example: If "indio[5][1]" is the given String than the name is "indio" and the first index is "5" and the second is "1". Than the Method returns "5".
    
    Parameters:
    
    name - The name from the Attribute
    
    Returns:
    
    the index from the Attribute
  - getItemNumber
```
public static final String getItemNumber(String name)
```
    Gets the ItemNumber from the String name. For example: If "indio[5][1]" is the given String than the name is "indio" and the first index is "5" and the second is "1". Than the Method returns "1".
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the ItemNumber
  - getLastCharacter
```
@Deprecated
public static String getLastCharacter(String str)
```
    Deprecated. use instead StringExtensions.lastCharacter(String)
    
    Gets the last character of the given String object.
    
    Parameters:
    
    str - the str
    
    Returns:
    
    the last character
  - getStringAfterUnderscore
```
public static final String getStringAfterUnderscore(String element)
```
    The Method getStringAfterUnderscore(String) gets the substring after the first underscore. For example:Assume that element=foobar_value then the result string is "value".
    
    Parameters:
    
    element - The element to get the substing.
    
    Returns:
    
    The result String.
  - getStringBeforeUnderscore
```
public static final String getStringBeforeUnderscore(String element)
```
    The Method getStringBeforeUnderscore(String) gets the substring before the first underscore. For example:Assume that element=foobar_value then the result string is "foobar".
    
    Parameters:
    
    element - The element to get the substing.
    
    Returns:
    
    The result String.
  - getValue
```
public static String getValue(Map<String,String> data,
                              String key,
                              String defaultValue)
```
    Gets the value from the given map and if it does not exist or is empty the given default value will be returned.
    
    Parameters:
    
    data - the data
    
    key - the key
    
    defaultValue - the default value
    
    Returns:
    
    the value
  - isNullOrEmpty
```
@Deprecated
public static final boolean isNullOrEmpty(String str)
```
    Deprecated. use instead StringExtensions.isNullOrEmpty(String)
    
    The method isEmpty(String) checks if the given String is empty or null.
    
    Parameters:
    
    str - The String to check.
    
    Returns:
    
    true if the given String is empty or null otherwise false.
  - isNumber
```
@Deprecated
public static final boolean isNumber(String testString)
```
    Deprecated. use instead StringExtensions.isNumber(String)
    
    Checks if the given String is an Number.
    
    Parameters:
    
    testString - The String to check.
    
    Returns:
    
    true if the given String is a number otherwise false.
  - putQuotesToString
```
@Deprecated
public static final String putQuotesToString(String s)
```
    Deprecated. use instead StringExtensions.addDoubleQuotationMarks(String)
    
    Puts to the given String at the start and end quotes.
    
    Parameters:
    
    s - The String to handle.
    
    Returns:
    
    The String with quotes.
  - readLine
```
public static final String readLine(String stringWithCarriageReturns)
```
    Reads the given String till it finds a carriage return and returns it.
    
    Parameters:
    
    stringWithCarriageReturns - The String.
    
    Returns:
    
    Return the String till the carriage return.
  - removeEmptyString
```
public static String[] removeEmptyString(String[] words)
```
    Removes empty Strings from the given string array and gives it back. For instance if you use the String.split("\\W") method you get all the words from the given String as an string array. But this array contains empty Strings too. This method removes this empty strings from that array.
    
    Parameters:
    
    words - The string array to remove empty strings.
    
    Returns:
    
    An string array without empty Strings.
  - removeNewlineCharacters
```
public static String removeNewlineCharacters(String subject)
```
    Removes the newline characters from the given String.
    
    Parameters:
    
    subject - the subject
    
    Returns:
    
    the string
  - removeQuotationMarks
```
@Deprecated
public static final String removeQuotationMarks(String s)
```
    Deprecated. use instead StringExtensions.addDoubleQuotationMarks(String)
    
    Removes from the given String the first and the last character.
    
    Parameters:
    
    s - The String to handle.
    
    Returns:
    
    The String with the without the first and the last character.
  - replaceAll
```
public static final String replaceAll(String original,
                                      String findString,
                                      String replaceWith)
```
    Replaces all occurrences of a String within another String.
    
    Parameters:
    
    original - The String to search.
    
    findString - The search pattern.
    
    replaceWith - Replace with that String.
    
    Returns:
    
    Returns a new String with the replaced Strings.
  - replaceAll
```
public static final String replaceAll(String original,
                                      String[] findString,
                                      String replaceWith)
```
    Replaces all occurrences of a String within another String.
    
    Parameters:
    
    original - The String to search.
    
    findString - An array with search patterns.
    
    replaceWith - Replace with that String.
    
    Returns:
    
    Returns a new String with the replaced Strings.
  - replaceEach
```
public static String replaceEach(String input,
                                 String searchRegexPattern,
                                 String replace)
```
    Replace each occurences from the search pattern(regex) with the given replace String of the given input String.
    
    Parameters:
    
    input - the input String that will be changed.
    
    searchRegexPattern - the search regex pattern
    
    replace - the String to replace with.
    
    Returns:
    
    the resulted string
  - setFirstCharacterToLowerCase
```
@Deprecated
public static final String setFirstCharacterToLowerCase(String fieldName)
```
    Deprecated. use instead StringExtensions.firstCharacterToLowerCase(String)
    
    Sets the first character from the given string to lower case and returns it. Example:
    Given fieldName: UserName
    Result: userName
    
    Parameters:
    
    fieldName - The String to modify.
    
    Returns:
    
    The modified string.
  - setFirstCharacterToUpperCase
```
@Deprecated
public static final String setFirstCharacterToUpperCase(String fieldName)
```
    Deprecated. use instead StringExtensions.firstCharacterToUpperCase(String)
    
    Sets the first character from the given string to upper case and returns it. Example:
    Given fieldName: userName
    Result: UserName
    
    Parameters:
    
    fieldName - The String to modify.
    
    Returns:
    
    The modified string.
  - toHex
```
public static char toHex(int i)
```
    To hex.
    
    Parameters:
    
    i - the i
    
    Returns:
    
    the char
  - toUnicode
```
public static String toUnicode(String toUnicode,
                               boolean toLowerCase)
```
    Converts all characters from the given String to unicodes characters encoded like \uxxxx.
    
    Parameters:
    
    toUnicode - The String to convert.
    
    toLowerCase - If true the letters from the unicode characters are lower case.
    
    Returns:
    
    The converted String.

Class StringUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringUtils

Method Detail

convertCharsToUnicodeChars

convertToBytearray

convertToCharArray

convertUnicodeStringToCharacter

decodeHex

encodeHex

getAttributName

getIndex

getItemNumber

getLastCharacter

getStringAfterUnderscore

getStringBeforeUnderscore

getValue

isNullOrEmpty

isNumber

putQuotesToString

readLine

removeEmptyString

removeNewlineCharacters

removeQuotationMarks

replaceAll

replaceAll

replaceEach

setFirstCharacterToLowerCase

setFirstCharacterToUpperCase

toHex

toUnicode