com.hfg.util

Class StringUtil

java.lang.Object

com.hfg.util.StringUtil

public class StringUtil
extends Object

General String utility functions.

Constructor Summary

Constructors

Constructor and Description
StringUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	allValuesAreEmpty(String[] inArray)
static String	applySubstitutionMap(CharSequence inString, Map<String,String> inSubstitutionMap)
static String	applySubstitutionMap(CharSequence inString, Map<String,String> inSubstitutionMap, String inDelimiter)
static String	capitalize(String inString) Returns the input string with the first character capitalized.
static int	computeLevenshteinDistance(CharSequence inString1, CharSequence inString2) Calculates the Levenshtein distance between two Strings.
static boolean	containsLowerCase(String inString) Returns whether or not the specified string contains a lower-case letter.
static boolean	containsUpperCase(String inString) Returns whether or not the specified string contains an upper-case letter.
static String	generateLocalizedNumberString(Number inValue)
static String	generateLocalizedNumberString(Number inValue, Locale inLocale)
static String	generateRandomEgyptianHieroglyphics(int inLength)
static String	generateRandomString(Character.UnicodeScript inScript, int inLength)
static String	generateRandomString(CharSequence inAlphabet, int inLength) Returns a random string of the specified length using the specified alphabet of characters.
static List<Integer>	getCharactersForUnicodeScript(Character.UnicodeScript inScript)
static int	getCharCount(CharSequence inString, char inChar) Returns the number of times the specified character appears in the specified String.
static Range<Integer>	getRangeForUnicodeBlock(Character.UnicodeBlock inBlock)
static String	getSystemLineSeparator()
static boolean	isNumber(CharSequence inString)
static boolean	isQuoted(CharSequence inString) Returns whether or not the specified String is contained within surrounding quotes.
static boolean	isSet(CharSequence inString) Returns whether the specified String contains non-whitespace content.
static String	join(Collection pieces, String inSeperator) Joins the elements of a Collection together using the specified String.
static String	join(int[] inArray, String inSeperator) Joins the elements of a int[] together using the specified String.
static String	join(Object[] inArray, String inSeperator) Joins the elements of an Object[] together using the specified String.
static String	join(String[] pieces) Joins the elements of a String[] together using a space as the separator.
static String	join(String[] pieces, String inSeperator) Joins the elements of a String[] together using the specified String.
static String	joinIncludeSingleQuote(Collection pieces, String inSeperator) Joins the elements of a Collection together using the specified String.
static String[]	lines(CharSequence inString)
static String	polyChar(char inChar, int inNum) Returns a String composed of inChar repeated inNum times.
static String	polyString(String inString, int inNum) Returns a String composed of inString repeated inNum times.
static String	quote(Object inObject) Returns the specified String surrounded by quotes and escaping any internal quotes.
static String	removeWhitespace(CharSequence inString)
static String	replaceAll(CharSequence inString, String inTarget, String inReplacement) Returns a String where all instances of inTarget in inString are replaced by inReplacement.
static String	replaceAllRegexp(CharSequence inString, Pattern inPattern, String inReplacement) Returns a String where all portions of inString matching the inPattern are replaced by inReplacement.
static String	replaceAllRegexp(CharSequence inString, String inRegexpTarget, String inReplacement) Returns a String where all portions of inString matching the inTargetRegexp are replaced by inReplacement.
static String	replaceWhitespace(CharSequence inString, CharSequence inWhitespaceReplacementString)
static String	scramble(CharSequence inString)
static String	singleQuote(Object inObject) Returns the specified String surrounded by single quotes and escaping any internal single quotes.
static String	stripHTMLTags(String inString)
static String	toSubscript(int inNumericValue) Returns a unicode string for the specified number as a subscript.
static String	toSubscript(String inString) Returns a unicode string for the specified number as a subscript.
static String	toSuperscript(int inNumericValue) Returns a unicode string for the specified number as a superscript.
static String	toSuperscript(String inString) Returns a unicode string for the specified number as a superscript.
static String	trimTrailingWhitespace(CharSequence inString)
static String	truncate(String inString, int inMaxLength) If the specified string is longer than the specified maximum length, a truncated string is returned.
static String	truncateWithEllipsis(String inString, int inMaxLength) Truncates the string and adds an ellipsis (…) if it exceeds the specified length.
static String	unquote(CharSequence inString) Returns the specified String while removing surrounding quotes if present.
static String	wrap(String inString, int inMaxLineLength)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtil

public StringUtil()

Method Detail

getSystemLineSeparator

public static String getSystemLineSeparator()

isSet

public static boolean isSet(CharSequence inString)

Returns whether the specified String contains non-whitespace content.

join

public static String join(String[] pieces)

Joins the elements of a String[] together using a space as the separator.

join

public static String join(String[] pieces,
                          String inSeperator)

Joins the elements of a String[] together using the specified String.

join

public static String join(Object[] inArray,
                          String inSeperator)

Joins the elements of an Object[] together using the specified String.

join

public static String join(int[] inArray,
                          String inSeperator)

Joins the elements of a int[] together using the specified String.

join

public static String join(Collection pieces,
                          String inSeperator)

Joins the elements of a Collection together using the specified String.

joinIncludeSingleQuote

public static String joinIncludeSingleQuote(Collection pieces,
                                            String inSeperator)

Joins the elements of a Collection together using the specified String. Enclose each element with single quotation marks. Author: Esther Ting

polyString

public static String polyString(String inString,
                                int inNum)

Returns a String composed of inString repeated inNum times.

polyChar

public static String polyChar(char inChar,
                              int inNum)

Returns a String composed of inChar repeated inNum times.

