StringUtils (Codelogger Utils 1.0.0 API)

java.lang.Object
- org.codelogger.utils.StringUtils

```
public class StringUtils
extends Object
```
A useful tools to handle string, likes judge blank or not blank, first character to upper or lower case, index with, judge contains, encoding, replace, delete and so on...

Author:

DengDefei

Field Summary

Fields
Modifier and Type Field and Description

static int INDEX_OF_NOT_FOUND

Fields
Modifier and Type	Field and Description
`static int`	`INDEX_OF_NOT_FOUND`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`containsIgnoreCase(String source, String target)` Returns true if given string contains given target string ignore case, false otherwise.
`static boolean`	`containsWhitespace(String source)` Returns true if given string have white span, false otherwise.
`static boolean`	`containsWord(String text, String word)` Returns true if given text contains given word; false otherwise.
`static boolean`	`containsWordIgnoreCase(String text, String word)` Returns true if given text contains given word ignore case; false otherwise.
`static int`	`count(String source, String target)` Count how much target in souce string. 统计target在source中出现的次数。
`static int`	`countIgnoreCase(String source, String target)` Count how much target in souce string. 统计target在source中出现的次数。
`static String`	`deleteIgnoreCase(String source, String target)` Returns a new string which source string delete destination chars ignore case sensitive.
`static String`	`encoding(String source, String sourceCharset, String encodingCharset)` Return encoded string by given charset.
`static boolean`	`endsWithIgnoreCase(String source, String target)` Returns true if given source string end with target string ignore case sensitive; false otherwise.
`static String`	`firstCharToLowerCase(String source)` Convert first character in given string to lower case. If given source string is blank or first character is lower case, return it's self.
`static String`	`firstCharToUpperCase(String source)` Convert first character in given string to upper case. If given source string is blank or first character is upper case, return it's self.
`static char`	`getRandomAlphabetic()` Returns a random alphabetic: a-zA-Z.
`static char`	`getRandomLowerCaseAlphabetic()` Returns a random alphabetic: a-zA-Z.
`static char`	`getRandomPasswordChar()` Returns a random passowrd char: a-zA-Z0-9.
`static String`	`getRandomPasswordString(int stringLength)` Returns a random given length size passowrd string([a-zA-Z0-9]+).
`static String`	`getRandomString(int stringLength)` Returns a random given length size alphabetic string.
`static char`	`getRandomUpperCaseAlphabetic()` Returns a random alphabetic: a-zA-Z.
`static List<String>`	`getStringsByRegex(String text, String regex)` 根据正则表达式提取字符串
`static List<String>`	`getWords(String text, int wordMinimumLength)` Returns words in given text by given word minimum length.
`static int`	`indexOfIgnoreCase(String source, String target)` Returns the index within given source string of the first occurrence of the specified target string with ignore case sensitive.
`static int`	`indexOfIgnoreCase(String source, String target, int fromIndex)` Returns the index within given source string of the first occurrence of the specified target string with ignore case sensitive, starting at the specify index.
`static boolean`	`isBlank(String source)` Returns true if the source string is null or all characters in this string is space; false otherwise.
`static boolean`	`isEmpty(String source)` Returns true if the source string is null or length = 0; false otherwise.
`static boolean`	`isNotBlank(String source)` Returns true if the source string is not null and at least one character in this string is not space; false otherwise.
`static String`	`replacIgnoreCase(String source, String target, String replacement)` Replaces each substring of given source string that matches the given regular expression ignore case sensitive with the given replacement.
`static String`	`reverse(String string)` Sort the array in reverse order. 反转字符串。
`static boolean`	`startsWithIgnoreCase(String source, String target)` Returns true if given source string start with target string ignore case sensitive; false otherwise.
`static String`	`trimAllWhitespace(String source)` Trim all white space in the given string. If given source string self if it's null or length == 0 or not have white space.

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

- Field Detail
  - INDEX_OF_NOT_FOUND
```
public static final int INDEX_OF_NOT_FOUND
```
    See Also:
    Constant Field Values
- Method Detail
  - isEmpty
```
public static boolean isEmpty(String source)
```
    Returns true if the source string is null or length = 0; false otherwise.
    
    Parameters:
    source - string to be tested.
    
    Returns:
    true if the source string is null or length = 0; false otherwise.
  - isBlank
