Strings (OpenHub Framework 1.0.0 API)

java.lang.Object
- org.openhubframework.openhub.common.Strings

public final class Strings
extends Object

The common String utilities.

Author:: Jan Loose

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AMP`
`static String`	`AMP_XML`
`static Charset`	`CHARSET_UTF8` The UTF-8 charset constant.
`static Pattern`	`HTML_REMOVE_PATTERN`
`static String`	`HTML_REMOVE_REGEX`
`static String`	`HTTP_PREFIX`
`static String`	`HTTPS_PREFIX`
`static String`	`LINE_SEPARATOR`
`static String`	`LIST_DELIMITERS` Common string list delimiters.
`static String`	`NB_SPACE`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`arrayToString(Object[] array)` Converts an array to the string.
`static String`	`checkInput(String str)` Checks an input - it escapes the input for HTML and JavaScript.
`static List<Integer>`	`convertCommaSeparatedNumbersToList(String str)` Convert a comma-separated list of numbers to a `List` of `Integer`s.
`static String`	`convertListToCommaSeparatedString(List<?> list)` Convert a `List` to a comma-separated string.
`static CharSequence`	`escapeMarkup(CharSequence s)` This code was copied from Apache Wicket.
`static CharSequence`	`escapeMarkup(CharSequence s, boolean escapeSpaces)` This code was copied from Apache Wicket.
`static CharSequence`	`escapeMarkup(CharSequence s, boolean escapeSpaces, boolean convertToHtmlUnicodeEscapes)` This code was copied from Apache Wicket.
`static String`	`fm(String message, Object... values)` Substitutes all places of the message using a values.
`static int`	`indexOf(CharSequence input, char c)`
`static int`	`indexOf(CharSequence input, String text)`
`static boolean`	`isAbsoluteUrl(String url)` Returns true if url address starts with 'http://' or 'https://'.
`static boolean`	`isBlank(CharSequence c)`
`static boolean`	`isEmpty(CharSequence c)`
`static boolean`	`isNotBlank(CharSequence c)`
`static boolean`	`isNotEmpty(CharSequence c)`
`static CharSequence`	`removeHtml(String str)` Removes the HTML sequences from an input string.
`static StringBuilder`	`removeLastCharacter(StringBuilder sb, char c)` Removes last character from a builder if exists.
`static StringBuilder`	`removeLastComma(StringBuilder sb)` Removes last character ',' from a builder if exists.
`static CharSequence`	`replaceAll(CharSequence s, CharSequence searchFor, CharSequence replaceWith)` Replace all occurrences of one string replaceWith another string.
`static String`	`toExternalUrl(String url)` Prefixes url with 'http://' if not absolute url already.
`static String[]`	`tokenizeStringList(String list)` Tokenizes the given string list into an array of strings.
`static String`	`toString(CharSequence c)`
`static CharSequence`	`trim(CharSequence input)`

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

- Field Detail
  - HTML_REMOVE_REGEX
```
public static final String HTML_REMOVE_REGEX
```
    See Also:
    Constant Field Values
  - HTML_REMOVE_PATTERN
```
public static final Pattern HTML_REMOVE_PATTERN
```
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
  - NB_SPACE
```
public static final String NB_SPACE
```
    See Also:
    Constant Field Values
  - HTTP_PREFIX
```
public static final String HTTP_PREFIX
```
    See Also:
    Constant Field Values
  - HTTPS_PREFIX
```
public static final String HTTPS_PREFIX
```
    See Also:
    Constant Field Values
  - AMP
```
public static final String AMP
```
    See Also:
    Constant Field Values
  - AMP_XML
```
public static final String AMP_XML
```
    See Also:
    Constant Field Values
  - LIST_DELIMITERS
```
public static final String LIST_DELIMITERS
```
    Common string list delimiters.
    
    See Also:
    tokenizeStringList(String), Constant Field Values
  - CHARSET_UTF8
```
public static final Charset CHARSET_UTF8
```
    The UTF-8 charset constant.
- Method Detail
  - removeHtml
```
@Nullable
public static CharSequence removeHtml(@Nullable
                               String str)
```
    Removes the HTML sequences from an input string.
    
    Parameters:
    str - the input string
    
    Returns:
    the char sequence without HTML
  - toExternalUrl
```
@Nullable
public static String toExternalUrl(@Nullable
                            String url)
```
    Prefixes url with 'http://' if not absolute url already. null -> 'http://'.
    
    Parameters:
    url - url
    
    Returns:
    url
  - isAbsoluteUrl
```
public static boolean isAbsoluteUrl(@Nullable
                    String url)
```
    Returns true if url address starts with 'http://' or 'https://'.
    
    Parameters:
    url - url
    
    Returns:
    boolean
  - convertCommaSeparatedNumbersToList
```
public static List<Integer> convertCommaSeparatedNumbersToList(@Nullable
                                               String str)
```
    Convert a comma-separated list of numbers to a List of Integers. Non-numbers are skipped.
    
    Parameters:
    str - the string to be parsed
    
    Returns:
    the list of integers
  - convertListToCommaSeparatedString
```
public static String convertListToCommaSeparatedString(@Nullable
                                       List<?> list)
