com.jdroid.java.utils

Class StringUtils

java.lang.Object

com.jdroid.java.utils.StringUtils

public abstract class StringUtils
extends java.lang.Object

This class contains functions for managing Strings

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BANG
static java.lang.String	COMMA
static java.lang.String	DASH
static java.lang.String	DOT
static java.lang.String	ELLIPSIS
static java.lang.String	EMPTY
static java.lang.String	NEW_LINE
static java.lang.String	PIPE
static java.lang.String	SLASH
static java.lang.String	SPACE
static java.lang.String	UNDERSCORE

Constructor Summary

Constructors

Constructor and Description
StringUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	capitalize(java.lang.String text)
static java.lang.String	capitalizeWords(java.lang.String str) Capitalizes all the whitespace separated words in a String.
static java.lang.String	capitalizeWords(java.lang.String str, char[] delimiters) Capitalizes all the delimiter separated words in a String.
static java.lang.String	defaultString(java.lang.String str) Returns either the passed in String, or if the String is null, an empty String ("").
static java.lang.String	defaultString(java.lang.String str, java.lang.String defaultString)
static java.lang.Boolean	equal(java.lang.String text1, java.lang.String text2)
static java.util.Set<java.lang.String>	extractPlaceHolders(java.lang.String string) Extract all the placeholder's names of the string
static java.lang.String	getFirstToken(java.lang.String string) Returns the first token of the string if that string can be split by a ",", else return the unmodified input string
static java.lang.String	getFirstToken(java.lang.String string, java.lang.String token) Returns the first token of the string if that string can be split by the token, else return the unmodified input string
static java.lang.String	getNotEmptyString(java.lang.String text)
static boolean	hasOnlyCharacters(java.lang.String name)
static boolean	isBlank(java.lang.String str) Checks if a String is whitespace, empty ("") or null.
static java.lang.Boolean	isEmpty(java.lang.String text)
static boolean	isNotBlank(java.lang.String str) Checks if a String is not empty (""), not null and not whitespace only.
static java.lang.Boolean	isNotEmpty(java.lang.String text)
static java.lang.String	join(java.util.Collection<?> objectsToJoin) Joins all the strings in the list in a single one separated by ','.
static java.lang.String	join(java.util.Collection<?> objectsToJoin, java.lang.String separator) Joins all the strings in the list in a single one separated by the separator sequence.
static java.lang.CharSequence	removeTrailingWhitespaces(java.lang.CharSequence charSequence)
static java.lang.String	replaceValues(java.lang.String template, java.util.Map<java.lang.String,java.lang.String> values)
static java.util.Collection<java.lang.String>	splitToCollectionWithCommaSeparator(java.lang.String text)
static java.util.Collection<java.lang.String>	splitToCollectionWithCommaSeparator(java.lang.String text, java.lang.String separator)
static java.util.List<java.lang.String>	splitToListWithCommaSeparator(java.lang.String text)
static java.lang.String	toAlphanumeric(java.lang.String value) Transform the received value removing all the not alphanumeric or spaces characters
static java.lang.String	truncate(java.lang.String text, java.lang.Integer maxCharacters) Truncate the text adding "...".
static java.lang.String	truncate(java.lang.String text, java.lang.Integer maxCharacters, java.lang.Boolean truncateWords) Truncate the text adding "..." if the truncateWords parameter is true.
static java.lang.String	wordWrapToTwoLines(java.lang.String text, int minLength) This method word wrap a text to two lines if the text has multiple words and its length is greater than the specified minLength.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY

public static final java.lang.String EMPTY

See Also:

Constant Field Values

ELLIPSIS

public static final java.lang.String ELLIPSIS

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

See Also:

Constant Field Values

SPACE

public static final java.lang.String SPACE

See Also:

Constant Field Values

DASH

public static final java.lang.String DASH

See Also:

Constant Field Values

SLASH

public static final java.lang.String SLASH

See Also:

Constant Field Values

DOT

public static final java.lang.String DOT

See Also:

Constant Field Values

NEW_LINE

public static final java.lang.String NEW_LINE

See Also:

Constant Field Values

UNDERSCORE

public static final java.lang.String UNDERSCORE

See Also:

Constant Field Values

BANG

public static final java.lang.String BANG

See Also:

Constant Field Values

PIPE

public static final java.lang.String PIPE

See Also:

Constant Field Values

Constructor Detail

StringUtils

public StringUtils()

Method Detail

getNotEmptyString

public static java.lang.String getNotEmptyString(java.lang.String text)

equal

public static java.lang.Boolean equal(java.lang.String text1,
                                      java.lang.String text2)

isEmpty

public static java.lang.Boolean isEmpty(java.lang.String text)

isNotEmpty

public static java.lang.Boolean isNotEmpty(java.lang.String text)

isBlank

public static boolean isBlank(java.lang.String str)

Checks if a String is whitespace, empty ("") or null.

 StringUtils.isBlank(null)      = true
 StringUtils.isBlank("")        = true
 StringUtils.isBlank(" ")       = true
 StringUtils.isBlank("bob")     = false
 StringUtils.isBlank("  bob  ") = false
 

Parameters:

str - the String to check, may be null

Returns:

true if the String is null, empty or whitespace

isNotBlank

public static boolean isNotBlank(java.lang.String str)

Checks if a String is not empty (""), not null and not whitespace only.

 StringUtils.isNotBlank(null)      = false
 StringUtils.isNotBlank("")        = false
 StringUtils.isNotBlank(" ")       = false
 StringUtils.isNotBlank("bob")     = true
 StringUtils.isNotBlank("  bob  ") = true
 

Parameters:

str - the String to check, may be null

Returns:

true if the String is not empty and not null and not whitespace

defaultString