```
public static boolean isBlank(String source)
```
    Returns true if the source string is null or all characters in this string is space; false otherwise.
    
    Parameters:
    source - string to be tested.
    
    Returns:
    true if the source string is null or all characters in this string is space; false otherwise.
  - isNotBlank
```
public static boolean isNotBlank(String source)
```
    Returns true if the source string is not null and at least one character in this string is not space; false otherwise.
    
    Parameters:
    source - string to be tested.
    
    Returns:
    true if the source string is not null and at least one character in this string is not space; false otherwise.
  - firstCharToUpperCase
```
public static String firstCharToUpperCase(String source)
```
    Convert first character in given string to upper case.
    If given source string is blank or first character is upper case, return it's self.
    
    Parameters:
    source - string to be tested.
    
    Returns:
    a new string has been converted or it's self.
  - firstCharToLowerCase
```
public static String firstCharToLowerCase(String source)
```
    Convert first character in given string to lower case.
    If given source string is blank or first character is lower case, return it's self.
    
    Parameters:
    source - string want to be handle.
    
    Returns:
    a new string has been converted or it's self.
  - indexOfIgnoreCase
```
public static int indexOfIgnoreCase(String source,
                    String target)
```
    Returns the index within given source string of the first occurrence of the specified target string with ignore case sensitive.
    
    Parameters:
    source - source string to be tested.
    target - target string to be tested.
    
    Returns:
    index number if found, -1 otherwise.
  - indexOfIgnoreCase
```
public static int indexOfIgnoreCase(String source,
                    String target,
                    int fromIndex)
```
    Returns the index within given source string of the first occurrence of the specified target string with ignore case sensitive, starting at the specify index.
    
    Parameters:
    source - source string to be tested.
    target - target string to be tested.
    
    Returns:
    index number if found, -1 otherwise.
  - containsWhitespace
```
public static boolean containsWhitespace(String source)
```
    Returns true if given string have white span, false otherwise.
    
    Parameters:
    source - string to be tested.
    
    Returns:
    true if given string have white span, false otherwise.
  - containsIgnoreCase
```
public static boolean containsIgnoreCase(String source,
                         String target)
```
    Returns true if given string contains given target string ignore case, false otherwise.
    
    Parameters:
    source - string to be tested.
    target - string to be tested.
    
    Returns:
    true if given string contains given target string ignore case, false otherwise.
  - getWords
```
public static List<String> getWords(String text,
                    int wordMinimumLength)
```
    Returns words in given text by given word minimum length.
    
    e.g:
    text: "I have a dream, but now it is only a dream."
    wordMinimumLength: 2
    result:["have","dream","but","now","it","is","only","dream"].
    
    NB. "1word","word1" also were words.
    
    Parameters:
    text - source string to be handled.
    wordMinimumLength - word minimum length to partition.
    
    Returns:
    words in given text by given word minimum length.
  - getStringsByRegex
```
public static List<String> getStringsByRegex(String text,
                             String regex)
```
    根据正则表达式提取字符串
    
    Parameters:
    text - 源字符串
    regex - 正则表达式
    
    Returns:
    所以符合正则表达式的字符串的集合
  - containsWord
```
public static boolean containsWord(String text,
                   String word)
```
    Returns true if given text contains given word; false otherwise.
    
    Parameters:
    text - string text to be tested.
    word - string word to be tested.
    
    Returns:
    true if given text contains given word; false otherwise.
  - containsWordIgnoreCase
```
public static boolean containsWordIgnoreCase(String text,
                             String word)
```
    Returns true if given text contains given word ignore case; false otherwise.
    
    Parameters:
    text - string text to be tested.
    word - string word to be tested.
    
    Returns:
    true if given text contains given word ignore case; false otherwise.
  - trimAllWhitespace
```
public static String trimAllWhitespace(String source)
```
    Trim all white space in the given string.
    If given source string self if it's null or length == 0 or not have white space.
    
    Parameters:
    source -
    
    Returns:
    a new string has been removed all white space if given source string have white space; given source string self otherwise.
  - startsWithIgnoreCase
```
public static boolean startsWithIgnoreCase(String source,
                           String target)
```
    Returns true if given source string start with target string ignore case sensitive; false otherwise.
    
    Parameters:
    source - string to be tested.
    target - string to be tested.
    
    Returns:
    true if given source string start with target string ignore case sensitive; false otherwise.
  - endsWithIgnoreCase
