org.cyclos.utils

Class StringHelper

java.lang.Object

org.cyclos.utils.StringHelper

public class StringHelper
extends java.lang.Object

Helper class for strings

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Function<java.lang.String,java.lang.String>	HTML_ENTITIES_REMOVER
static java.lang.String	LOWERCASE_LETTERS
static java.lang.String	NUMBERS
static java.lang.String	SPECIAL_CHARACTERS
static java.lang.String	UPPERCASE_LETTERS

Constructor Summary

Constructors

Constructor and Description
StringHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	asciiOnly(java.lang.String string) Removes from the given string all non-ASCII characters, returning null if the input is null
static java.lang.String	camelize(java.lang.String string) Transforms the given string into camel case.
static java.lang.String	capitalize(java.lang.String string) Returns a string where the first letter is uppercase and all others are lowercase
static java.lang.String	capitalizeAndCamelize(java.lang.String string)
static java.lang.String	capitalizeFirst(java.lang.String string) Transforms the first character of the given string to uppercase, handling nulls / empty strings
static java.lang.String	convertNewLineToBr(java.lang.String string)
static java.lang.String	defaultValue(java.lang.String string, java.lang.String defaultValue) Returns the value of the second string if the first is blank.
static java.lang.String	delimit(java.lang.String text, java.lang.String delimiter, int delimitSize) Transforms the given text adding a delimiter every time delimit size is reached.
static java.lang.String	emptyIfNull(java.lang.String s) Returns an empty string ("") when the parameter value is null.
static void	forEachLine(java.lang.String string, boolean supportsComments, java.util.function.Consumer<java.lang.String> consumer) Calls the given procedure for each non-empty untils the last line, trimmed line of the given string.
static void	forEachLine(java.lang.String string, boolean supportsComments, java.util.function.Predicate<java.lang.String> predicate) Calls the given function for each non-empty while it return true, trimmed line of the given string.
static java.lang.String	formatNumber(java.lang.String mask, java.lang.String number, boolean padLeftWithZeros) Replaces the sharps in the mask by the digits found in the number.
static java.lang.String	getNumberGenerationPattern(java.lang.String prefix, java.lang.Integer padLength, java.lang.String suffix) Returns a pattern which may be used to filter user input based on a transaction number pattern
static java.lang.String	htmlSpace() Returns the String representing an HTML space
static java.lang.String	htmlSpaces(int count) Returns the String representing n HTML spaces
static int	indexOf(java.lang.String[] array, java.lang.String stringToSearch) It returns the index of the first occurrence of the string in the array.
static boolean	isBlank(java.lang.Object object) Use the object's toString() method and checks whether it is null, empty or blank string (spaces only)
static boolean	isEquals(java.lang.String value1, java.lang.String value2) Returns true value1 is equals to value2 or both are empty
static boolean	isNotBlank(java.lang.Object object) Equivalent to the negation of isBlank(Object)
static boolean	isNumeric(java.lang.String results) Returns true if the given string is not null and composed of numbers only
static java.lang.String	join(java.util.Collection<?> parts, java.lang.String delimiter) Join the array of strings with the given delimiter
static java.lang.String	join(java.lang.Object[] parts, java.lang.String delimiter) Join the array of strings with the given delimiter
static java.lang.String	joinTrimming(java.util.Collection<?> parts, java.lang.String delimiter) Like join(Collection, String), but each part is trimmed, and not used if empty
static java.lang.String	leftPad(java.lang.String input, int size, char padChar) Left pad the specified input String until the specific pad size with the specified char. If input is null then it returns null.
static java.lang.String	lowercaseFirst(java.lang.String string) Sets the first character as lower case.
static java.lang.String	removeEnd(java.lang.String string, java.lang.String end) Removes the end of the given string, or returns the original string if end is null or not the final part of the string removeEnd(null, *) == null removeEnd(x, *) == x removeEnd("car", "ar") == "c" removeEnd("car", "r") == "ca" removeEnd("car", "x") == "car"
static java.lang.String	removeHtmlEntities(java.lang.String string) Removes the HTML entities, replacing them by actual characters.
static java.lang.String	removeMarkupTags(java.lang.String string) Removes all html/xml tags, keeping br tags as line breaks
static java.lang.String	removeMarkupTags(java.lang.String string, boolean includeNL) Removes all html/xml tags and entities, keeping br tags as line breaks
static java.lang.String	removeScripts(java.lang.String value) Removes all <script> tags from the given string
static java.lang.String	removeStart(java.lang.String string, java.lang.String start) Removes the start of the given string, or returns the original string if end is null or not the initial part of the string removeStart(null, *) == null removeStart(x, *) == x removeStart("car", "ca") == "r" removeStart("car", "c") == "ar" removeStart("car", "x") == "car"
static java.lang.String	repeat(java.lang.String string, int times) Repeats the given string the given number of times
static java.lang.String	replace(java.lang.String text, java.lang.String repl, java.lang.String with) Replaces all occurrences of the source text with the destination text in the given string
static java.lang.String	replace(java.lang.String text, java.lang.String repl, java.lang.String with, int max) Replaces a specified number of occurrences (-1 means unlimited) of the source text with the destination text in the given string
static java.lang.String	replaceVariables(java.lang.String template, java.util.Map<java.lang.String,java.lang.String> variables) Replaces variables in the form {varname} with the ones in the map.
static void	shuffle(java.lang.StringBuilder sb, java.util.Random rnd) Shuffles the characters of the given string builder
static java.util.List<java.lang.String>	split(java.lang.String input, java.lang.String separator) Splits a string into an array according to the char specified as separator.
static java.util.List<java.lang.String>	splitTrimming(java.lang.String input, java.lang.String separator) Like split(String, String), but each part is trimmed, and not used if empty
static java.lang.String	transformCase(java.lang.String string, boolean toUpperCase, char separator) Transforms the given string into upper or lower case, adding the given separator between words.
static java.lang.String	trim(java.lang.Object value) Use the object's toString() method, trimming the result and returning the string.
static java.lang.String	trimToNull(java.lang.Object value) Same as trim(Object), but returning null instead of empty strings
static java.lang.String	truncate(java.lang.String string, int maxLength) Truncates the given string without cutting words in the middle, and appending ellipsis in the end.
static java.lang.String	truncateLines(java.lang.String string, int maxLines, int maxLengthPerLine) Truncates the given string to a maximum of lines, making each line have a maximum of characters.
static java.lang.String	unaccent(java.lang.String string) Replaces any accented characters by the nearest unaccented character, returning null if the input is null.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBERS

