atg.core.util

Class StringUtils

java.lang.Object

atg.core.util.StringUtils

public class StringUtils
extends java.lang.Object

This class contains static methods for performing various operations on Strings. For example, this class has methods for counting the number of occurrences of a particular character in a String, and methods for splitting a String into elements that were separated by a specific character.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.

Constructor Summary

Constructors

Constructor and Description
StringUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	alphaNumericOnly(java.lang.String pStr) Returns a string with all characters not in the following ranges removed: (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z').
static java.lang.String	alphaNumOnly(java.lang.String iString) Returns a string with only alphanumeric characters.
static boolean	arrayEquals(java.lang.String[] a, java.lang.String[] b) Return true if two arrays of strings contain the same contents.
static boolean	arrayEqualsIgnoreCase(java.lang.String[] a, java.lang.String[] b) Return true if two arrays of strings contain the same contents, ignoring case.
static java.lang.String	convertStringFromPropertiesFileFormat(java.lang.String in) Converts encoded \uxxxx to unicode chars and changes special saved.
static java.lang.String	convertStringToPropertiesFileFormat(java.lang.String theString, boolean escapeSpace, boolean escapeUnicode) Converts unicodes to encoded \uxxxx and escapes special characters with a preceding slash.
static java.lang.String	decodeFromJavaString(java.lang.String pJavaString, boolean pDecodeUnicode) This decodes a "Java" String, which is a String (complete with enclosing quotation marks) containing java escape characters.
static java.lang.String	encodeToJavaString(java.lang.String pString) Encodes the specified String to a Java string - all non-printable characters are escaped, and the resulting string is enclosed in quotation marks.
static java.lang.String	escapeHtmlString(java.lang.String pStr) Returns a string that is properly escaped for use either as an HTML attribute value or an HTML content section.
static java.lang.String	escapeHtmlString(java.lang.String pStr, boolean pEscapeAmp) Returns a string that is properly escaped for use either as an HTML attribute value or an HTML content section.
static java.lang.String	expandEntries(java.lang.String pValue, java.util.Map pMap) Expand any instances of "{key}" in with the corresponding value from pMap.
static java.lang.String	expandEntries(java.lang.String pValue, java.util.Map pMap, java.lang.String pOpen, java.lang.String pClose) Expand any instances of "{key}" (where pOpen is "{" and pClose is "}") with the corresponding value from pMap.
static java.lang.String	extractString(java.lang.String pStr) Return pStr if incoming value is not null, or return empty string otherwise.
static java.lang.String	extractString(java.lang.String pStr, java.lang.String pDefault) Return pStr if incoming value is not null, or return pDefault otherwise.
static java.lang.String	extractStringIfBlank(java.lang.String pStr, java.lang.String pDefault) Return pStr if incoming value is not blank, or return pDefault otherwise.
static java.lang.String	extractStringIfEmpty(java.lang.String pStr, java.lang.String pDefault) Return pStr if incoming value is not empty, or return pDefault otherwise.
static boolean	isAlphaNumOnly(java.lang.String iString) Test for a string with only alphanumeric characters, spaces, -, and _.
static boolean	isAlphaNumOnlyNoDash(java.lang.String iString) Test for a string with only alphanumeric characters.
static boolean	isBlank(java.lang.String pStr) Return true if pStr is null, the empty string, or consists entirely of whitespace where whitespace is defined by the String.trim method.
static boolean	isEmpty(java.lang.String pStr) Return true if pStr is null or has length zero.
static boolean	isNotBlank(java.lang.String pStr) Return true if pStr is not null, not empty string, or does not consist entirely of whitespace where whitespace is defined by the String.trim method.
static boolean	isNotEmpty(java.lang.String pStr) Return true if pStr is not a null or zero length String.
static boolean	isNumericOnly(java.lang.String iString) Test for a string with only numeric characters.
static java.lang.String[]	join(java.lang.String[] pFirst, java.lang.String[] pSecond) Joins two string arrays together to form a new string array.
static java.lang.String	joinStrings(java.lang.String[] pStrings, char pSeparator) Join the specified string with the specified separator.
static java.lang.String	joinStringsWithNonRepeatingSeparator(java.lang.String[] pStrings, char pSeparator, boolean pLeadingSeparator, boolean pTrailingSeparator) Join the specified strings with the specified separator but do not repeat the separator.
static java.lang.String	joinStringsWithQuoting(java.lang.String[] pStrings, char pSeparator) Join the specified string with the specified separator.
static java.lang.String	literalizeForRegex(java.lang.String pString) Attempt to literalize a string for use with java.util.regex.
static java.lang.String	makeList(java.util.Enumeration pElements, java.lang.String pSeparator) Format elements of an enumeration into a string, separating items with a specified separator string.
static java.lang.String	makeList(java.util.Enumeration pElements, java.lang.String pFormat, java.lang.String pSeparator) Format elements of an enumeration into a string, formatting each item according to a template and separating items with a specified separator string.
static java.lang.StringBuffer	makeList(java.util.Enumeration pElements, java.lang.String pSeparator, java.lang.StringBuffer pResult) Append elements of an enumeration to a string buffer, separating items with a specified separator string.
static java.lang.StringBuilder	makeList(java.util.Enumeration pElements, java.lang.String pSeparator, java.lang.StringBuilder pResult) Takes an enumeration of elements and adds their toString result to a String.
static java.lang.StringBuffer	makeList(java.util.Enumeration pElements, java.lang.String pFormat, java.lang.String pSeparator, java.lang.StringBuffer pResult) Append elements of an enumeration to a string buffer, formatting each item according to a template and separating items with a specified separator string.
static java.lang.StringBuilder	makeList(java.util.Enumeration pElements, java.lang.String pFormat, java.lang.String pSeparator, java.lang.StringBuilder pResult) Format elements of an enumeration into a string, formatting each item according to a template and separating items with a specified separator string.
static java.lang.String	makeList(java.lang.Object[] pElements, java.lang.String pSeparator) Format elements of an array into a string, separating items with a specified separator string.
static java.lang.String	makeList(java.lang.Object[] pElements, java.lang.String pFormat, java.lang.String pSeparator) Format elements of an array into a string, formatting each item according to a template and separating items with a specified separator string.
static java.lang.StringBuffer	makeList(java.lang.Object[] pElements, java.lang.String pSeparator, java.lang.StringBuffer pResult) Append elements of an array to a string buffer, separating items with a specified separator string.
static java.lang.StringBuilder	makeList(java.lang.Object[] pElements, java.lang.String pSeparator, java.lang.StringBuilder pResult) Append elements of an array to a string builder, separating items with a specified separator string.
static java.lang.StringBuffer	makeList(java.lang.Object[] pElements, java.lang.String pFormat, java.lang.String pSeparator, java.lang.StringBuffer pResult) Append elements of an array to a string buffer, formatting each item according to a template and separating items with a specified separator string.
static java.lang.StringBuilder	makeList(java.lang.Object[] pElements, java.lang.String pFormat, java.lang.String pSeparator, java.lang.StringBuilder pResult) Append elements of an array to a string builder, formatting each item according to a template and separating items with a specified separator string.
static java.lang.String	normalizeWhitespace(java.lang.String s) Converts newlines, tabs, and carriage returns to spaces and then removes repetitive spaces.
static int	numOccurrences(java.lang.String pString, char pDelimiter) Returns the number of times the specified character appears in the specified String.
static int	numOccurrences(java.lang.String pString, char pDelimiter, char pEscape) Returns the number of times the specified character appears in the specified String.
static int	numOccurrences(java.lang.String pString, java.lang.String pDelimiter) Returns the number of times the specified character appears in the specified String.
static java.lang.String	or(java.lang.String... pStrings) Return the first non-null string, or null.
static java.lang.String	removeCharacters(java.lang.String iString, java.lang.String iFilter) Creates a new string with any characters in iFilter removed.
static java.lang.String	removeConsecutiveStrings(java.lang.String pString, char pToRemove) Removes any consecutive slashes from the given string e.g.
static java.lang.String	removeConsecutiveStrings(java.lang.String pString, java.lang.String pToRemove) Removes any consecutive slashes from the given string e.g.
static java.lang.String	removeCRLF(java.lang.String iString) Creates a new string and remove Carriage Return & Line Feed characters.
static java.lang.String	removeExtension(java.lang.String pSrc) Return a string with the trailing extension removed.
static java.lang.String	removeWhiteSpace(java.lang.String iString) Creates a new string with any whitespace removed.
static java.lang.String	replace(java.lang.String pSrc, char pFrom, java.lang.String pTo) Returns a copy of the src string where all occurrences of pFrom are replaced by copies of pTo.
static java.lang.String	replace(java.lang.String pSrc, java.lang.String pFrom, java.lang.String pTo) Returns a copy of the src string where all occurrences of pFrom are replaced by copies of pTo.
static java.lang.String	replaceCharacters(java.lang.String pString, char[] pReplacements) Replaces individual characters in a string.
static java.lang.String	replaceSubstrings(java.lang.String pString, java.lang.String[] pReplacements) Replaces substrings of a string.
static java.lang.String[]	splitStringAtCharacter(java.lang.String pString, char pDelimiter) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character.
static java.lang.String[]	splitStringAtCharacter(java.lang.String pString, char pDelimiter, char pEscape) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character.
static int	splitStringAtCharacter(java.lang.String pString, char pDelimiter, char pEscape, java.lang.String[] pStrings, int pStart) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character.
static int	splitStringAtCharacter(java.lang.String pString, char pDelimiter, java.lang.String[] pStrings, int pStart) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character.
static java.lang.String[]	splitStringAtCharacterWithQuoting(java.lang.String pString, char pDelimiter) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character, but which treat double occurrences of the character as a quote of that character.
static int	splitStringAtCharacterWithQuoting(java.lang.String pString, char pDelimiter, java.lang.String[] pStrings, int pStart) Splits the specified String containing the specified character into individual Strings that were delimited by the specified character, but which treat double occurrences of the character as a quote of that character.
static java.lang.String[]	splitStringAtString(java.lang.String pString, java.lang.String pDelimiter) Splits the specified String containing the specified substring into individual Strings that were delimited by the specified substring.
static int	splitStringAtString(java.lang.String pString, java.lang.String pDelimiter, java.lang.String[] pStrings, int pStart) Splits the specified String containing the specified substring into individual Strings that were delimited by the specified substring.
static java.util.Vector	tokenizer(java.lang.String pSrc, java.lang.String pToken) Returns a Vector of the tokenized source.
static java.lang.String	toLowerCase(java.lang.String pSrc) This is a faster version of the toLowerCase method that only works in the english locale.
static java.lang.String	toUpperCase(java.lang.String pSrc) This is a faster version of the toUpperCase method that only works in the english locale.
static java.lang.String	trimToNull(java.lang.String pString) Return the result of trimming pString, if pString is not null or empty.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

Constructor Detail

StringUtils

public StringUtils()

Method Detail

numOccurrences

public static int numOccurrences(java.lang.String pString,
                 char pDelimiter)

Returns the number of times the specified character appears in the specified String. The String must be non-null.

Parameters:

pString - The string to check for the character.

pDelimiter - The character being searched for.

Returns:

The number of times the specified character occurs.

numOccurrences

public static int numOccurrences(java.lang.String pString,
                 java.lang.String pDelimiter)

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

Parameters:

pString - The string to check for the character.

pDelimiter - The character being searched for.

Returns:

The number of times the specified character occurs.

numOccurrences

public static int numOccurrences(java.lang.String pString,
                 char pDelimiter,
                 char pEscape)

Returns the number of times the specified character appears in the specified String. This ignores the pattern where escape character is followed by the delimiter. Note that the escape character does not have effect on characters other than the delimiter. Examples for delimiter character ',' and escape character '\'

String	Number of occurrences
""	0
"2.5,1\,000,10\0,ab\\c"	3
"a,,b,c"	3
"a,"	1
",a"	1
"a,,"	2
","	1
"\"	0
"\\"	0
"\,"	0
"\\,"	1
"\\\"	0
"\\\,"	0
",\\\"	1

Parameters:

pString - The string to check for the character.

pDelimiter - The character being searched for.

pEscape - The escape character.

Returns:

The number of times the specified character occurs.

See Also:

for more details

splitStringAtCharacter

public static int splitStringAtCharacter(java.lang.String pString,
                         char pDelimiter,
                         java.lang.String[] pStrings,
                         int pStart)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character. For example, the String "atg.core.util" split at '.' would be split into "atg", "core", and "util".

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

pStrings - the String array into which the individual Strings will be written. If there are more Strings than will fit into this array, then only the first Strings that fit will be put into this array.

pStart - the starting index into the array where the first String should go

Returns:

the number of Strings, or the length of the pStrings array, whichever is smaller.

splitStringAtCharacter

public static int splitStringAtCharacter(java.lang.String pString,
                         char pDelimiter,
                         char pEscape,
                         java.lang.String[] pStrings,
                         int pStart)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character. In order to include the delimiter character as part of one of the strings, it can be escaped using the escape character. Note that the escape character only escapes the delimiter and does not have any special effect on other characters. Examples for delimiter character ',' and escape character '\'

String	Number of split strings	Result
""	0	empty array
"2.5,1\,000,10\0,ab\\c"	4	"2.5", "1,000", "10\0" and "ab\\c"
"a,,b,c"	4	"a", "", "b" and "c"
"a,"	1	"a"
",a"	2	"" and "a"
"a,,"	2	"a" and ""
","	1	""
"\"	1	"\"
"\\"	1	"\\"
"\,"	1	","
"\\,"	1	"\,"
"\\\,"	1	"\\,"
"\\\"	1	"\\\"
",\\\"	2	"" and "\\\"

Please note this method would split the string even if the delimiter is part of the quoted sub-string.

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

pEscape - the escape character that includes the character following it.

pStrings - the String array into which the individual Strings will be written. If there are more Strings than will fit into this array, then only the first Strings that fit will be put into this array.

pStart - the starting index into the array where the first String should go

Returns:

the number of Strings copied

splitStringAtString

public static int splitStringAtString(java.lang.String pString,
                      java.lang.String pDelimiter,
                      java.lang.String[] pStrings,
                      int pStart)

Splits the specified String containing the specified substring into individual Strings that were delimited by the specified substring. For example, the String "atg.core.util" split at '.' would be split into "atg", "core", and "util".

Parameters:

pString - the String to be split

pDelimiter - the String delimiting the individual Strings

pStrings - the String array into which the individual Strings will be written. If there are more Strings than will fit into this array, then only the first Strings that fit will be put into this array.

pStart - the starting index into the array where the first String should go

Returns:

the number of Strings, or the length of the pStrings array, whichever is smaller.

splitStringAtCharacter

public static java.lang.String[] splitStringAtCharacter(java.lang.String pString,
                                        char pDelimiter)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character. For example, the String "atg.core.util" split at '.' would be split into "atg", "core", and "util".

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

Returns:

an array of the Strings

splitStringAtCharacter

public static java.lang.String[] splitStringAtCharacter(java.lang.String pString,
                                        char pDelimiter,
                                        char pEscape)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character. For example, the String "atg.core.util" split at '.' would be split into "atg", "core", and "util". When it encounters the pattern 'escape character is followed by the delimiter' it replaces it with the delimiter and considers it part of the split string.

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

pEscape - the escape character.

Returns:

an array of the Strings

splitStringAtString

public static java.lang.String[] splitStringAtString(java.lang.String pString,
                                     java.lang.String pDelimiter)

Splits the specified String containing the specified substring into individual Strings that were delimited by the specified substring. For example, the String "atg.core.util" split at '.' would be split into "atg", "core", and "util".

Parameters:

pString - the String to be split

pDelimiter - the String delimiting the individual Strings

Returns:

an array of the Strings

splitStringAtCharacterWithQuoting

public static int splitStringAtCharacterWithQuoting(java.lang.String pString,
                                    char pDelimiter,
                                    java.lang.String[] pStrings,
                                    int pStart)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character, but which treat double occurrences of the character as a quote of that character.

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

pStrings - the String array into which the individual Strings will be written. If there are more Strings than will fit into this array, then only the first Strings that fit will be put into this array.

pStart - the starting index into the array where the first String should go

Returns:

the number of Strings, or the length of the pStrings array, whichever is smaller.

splitStringAtCharacterWithQuoting

public static java.lang.String[] splitStringAtCharacterWithQuoting(java.lang.String pString,
                                                   char pDelimiter)

Splits the specified String containing the specified character into individual Strings that were delimited by the specified character, but which treat double occurrences of the character as a quote of that character.

Parameters:

pString - the String to be split

pDelimiter - the character delimiting the individual Strings

Returns:

an array of the Strings

replace

public static java.lang.String replace(java.lang.String pSrc,
                       char pFrom,
                       java.lang.String pTo)

Returns a copy of the src string where all occurrences of pFrom are replaced by copies of pTo. pTo can be an empty string like "" and pFrom will just be removed. If pSrc does not have pFrom in it at all, pSrc will be returned.

Parameters:

pSrc - the source string

pFrom - the character to be replaced

pTo - the string to substitute

Returns:

the result string

replace

public static java.lang.String replace(java.lang.String pSrc,
                       java.lang.String pFrom,
                       java.lang.String pTo)

Returns a copy of the src string where all occurrences of pFrom are replaced by copies of pTo. Handles the case where pFrom has a copy of pTo. If pFrom is empty, pSrc is returned. pTo can be an empty string like "" and pFrom will just be removed. If pSrc does not have pFrom in it at all, pSrc will be returned.

Parameters:

pSrc - the source string

pFrom - the string to be replaced

pTo - the string to substitute

Returns:

the result string

toUpperCase

public static java.lang.String toUpperCase(java.lang.String pSrc)

This is a faster version of the toUpperCase method that only works in the english locale. It does not copy the string if the string is already upper case. The toUpperCase in JDK1.1.1 is 6 times slower if no conversion is necessary and 3 times slower if conversion is necessary.

Parameters:

pSrc - the string to turn into upper case

Returns:

the upper case string. if pSrc does not have any lower case characters, pSrc will be returned.

toLowerCase

public static java.lang.String toLowerCase(java.lang.String pSrc)

This is a faster version of the toLowerCase method that only works in the english locale. It does not copy the string if the string is already lower case.

Parameters:

pSrc - the string to turn into upper case

Returns:

the upper case string. if pSrc does not have any lower case characters, pSrc will be returned.

arrayEquals

public static boolean arrayEquals(java.lang.String[] a,
                  java.lang.String[] b)

Return true if two arrays of strings contain the same contents.

Parameters:

a - The first array.

b - The second array.

Returns:

true if the array contents are equal.

arrayEqualsIgnoreCase

public static boolean arrayEqualsIgnoreCase(java.lang.String[] a,
                            java.lang.String[] b)

Return true if two arrays of strings contain the same contents, ignoring case.

Parameters:

a - The first array.

b - The second array.

Returns:

true if the array contents are equal.

removeCharacters

public static java.lang.String removeCharacters(java.lang.String iString,
                                java.lang.String iFilter)

Creates a new string with any characters in iFilter removed.

Parameters:

iString - The string to to have characters removed from.

iFilter - The characters to remove from the string.

Returns:

A new string with any characters in iFilter removed

removeWhiteSpace

public static java.lang.String removeWhiteSpace(java.lang.String iString)

Creates a new string with any whitespace removed.

Parameters:

iString - The string to have whitespace removed from.

Returns:

A new string with any whitespace removed

removeCRLF

public static java.lang.String removeCRLF(java.lang.String iString)

Creates a new string and remove Carriage Return & Line Feed characters.

Parameters:

iString - The string to have Carriage Return & Line Feed characters removed.

Returns:

The new string with Carriage Return & Line Feed characters removed.

alphaNumOnly

public static java.lang.String alphaNumOnly(java.lang.String iString)

Returns a string with only alphanumeric characters. ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || ( c >= '0' && c <= '9' ) || (c == '_' || c == '-' || c == ' ')

Parameters:

iString - The string to remove non-alphanumeric characters from.

Returns:

The new string with the non-alphanumeric characters removed.

alphaNumericOnly

public static java.lang.String alphaNumericOnly(java.lang.String pStr)

Returns a string with all characters not in the following ranges removed: (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z'). NOTE: This differs from alphaNumOnly which is designed to retain '_', '-' and ' ' characters also.

Parameters:

pStr - The string to process

Returns:

The string only containing alphabetical and numerical characters.

isAlphaNumOnly

public static boolean isAlphaNumOnly(java.lang.String iString)

Test for a string with only alphanumeric characters, spaces, -, and _. ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || ( c >= '0' && c <= '9' )|| (c == '_' || c == '-' || c == ' ')

Parameters:

iString - The string being checked.

Returns:

false if the string has special chars

isAlphaNumOnlyNoDash

public static boolean isAlphaNumOnlyNoDash(java.lang.String iString)

Test for a string with only alphanumeric characters. ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || ( c >= '0' && c <= '9' )

Parameters:

iString - The string being checked.

Returns:

true if it is only alphanum

isNumericOnly

public static boolean isNumericOnly(java.lang.String iString)

Test for a string with only numeric characters. ( c >= '0' && c <= '9' )

Parameters:

iString - The String being checked

Returns:

true if it is only numeric

replaceSubstrings

public static java.lang.String replaceSubstrings(java.lang.String pString,
                                 java.lang.String[] pReplacements)

Replaces substrings of a string.

Parameters:

pString - The input string on which to do replacement.

pReplacements - An array of strings; the 0th element is the first text to replace, the 1st element is the text to replace it with, the 2nd element is the second text to replace, the 3rd element is the text to replace that with, and so on.

Returns:

A new string, which is a copy of the input string with the requested replacements performed on it.

replaceCharacters

public static java.lang.String replaceCharacters(java.lang.String pString,
                                 char[] pReplacements)

Replaces individual characters in a string.

Parameters:

pString - The input string on which to do replacement.

pReplacements - An array of chars; the 0th element is the first character to replace, the 1st element is the character to replace it with, the 2nd element is the second character to replace, the 3rd element is the character to replace that with, and so on.

Returns:

A new string, which is a copy of the input string with the requested replacements performed on it.

tokenizer

public static java.util.Vector tokenizer(java.lang.String pSrc,
                         java.lang.String pToken)

Returns a Vector of the tokenized source.

Parameters:

pSrc - the String to tokenize

pToken - the String to use as the token

Returns:

a Vector of the comma deliminated items

removeExtension

public static java.lang.String removeExtension(java.lang.String pSrc)

Return a string with the trailing extension removed. E.g. removes the trailing ".txt" from "file.txt" to give "file"

Parameters:

pSrc - The string to have its extension removed.

Returns:

The new string with the extension removed.

makeList

public static java.lang.String makeList(java.util.Enumeration pElements,
                        java.lang.String pSeparator)

Format elements of an enumeration into a string, separating items with a specified separator string.

Parameters:

pElements - An enumeration whose elements are to be printed, one at a time. Each element is converted to a string by calling its toString method.

pSeparator - The string used to separate adjacent items in the list, for example ","

Returns:

A string of the form item1, item2, item3

makeList

public static java.lang.StringBuffer makeList(java.util.Enumeration pElements,
                              java.lang.String pSeparator,
                              java.lang.StringBuffer pResult)

Append elements of an enumeration to a string buffer, separating items with a specified separator string.

Parameters:

pElements - An enumeration whose elements are to be printed, one at a time. Each element is converted to a string by calling its toString method.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuffer used to hold the result of the formatting operation.

Returns:

pResult, which will have a string of the form item1, item2, item3 appended to it

makeList

public static java.lang.StringBuilder makeList(java.util.Enumeration pElements,
                               java.lang.String pSeparator,
                               java.lang.StringBuilder pResult)

Takes an enumeration of elements and adds their toString result to a String.

Parameters:

pElements - The enumeration of elements.

pSeparator - The separator added between the elements in the string.

pResult - The converted elements are added to this StringBuilder

Returns:

The updated StringBuilder passed in with pResult is also returned from the method.

makeList

public static java.lang.String makeList(java.util.Enumeration pElements,
                        java.lang.String pFormat,
                        java.lang.String pSeparator)

Format elements of an enumeration into a string, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An enumeration whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the enumeration. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

makeList

public static java.lang.StringBuffer makeList(java.util.Enumeration pElements,
                              java.lang.String pFormat,
                              java.lang.String pSeparator,
                              java.lang.StringBuffer pResult)

Append elements of an enumeration to a string buffer, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An enumeration whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the enumeration. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuffer used to hold the result of the formatting operation.

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

makeList

public static java.lang.StringBuilder makeList(java.util.Enumeration pElements,
                               java.lang.String pFormat,
                               java.lang.String pSeparator,
                               java.lang.StringBuilder pResult)

Format elements of an enumeration into a string, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An enumeration whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the enumeration. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuilder used to hold the result of the formatting operation.

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

makeList

public static java.lang.String makeList(java.lang.Object[] pElements,
                        java.lang.String pSeparator)

Format elements of an array into a string, separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by calling its toString method.

pSeparator - The string used to separate adjacent items in the list, for example ","

Returns:

A string of the form item1, item2, item3

makeList

public static java.lang.StringBuffer makeList(java.lang.Object[] pElements,
                              java.lang.String pSeparator,
                              java.lang.StringBuffer pResult)

Append elements of an array to a string buffer, separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by calling its toString method.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuffer used to hold the result of the formatting operation.

Returns:

pResult, which will have a string of the form item1, item2, item3 appended to it

makeList

public static java.lang.StringBuilder makeList(java.lang.Object[] pElements,
                               java.lang.String pSeparator,
                               java.lang.StringBuilder pResult)

Append elements of an array to a string builder, separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by calling its toString method.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuilder used to hold the result of the formatting operation.

Returns:

pResult, which will have a string of the form item1, item2, item3 appended to it

makeList

public static java.lang.String makeList(java.lang.Object[] pElements,
                        java.lang.String pFormat,
                        java.lang.String pSeparator)

Format elements of an array into a string, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the array. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

makeList

public static java.lang.StringBuffer makeList(java.lang.Object[] pElements,
                              java.lang.String pFormat,
                              java.lang.String pSeparator,
                              java.lang.StringBuffer pResult)

Append elements of an array to a string buffer, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the array. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuffer used to hold the result of the formatting operation.

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

makeList

public static java.lang.StringBuilder makeList(java.lang.Object[] pElements,
                               java.lang.String pFormat,
                               java.lang.String pSeparator,
                               java.lang.StringBuilder pResult)

Append elements of an array to a string builder, formatting each item according to a template and separating items with a specified separator string.

Parameters:

pElements - An array whose elements are to be printed, one at a time. Each element is converted to a string by using an instance of java.text.MessageFormat with the specified format template.

pFormat - A formatting template to apply to each element of the array. The {0} placeholder will be replaced by the element currently being processed.

pSeparator - The string used to separate adjacent items in the list, for example ","

pResult - A StringBuilder used to hold the result of the formatting operation.

Returns:

A string of the form item1, item2, item3, where each item's appearance is determine by the format string in pFormat

normalizeWhitespace

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

Converts newlines, tabs, and carriage returns to spaces and then removes repetitive spaces.

Parameters:

s - The string to normalize.

Returns:

A normalized string.

literalizeForRegex

public static java.lang.String literalizeForRegex(java.lang.String pString)

Attempt to literalize a string for use with java.util.regex. The result of this method should, when passed to a Matcher, match the literal string.

Parameters:

pString - The string to literalize.

Returns:

The literalized string.

decodeFromJavaString

public static java.lang.String decodeFromJavaString(java.lang.String pJavaString,
                                    boolean pDecodeUnicode)

This decodes a "Java" String, which is a String (complete with enclosing quotation marks) containing java escape characters. The enclosing quotation marks are removed, and all escape characters are converted to their correct char representations. The pDecodeUnicode flag indicates if unicode escapes (i.e., "̯") should also be decoded. If false, unicode escapes will be ignored.

Parameters:

pJavaString - The string to be decoded.

pDecodeUnicode - True indicates that unicode escapes should be decoded.

Returns:

The decoded string

encodeToJavaString

public static java.lang.String encodeToJavaString(java.lang.String pString)

Encodes the specified String to a Java string - all non-printable characters are escaped, and the resulting string is enclosed in quotation marks.

Parameters:

pString - The string to encode

Returns:

The encoded string

isEmpty

public static boolean isEmpty(java.lang.String pStr)

Return true if pStr is null or has length zero.

Parameters:

pStr - The string to check for null or zero length.

Returns:

true if empty.

isNotEmpty

public static boolean isNotEmpty(java.lang.String pStr)

Return true if pStr is not a null or zero length String.

Parameters:

pStr - The string to check is not null or zero length

Returns:

true if String is not empty

isBlank

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

Return true if pStr is null, the empty string, or consists entirely of whitespace where whitespace is defined by the String.trim method.

Parameters:

pStr - The String to check is null, zero length or just whitespace.

Returns:

true is criteria matches.

See Also:

String

isNotBlank

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

Return true if pStr is not null, not empty string, or does not consist entirely of whitespace where whitespace is defined by the String.trim method.

Parameters:

pStr - The String to check is not null, zero length or just whitespace.

Returns:

true is criteria matches.

See Also:

String

trimToNull

public static java.lang.String trimToNull(java.lang.String pString)

Return the result of trimming pString, if pString is not null or empty. If pString is null or empty, return null.

Parameters:

pString - the source string.

Returns:

a the value of a trimmed, non-empty pString, or null.

extractString

public static java.lang.String extractString(java.lang.String pStr)

Return pStr if incoming value is not null, or return empty string otherwise. Useful for avoiding NPE when you don't know if a string is null and you want to perform operations on it.

Parameters:

pStr - The source string.

Returns:

The extracted string.

extractString

public static java.lang.String extractString(java.lang.String pStr,
                             java.lang.String pDefault)

Return pStr if incoming value is not null, or return pDefault otherwise. Useful for avoiding NPE when you don't know if a string is null and you want to perform operations on it.

Parameters:

pStr - The source string.

pDefault - The string to return if pStr is null.

Returns:

The extracted string.

extractStringIfEmpty

public static java.lang.String extractStringIfEmpty(java.lang.String pStr,
                                    java.lang.String pDefault)

Return pStr if incoming value is not empty, or return pDefault otherwise.

Parameters:

pStr - The source string

pDefault - The string to return if pStr is empty.

Returns:

The extracted string.

See Also:

isEmpty(String)

extractStringIfBlank

public static java.lang.String extractStringIfBlank(java.lang.String pStr,
                                    java.lang.String pDefault)

Return pStr if incoming value is not blank, or return pDefault otherwise.

Parameters:

pStr - The source string

pDefault - The string to return if pStr is blank.

Returns:

The extracted string.

See Also:

isBlank(String)

expandEntries

public static java.lang.String expandEntries(java.lang.String pValue,
                             java.util.Map pMap,
                             java.lang.String pOpen,
                             java.lang.String pClose)

Expand any instances of "{key}" (where pOpen is "{" and pClose is "}") with the corresponding value from pMap. If pMap does not contain a value with the specified key, then the empty string is substituted. For example, given a map containing: "foo"="bar" and "baz"="qux", and the string "my favorite {foo} makes good {baz} and better {quux}", the returned value would be "my favorite bar makes good qux and better ".

This method is not particularly efficient.

Parameters:

pValue - the string value containing curly brace map keys to be replaced.

pMap - the value map

pOpen - the opening string around the variable name. Typically "{" or "${"

pClose - the closing string around the variable name Typically "}".

Returns:

either the source string, if no opening/closing pairs were found, or a copy of the original string, with the "{key}" occurences replaced.

expandEntries

public static java.lang.String expandEntries(java.lang.String pValue,
                             java.util.Map pMap)

Expand any instances of "{key}" in with the corresponding value from pMap. If pMap does not contain a value with the specified key, then the empty string is substituted. For example, given a map containing: "foo"="bar" and "baz"="qux", and the string "my favorite {foo} makes good {baz} and better {quux}", the returned value would be "my favorite bar makes good qux and better ".

This method is not particularly efficient.

Parameters:

pValue - the source string

pMap - the value map.

Returns:

either the source string, if no "{" and "}" pairs were found, or a copy of the original string, with the "{key}" occurrences replaced.

joinStrings

public static java.lang.String joinStrings(java.lang.String[] pStrings,
                           char pSeparator)

Join the specified string with the specified separator.

Parameters:

pStrings - the strings to be joined

pSeparator - the character to use as a separator

Returns:

the joined string

joinStringsWithQuoting

public static java.lang.String joinStringsWithQuoting(java.lang.String[] pStrings,
                                      char pSeparator)

Join the specified string with the specified separator. Any other instances of pSeparator are doubled.

Parameters:

pStrings - the strings to be quoted

pSeparator - the character to use as a separator

Returns:

the joined string, with quoting.

joinStringsWithNonRepeatingSeparator

public static java.lang.String joinStringsWithNonRepeatingSeparator(java.lang.String[] pStrings,
                                                    char pSeparator,
                                                    boolean pLeadingSeparator,
                                                    boolean pTrailingSeparator)

Join the specified strings with the specified separator but do not repeat the separator. This is useful for concatenating file system paths or urls with the / separator when you don't know if the strings already include trailing or leading slash.

Parameters:

pStrings - the strings to be quoted

pSeparator - the character to use as a separator

pLeadingSeparator - whether the returned value should start with pSeparator

pTrailingSeparator - whether the returned value should end with pSeparator

Returns:

the joined string, with quoting.

escapeHtmlString

public static java.lang.String escapeHtmlString(java.lang.String pStr)

Returns a string that is properly escaped for use either as an HTML attribute value or an HTML content section.

The characters &, <, >, and " are all converted to &&, &<, &>, and &" respectively.

Parameters:

pStr - the string to be escaped

Returns:

the escaped string

escapeHtmlString

public static java.lang.String escapeHtmlString(java.lang.String pStr,
                                boolean pEscapeAmp)

Returns a string that is properly escaped for use either as an HTML attribute value or an HTML content section.

The characters &, <, >, and " are all converted to &&, &<, &>, and &" respectively.

Parameters:

pStr - the string to be escaped

pEscapeAmp - whether to escape ampersand

Returns:

the escaped string

convertStringToPropertiesFileFormat

public static java.lang.String convertStringToPropertiesFileFormat(java.lang.String theString,
                                                   boolean escapeSpace,
                                                   boolean escapeUnicode)

Converts unicodes to encoded \uxxxx and escapes special characters with a preceding slash.

Parameters:

theString - The string to encode

escapeSpace - Whether or not spaces should be escaped

escapeUnicode - Whether or not unicode characters should be escaped

Returns:

The encoded string

convertStringFromPropertiesFileFormat

public static java.lang.String convertStringFromPropertiesFileFormat(java.lang.String in)

Converts encoded \uxxxx to unicode chars and changes special saved. chars to their original forms

Parameters:

in - The string to convert

Returns:

The converted string

join

public static java.lang.String[] join(java.lang.String[] pFirst,
                      java.lang.String[] pSecond)

Joins two string arrays together to form a new string array. This method will always return a new array, even if the parameters are null.

Parameters:

pFirst - The first string array.

pSecond - The second string array.

Returns:

The two arrays joined together in a new array.

removeConsecutiveStrings

public static java.lang.String removeConsecutiveStrings(java.lang.String pString,
                                        char pToRemove)

Removes any consecutive slashes from the given string e.g. foo//bar becomes foo/bar

Parameters:

pString - the string to remove slashes from

pToRemove - The character to remove.

Returns:

a string without consecutive slashes

removeConsecutiveStrings

public static java.lang.String removeConsecutiveStrings(java.lang.String pString,
                                        java.lang.String pToRemove)

Removes any consecutive slashes from the given string e.g. foo//bar becomes foo/bar

Parameters:

pString - the string to remove slashes from

pToRemove - The string to remove.

Returns:

a string without consecutive slashes

or

public static java.lang.String or(java.lang.String... pStrings)

Return the first non-null string, or null.

Parameters:

pStrings - input streams.

Returns:

the first non-null string.