```
public static boolean endsWithIgnoreCase(String source,
                         String target)
```
    Returns true if given source string end with target string ignore case sensitive; false otherwise.
    
    Parameters:
    source - string to be tested.
    target - string to be tested.
    
    Returns:
    true if given source string end with target string ignore case sensitive; false otherwise.
  - replacIgnoreCase
```
public static String replacIgnoreCase(String source,
                      String target,
                      String replacement)
```
    Replaces each substring of given source string that matches the given regular expression ignore case sensitive with the given replacement.
    
    Parameters:
    source - source string want to be handle.
    target - target string want to be replaces.
    replacement - string of replace to.
    
    Returns:
    a new string has been replaced each substring of given source string that matches the given regular expression ignore case sensitive with the given replacement.
  - deleteIgnoreCase
```
public static String deleteIgnoreCase(String source,
                      String target)
```
    Returns a new string which source string delete destination chars ignore case sensitive.
    
    Parameters:
    source - source want to be handle.
    target - target string want to be deleted.
    
    Returns:
    a new string which source string delete destination chars ignore case sensitive.
  - getRandomUpperCaseAlphabetic
```
public static char getRandomUpperCaseAlphabetic()
```
    Returns a random alphabetic: a-zA-Z.
    
    Returns:
    a random alphabetic: a-zA-Z
  - getRandomLowerCaseAlphabetic
```
public static char getRandomLowerCaseAlphabetic()
```
    Returns a random alphabetic: a-zA-Z.
    
    Returns:
    a random alphabetic: a-zA-Z
  - getRandomAlphabetic
```
public static char getRandomAlphabetic()
```
    Returns a random alphabetic: a-zA-Z.
    
    Returns:
    a random alphabetic: a-zA-Z
  - getRandomString
```
public static String getRandomString(int stringLength)
```
    Returns a random given length size alphabetic string.
    
    Parameters:
    stringLength - the length of the random string you want.
    
    Returns:
    a random given length size alphabetic string.
  - getRandomPasswordChar
```
public static char getRandomPasswordChar()
```
    Returns a random passowrd char: a-zA-Z0-9.
    
    Returns:
    a random passowrd char: a-zA-Z0-9
  - getRandomPasswordString
```
public static String getRandomPasswordString(int stringLength)
```
    Returns a random given length size passowrd string([a-zA-Z0-9]+).
    
    Parameters:
    stringLength - the length of the random passowrd you want.
    
    Returns:
    a random given length size passowrd string([a-zA-Z0-9]+).
  - encoding
```
public static String encoding(String source,
              String sourceCharset,
              String encodingCharset)
                       throws IllegalArgumentException
```
    Return encoded string by given charset.
    
    Parameters:
    source - source string to be handle.
    sourceCharset - source string charset name.
    encodingCharset - want encoding to which charset.
    
    Returns:
    a new string has been encoded.
    
    Throws:
    
    IllegalArgumentExceptionWORD_PATTERN - If the named charset is not supported
    
    IllegalArgumentException
  - reverse
```
public static String reverse(String string)
```
    Sort the array in reverse order.
    反转字符串。
    
    Parameters:
    string - string to be handled.
  - count
```
public static int count(String source,
        String target)
```
    Count how much target in souce string.
    统计target在source中出现的次数。
    
    Parameters:
    source - source string
    target - target string
    
    Returns:
    the count of target in source string.
  - countIgnoreCase
```
public static int countIgnoreCase(String source,
                  String target)
```
    Count how much target in souce string.
    统计target在source中出现的次数。
    
    Parameters:
    source - source string
    target - target string
    
    Returns:
    the count of target in source string.

Class StringUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDEX_OF_NOT_FOUND

Method Detail

isEmpty

isBlank

isNotBlank

firstCharToUpperCase

firstCharToLowerCase

indexOfIgnoreCase

indexOfIgnoreCase

containsWhitespace

containsIgnoreCase

getWords

getStringsByRegex

containsWord

containsWordIgnoreCase

trimAllWhitespace

startsWithIgnoreCase

endsWithIgnoreCase

replacIgnoreCase

deleteIgnoreCase

getRandomUpperCaseAlphabetic

getRandomLowerCaseAlphabetic

getRandomAlphabetic

getRandomString

getRandomPasswordChar

getRandomPasswordString

encoding

reverse

count

countIgnoreCase