public static final java.lang.String NUMBERS

See Also:

Constant Field Values

UPPERCASE_LETTERS

public static final java.lang.String UPPERCASE_LETTERS

See Also:

Constant Field Values

LOWERCASE_LETTERS

public static final java.lang.String LOWERCASE_LETTERS

SPECIAL_CHARACTERS

public static final java.lang.String SPECIAL_CHARACTERS

See Also:

Constant Field Values

HTML_ENTITIES_REMOVER

public static java.util.function.Function<java.lang.String,java.lang.String> HTML_ENTITIES_REMOVER

Constructor Detail

StringHelper

public StringHelper()

Method Detail

asciiOnly

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

Removes from the given string all non-ASCII characters, returning null if the input is null

camelize

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

Transforms the given string into camel case. Examples:

• camelize(null) == null
• camelize("") == ""
• camelize("MY_NAME") == "myName"
• camelize("MyName") == "myname"

capitalize

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

Returns a string where the first letter is uppercase and all others are lowercase

capitalizeAndCamelize

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

capitalizeFirst

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

Transforms the first character of the given string to uppercase, handling nulls / empty strings

convertNewLineToBr

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

defaultValue

public static java.lang.String defaultValue(java.lang.String string,
                                            java.lang.String defaultValue)

Returns the value of the second string if the first is blank. Otherwise, returns the first