public static java.lang.String defaultString(java.lang.String str)

Returns either the passed in String, or if the String is null, an empty String ("").

 StringUtils.defaultString(null)  = ""
 StringUtils.defaultString("")    = ""
 StringUtils.defaultString("bat") = "bat"
 

Parameters:

str - the String to check, may be null

Returns:

the passed in String, or the empty String if it was null

defaultString

public static java.lang.String defaultString(java.lang.String str,
                                             java.lang.String defaultString)

capitalize

public static java.lang.String capitalize(java.lang.String text)

capitalizeWords

public static java.lang.String capitalizeWords(java.lang.String str)

Capitalizes all the whitespace separated words in a String. Only the first letter of each word is changed. To convert the rest of each word to lowercase at the same time, use capitalize(String).

Whitespace is defined by Character.isWhitespace(char). A null input String returns null. Capitalization uses the unicode title case, normally equivalent to upper case.

 WordUtils.capitalize(null)        = null
 WordUtils.capitalize("")          = ""
 WordUtils.capitalize("i am FINE") = "I Am FINE"
 

Parameters:

str - the String to capitalize, may be null

Returns:

capitalized String, null if null String input

capitalizeWords

public static java.lang.String capitalizeWords(java.lang.String str,
                                               char[] delimiters)

Capitalizes all the delimiter separated words in a String. Only the first letter of each word is changed.

The delimiters represent a set of characters understood to separate words. The first string character and the first non-delimiter character after a delimiter will be capitalized.

A null input String returns null. Capitalization uses the unicode title case, normally equivalent to upper case.

 WordUtils.capitalize(null, *)            = null
 WordUtils.capitalize("", *)              = ""
 WordUtils.capitalize(*, new char[0])     = *
 WordUtils.capitalize("i am fine", null)  = "I Am Fine"
 WordUtils.capitalize("i aM.fine", {'.'}) = "I aM.Fine"
 

Parameters:

str - the String to capitalize, may be null

delimiters - set of characters to determine capitalization, null means whitespace

Returns:

capitalized String, null if null String input

join

public static java.lang.String join(java.util.Collection<?> objectsToJoin,
                                    java.lang.String separator)

Joins all the strings in the list in a single one separated by the separator sequence.

Parameters:

objectsToJoin - The objects to join.

separator - The separator sequence.

Returns:

The joined strings.

join

public static java.lang.String join(java.util.Collection<?> objectsToJoin)

Joins all the strings in the list in a single one separated by ','.

Parameters:

objectsToJoin - The objects to join.

Returns:

The joined strings.

truncate

public static java.lang.String truncate(java.lang.String text,
                                        java.lang.Integer maxCharacters,
                                        java.lang.Boolean truncateWords)

Truncate the text adding "..." if the truncateWords parameter is true. The ellipsis will be taken into account when counting the amount of characters.

Parameters:

text - The text to truncate

maxCharacters - The maximum amount of characters allowed for the returned text

truncateWords - True if the words should be truncated

Returns:

The truncated text

truncate

public static java.lang.String truncate(java.lang.String text,
                                        java.lang.Integer maxCharacters)

Truncate the text adding "...". The ellipsis will be taken into account when counting the amount of characters.

Parameters:

text - The text to truncate

maxCharacters - The maximum amount of characters allowed for the returned text

Returns:

The truncated text

extractPlaceHolders

public static java.util.Set<java.lang.String> extractPlaceHolders(java.lang.String string)

Extract all the placeholder's names of the string

Parameters:

string - The whole string with placeholders

Returns:

A set with all the placeholder's names

toAlphanumeric

public static java.lang.String toAlphanumeric(java.lang.String value)

Transform the received value removing all the not alphanumeric or spaces characters

Parameters:

value - The string to transform

Returns:

The transformed string

splitToListWithCommaSeparator

public static java.util.List<java.lang.String> splitToListWithCommaSeparator(java.lang.String text)

splitToCollectionWithCommaSeparator

public static java.util.Collection<java.lang.String> splitToCollectionWithCommaSeparator(java.lang.String text)

splitToCollectionWithCommaSeparator

public static java.util.Collection<java.lang.String> splitToCollectionWithCommaSeparator(java.lang.String text,
                                                                                         java.lang.String separator)

getFirstToken

public static java.lang.String getFirstToken(java.lang.String string,
                                             java.lang.String token)

Returns the first token of the string if that string can be split by the token, else return the unmodified input string

Parameters:

string - The string to split

token - The token to use as splitter

Returns:

The resultant string

getFirstToken

public static java.lang.String getFirstToken(java.lang.String string)

Returns the first token of the string if that string can be split by a ",", else return the unmodified input string

Parameters:

string - The string to split

Returns:

The resultant string

wordWrapToTwoLines

public static java.lang.String wordWrapToTwoLines(java.lang.String text,
                                                  int minLength)

This method word wrap a text to two lines if the text has multiple words and its length is greater than the specified minLength. To do the word wrap, the white space closest to the middle of the string is replaced by a "\n" character

Parameters:

text - A Sting, the text to word wrap to two lines.

minLength - The min text length to apply word wrap.

Returns:

The input text word wrapped to two lines or the original text.

replaceValues

public static java.lang.String replaceValues(java.lang.String template,
                                             java.util.Map<java.lang.String,java.lang.String> values)

hasOnlyCharacters

public static boolean hasOnlyCharacters(java.lang.String name)

removeTrailingWhitespaces

public static java.lang.CharSequence removeTrailingWhitespaces(java.lang.CharSequence charSequence)

Parameters:

charSequence - a CharSequence, the charSequence to trim.

Returns:

a CharSequence with whitespace characters removed from the end, including non-breaking spaces ( or ) and line separators.