```
    Convert a List to a comma-separated string.
    
    Parameters:
    list - the list
    
    Returns:
    the comma-separated string or ""
  - arrayToString
```
public static String arrayToString(Object[] array)
```
    Converts an array to the string.
    
    Parameters:
    array - the array that has to be converted
    
    Returns:
    the array as a string
  - fm
```
public static String fm(String message,
        Object... values)
```
    Substitutes all places of the message using a values. See MessageFormatter for more detail.
    
    Parameters:
    message - the message with places defined as {}
    values - an array of values that are used to substitute formatting places of the message
    
    Returns:
    the final string
  - removeLastComma
```
public static StringBuilder removeLastComma(StringBuilder sb)
```
    Removes last character ',' from a builder if exists.
    
    Parameters:
    sb - string builder
    
    Returns:
    original string builder
  - removeLastCharacter
```
public static StringBuilder removeLastCharacter(StringBuilder sb,
                                char c)
```
    Removes last character from a builder if exists.
    
    Parameters:
    sb - string builder
    c - the the character to be removed
    
    Returns:
    original string builder
  - escapeMarkup
```
public static CharSequence escapeMarkup(CharSequence s)
```
    This code was copied from Apache Wicket. Converts a Java String to an HTML markup string, but does not convert normal spaces to non-breaking space entities (<nbsp>).
    
    Parameters:
    s - the string to escape
    
    Returns:
    The escaped string
    See Also:
    escapeMarkup(CharSequence, boolean)
  - escapeMarkup
```
public static CharSequence escapeMarkup(CharSequence s,
                        boolean escapeSpaces)
```
    This code was copied from Apache Wicket. Converts a Java String to an HTML markup String by replacing illegal characters with HTML entities where appropriate. Spaces are converted to non-breaking spaces (<nbsp>) if escapeSpaces is true, tabs are converted to four non-breaking spaces, less than signs are converted to < entities and greater than signs to > entities.
    
    Parameters:
    s - the string to escape
    escapeSpaces - true to replace ' ' with nonbreaking space
    
    Returns:
    The escaped string
  - escapeMarkup
```
public static CharSequence escapeMarkup(CharSequence s,
                        boolean escapeSpaces,
                        boolean convertToHtmlUnicodeEscapes)
```
    This code was copied from Apache Wicket. Converts a Java String to an HTML markup String by replacing illegal characters with HTML entities where appropriate. Spaces are converted to non-breaking spaces (<nbsp>) if escapeSpaces is true, tabs are converted to four non-breaking spaces, less than signs are converted to < entities and greater than signs to > entities.
    
    Parameters:
    s - the string to escape
    escapeSpaces - true to replace ' ' with nonbreaking space
    convertToHtmlUnicodeEscapes - true to convert non-7 bit characters to unicode HTML (&#...)
    
    Returns:
    the escaped string
  - tokenizeStringList
```
public static String[] tokenizeStringList(@Nullable
                          String list)
```
    Tokenizes the given string list into an array of strings.
    
    Parameters:
    list - the string list to be tokenized
    
    Returns:
    the tokenized list (an empty array in case of a null list)
    See Also:
    LIST_DELIMITERS
  - indexOf
```
public static int indexOf(CharSequence input,
          String text)
```
    Parameters:
    input - the input
    text - the searched text
    
    Returns:
    the index or -1
  - indexOf
```
public static int indexOf(CharSequence input,
          char c)
```
    Parameters:
    input - the input
    c - the searched character
    
    Returns:
    the index or -1
  - trim
```
@Nullable
public static CharSequence trim(@Nullable
                         CharSequence input)
```
    Parameters:
    input - the CharSequence to be trimmed
    
    Returns:
    the trimmed char sequence
  - isEmpty
```
public static boolean isEmpty(@Nullable
              CharSequence c)
```
  - isNotEmpty
```
public static boolean isNotEmpty(@Nullable
                 CharSequence c)
```
  - isBlank
```
public static boolean isBlank(@Nullable
              CharSequence c)
```
  - isNotBlank
```
public static boolean isNotBlank(@Nullable
                 CharSequence c)
```
  - toString
```
@Nullable
public static String toString(@Nullable
                       CharSequence c)
```
  - replaceAll
```
public static CharSequence replaceAll(CharSequence s,
                      CharSequence searchFor,
                      CharSequence replaceWith)
```
    Replace all occurrences of one string replaceWith another string.
    
    Parameters:
    s - The string to process
    searchFor - The value to search for
    replaceWith - The value to searchFor replaceWith
    
    Returns:
    The resulting string with searchFor replaced with replaceWith
  - checkInput
```
@Nullable
public static String checkInput(@Nullable
                         String str)
```
    Checks an input - it escapes the input for HTML and JavaScript.
    
    Parameters:
    str - the string to be checked
    
    Returns:
    the checked string

Class Strings

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTML_REMOVE_REGEX

HTML_REMOVE_PATTERN

LINE_SEPARATOR

NB_SPACE

HTTP_PREFIX

HTTPS_PREFIX

AMP

AMP_XML

LIST_DELIMITERS

CHARSET_UTF8

Method Detail

removeHtml

toExternalUrl

isAbsoluteUrl

convertCommaSeparatedNumbersToList

convertListToCommaSeparatedString

arrayToString

fm

removeLastComma

removeLastCharacter

escapeMarkup

escapeMarkup

escapeMarkup

tokenizeStringList

indexOf

indexOf

trim

isEmpty

isNotEmpty

isBlank

isNotBlank

toString

replaceAll

checkInput