See Also:

isBlank(Object)

delimit

public static java.lang.String delimit(java.lang.String text,
                                       java.lang.String delimiter,
                                       int delimitSize)

Transforms the given text adding a delimiter every time delimit size is reached.
Example:

• delimit("helloworld", ";", 2) == "he;ll;ow;or;ld"

emptyIfNull

public static java.lang.String emptyIfNull(java.lang.String s)

Returns an empty string ("") when the parameter value is null. Otherwise, returns the parameter value.

forEachLine

public static void forEachLine(java.lang.String string,
                               boolean supportsComments,
                               java.util.function.Consumer<java.lang.String> consumer)

Calls the given procedure for each non-empty untils the last line, trimmed line of the given string. If supportsComments is true, lines starting with # are ignored

forEachLine

public static void forEachLine(java.lang.String string,
                               boolean supportsComments,
                               java.util.function.Predicate<java.lang.String> predicate)

Calls the given function for each non-empty while it return true, trimmed line of the given string. If supportsComments is true, lines starting with # are ignored

formatNumber

public static java.lang.String formatNumber(java.lang.String mask,
                                            java.lang.String number,
                                            boolean padLeftWithZeros)

Replaces the sharps in the mask by the digits found in the number. If padLeftWithZeros is true, replaces the extra front sharps with zeros.

getNumberGenerationPattern

public static java.lang.String getNumberGenerationPattern(java.lang.String prefix,
                                                          java.lang.Integer padLength,
                                                          java.lang.String suffix)

Returns a pattern which may be used to filter user input based on a transaction number pattern

htmlSpace

public static java.lang.String htmlSpace()

Returns the String representing an HTML space

htmlSpaces

public static java.lang.String htmlSpaces(int count)

Returns the String representing n HTML spaces

indexOf

public static int indexOf(java.lang.String[] array,
                          java.lang.String stringToSearch)

It returns the index of the first occurrence of the string in the array. Otherwise it returns -1. Null strings are supported and the index of the first null element in the array is returned (if any).

isBlank

public static boolean isBlank(java.lang.Object object)

Use the object's toString() method and checks whether it is null, empty or blank string (spaces only)

isEquals

public static boolean isEquals(java.lang.String value1,
                               java.lang.String value2)

Returns true value1 is equals to value2 or both are empty

isNotBlank

public static boolean isNotBlank(java.lang.Object object)

Equivalent to the negation of isBlank(Object)

isNumeric

public static boolean isNumeric(java.lang.String results)

Returns true if the given string is not null and composed of numbers only

join

public static java.lang.String join(java.util.Collection<?> parts,
                                    java.lang.String delimiter)

Join the array of strings with the given delimiter

join

public static java.lang.String join(java.lang.Object[] parts,
                                    java.lang.String delimiter)

Join the array of strings with the given delimiter

joinTrimming

public static java.lang.String joinTrimming(java.util.Collection<?> parts,
                                            java.lang.String delimiter)

Like join(Collection, String), but each part is trimmed, and not used if empty

leftPad

public static java.lang.String leftPad(java.lang.String input,
                                       int size,
                                       char padChar)

Left pad the specified input String until the specific pad size with the specified char.
If input is null then it returns null.

lowercaseFirst

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

Sets the first character as lower case. Examples:

• lowercaseFirst(null) == null
• lowercaseFirst("") == ""
• lowercaseFirst("MY_NAME") == "mY_NAME"
• lowercaseFirst("MyName") == "myName"

removeEnd

public static java.lang.String removeEnd(java.lang.String string,
                                         java.lang.String end)

Removes the end of the given string, or returns the original string if end is null or not the final part of the string