replaceAll

public static String replaceAll(CharSequence inString,
                                String inTarget,
                                String inReplacement)

Returns a String where all instances of inTarget in inString are replaced by inReplacement.

replaceAllRegexp

public static String replaceAllRegexp(CharSequence inString,
                                      String inRegexpTarget,
                                      String inReplacement)

Returns a String where all portions of inString matching the inTargetRegexp are replaced by inReplacement.

replaceAllRegexp

public static String replaceAllRegexp(CharSequence inString,
                                      Pattern inPattern,
                                      String inReplacement)

Returns a String where all portions of inString matching the inPattern are replaced by inReplacement.

trimTrailingWhitespace

public static String trimTrailingWhitespace(CharSequence inString)

removeWhitespace

public static String removeWhitespace(CharSequence inString)

replaceWhitespace

public static String replaceWhitespace(CharSequence inString,
                                       CharSequence inWhitespaceReplacementString)

quote

public static String quote(Object inObject)

Returns the specified String surrounded by quotes and escaping any internal quotes.

singleQuote

public static String singleQuote(Object inObject)

Returns the specified String surrounded by single quotes and escaping any internal single quotes.

isQuoted

public static boolean isQuoted(CharSequence inString)

Returns whether or not the specified String is contained within surrounding quotes.

unquote

public static String unquote(CharSequence inString)

Returns the specified String while removing surrounding quotes if present.

getCharCount

public static int getCharCount(CharSequence inString,
                               char inChar)

Returns the number of times the specified character appears in the specified String.

scramble

public static String scramble(CharSequence inString)

applySubstitutionMap

public static String applySubstitutionMap(CharSequence inString,
                                          Map<String,String> inSubstitutionMap)

applySubstitutionMap

public static String applySubstitutionMap(CharSequence inString,
                                          Map<String,String> inSubstitutionMap,
                                          String inDelimiter)

stripHTMLTags

public static String stripHTMLTags(String inString)

truncate

public static String truncate(String inString,
                              int inMaxLength)

If the specified string is longer than the specified maximum length, a truncated string is returned. Otherwise the original string is returned.

Parameters:

inString - the original string value

inMaxLength - the maximum lenght allowed for the string

Returns:

the processed string value

truncateWithEllipsis

public static String truncateWithEllipsis(String inString,
                                          int inMaxLength)

Truncates the string and adds an ellipsis (…) if it exceeds the specified length. Otherwise the original string is returned.

Parameters:

inString - the string to be truncated

inMaxLength - the length beyond which the specified string should be truncated

Returns:

the truncated string

containsLowerCase

public static boolean containsLowerCase(String inString)

Returns whether or not the specified string contains a lower-case letter.

Parameters:

inString - the string value to be checked

Returns:

whether or not the specified string contains a lower-case letter

containsUpperCase

public static boolean containsUpperCase(String inString)

Returns whether or not the specified string contains an upper-case letter.

Parameters:

inString - the string value to be checked

Returns:

whether or not the specified string contains an upper-case letter

capitalize

public static String capitalize(String inString)

Returns the input string with the first character capitalized.

Parameters:

inString - the string value to be capitalized

Returns:

the input string with the first character capitalized

toSuperscript

public static String toSuperscript(int inNumericValue)

Returns a unicode string for the specified number as a superscript.

Parameters:

inNumericValue - the numeric value to be superscripted

Returns:

the unicode string for the specified number as a superscript

toSuperscript

public static String toSuperscript(String inString)

Returns a unicode string for the specified number as a superscript.

Parameters:

inString - the numeric value to be superscripted

Returns:

the unicode string for the specified number as a superscript

toSubscript

public static String toSubscript(int inNumericValue)

Returns a unicode string for the specified number as a subscript.

Parameters:

inNumericValue - the numeric value to be subscripted

Returns:

the unicode string for the specified number as a subscript

toSubscript

public static String toSubscript(String inString)

Returns a unicode string for the specified number as a subscript.

Parameters:

inString - the numeric value to be subscripted

Returns:

the unicode string for the specified number as a subscript

lines

public static String[] lines(CharSequence inString)

wrap

public static String wrap(String inString,
                          int inMaxLineLength)

generateRandomString

public static String generateRandomString(CharSequence inAlphabet,
                                          int inLength)

Returns a random string of the specified length using the specified alphabet of characters.

Parameters:

inAlphabet - a string of the allowed characters

inLength - the length of the random string to be composed

Returns:

the random string

generateRandomString

public static String generateRandomString(Character.UnicodeScript inScript,
                                          int inLength)

generateRandomEgyptianHieroglyphics

public static String generateRandomEgyptianHieroglyphics(int inLength)

getRangeForUnicodeBlock

public static Range<Integer> getRangeForUnicodeBlock(Character.UnicodeBlock inBlock)

getCharactersForUnicodeScript

public static List<Integer> getCharactersForUnicodeScript(Character.UnicodeScript inScript)

generateLocalizedNumberString

public static String generateLocalizedNumberString(Number inValue)

generateLocalizedNumberString

public static String generateLocalizedNumberString(Number inValue,
                                                   Locale inLocale)

isNumber

public static boolean isNumber(CharSequence inString)

allValuesAreEmpty

public static boolean allValuesAreEmpty(String[] inArray)

computeLevenshteinDistance

public static int computeLevenshteinDistance(CharSequence inString1,
                                             CharSequence inString2)

Calculates the Levenshtein distance between two Strings. Algorithm based on Apache Commons implementation.

Parameters:

inString1 - the first string for comparison

inString2 - the second string for comparison

Returns:

the computed Levenshtein distance