• removeEnd(null, *) == null
• removeEnd(x, *) == x
• removeEnd("car", "ar") == "c"
• removeEnd("car", "r") == "ca"
• removeEnd("car", "x") == "car"

removeHtmlEntities

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

Removes the HTML entities, replacing them by actual characters. Is not compatible with GWT. For a GWT implementation, use HtmlEntities.decode.

removeMarkupTags

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

Removes all html/xml tags, keeping br tags as line breaks

removeMarkupTags

public static java.lang.String removeMarkupTags(java.lang.String string,
                                                boolean includeNL)

Removes all html/xml tags and entities, keeping br tags as line breaks

removeScripts

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

Removes all <script> tags from the given string

removeStart

public static java.lang.String removeStart(java.lang.String string,
                                           java.lang.String start)

Removes the start of the given string, or returns the original string if end is null or not the initial part of the string

• removeStart(null, *) == null
• removeStart(x, *) == x
• removeStart("car", "ca") == "r"
• removeStart("car", "c") == "ar"
• removeStart("car", "x") == "car"

repeat

public static java.lang.String repeat(java.lang.String string,
                                      int times)

Repeats the given string the given number of times

replace

public static java.lang.String replace(java.lang.String text,
                                       java.lang.String repl,
                                       java.lang.String with)

Replaces all occurrences of the source text with the destination text in the given string

replace

public static java.lang.String replace(java.lang.String text,
                                       java.lang.String repl,
                                       java.lang.String with,
                                       int max)

Replaces a specified number of occurrences (-1 means unlimited) of the source text with the destination text in the given string

replaceVariables

public static java.lang.String replaceVariables(java.lang.String template,
                                                java.util.Map<java.lang.String,java.lang.String> variables)

Replaces variables in the form {varname} with the ones in the map. If a variable is not present on the map, it is replaced with an empty string

shuffle

public static void shuffle(java.lang.StringBuilder sb,
                           java.util.Random rnd)

Shuffles the characters of the given string builder

split

public static java.util.List<java.lang.String> split(java.lang.String input,
                                                     java.lang.String separator)

Splits a string into an array according to the char specified as separator.

Parameters:

input - the string to split. If it's null/empty then the return is a null/empty array whichever is applicable.

splitTrimming

public static java.util.List<java.lang.String> splitTrimming(java.lang.String input,
                                                             java.lang.String separator)

Like split(String, String), but each part is trimmed, and not used if empty

transformCase

public static java.lang.String transformCase(java.lang.String string,
                                             boolean toUpperCase,
                                             char separator)

Transforms the given string into upper or lower case, adding the given separator between words. Examples:

• transformCase(null, *, *) == null
• transformCase("", *, *) == ""
• transformCase("myName", true, '_') == "MY_NAME"
• transformCase("MyName", true, '_') == "MY_NAME"
• transformCase("MyNAME", true, '_') == "MY_N_A_M_E"
• transformCase("myName", false, '-') == "my-name"
• transformCase("MyName", false, '-') == "my-name"
• transformCase("MyNAME", false, '-') == "my-n-a-m-e"

trim

public static java.lang.String trim(java.lang.Object value)

Use the object's toString() method, trimming the result and returning the string. Never returns null values

trimToNull

public static java.lang.String trimToNull(java.lang.Object value)

Same as trim(Object), but returning null instead of empty strings

truncate

public static java.lang.String truncate(java.lang.String string,
                                        int maxLength)

Truncates the given string without cutting words in the middle, and appending ellipsis in the end. Line breaks are transformed in spaces.

truncateLines

public static java.lang.String truncateLines(java.lang.String string,
                                             int maxLines,
                                             int maxLengthPerLine)

Truncates the given string to a maximum of lines, making each line have a maximum of characters. Empty lines are ignored.

unaccent

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

Replaces any accented characters by the nearest unaccented character, returning null if the input is null. For example, áèïôçñ resuçts in aeiocn