Package arcommon

Class StringUtil

java.lang.Object

arcommon.StringUtil

public final class StringUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringUtil.Fields
static class	StringUtil.STRING_WITH_FIX_LENGTH_ALIGN

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_REG_EXP_FLAGS
static java.lang.String	DEFAULT_WILDCARD_NOT_PREFIX
static java.lang.String	DEFAULT_WILDCARD_REG_EXP_PREFIX
static java.lang.String	DEFAULT_WILDCARD_SEPARATOR
static char[]	HEX
static int	patternCacheSize
static int	STRING_SPLIT_INCLUDING_TRAILING_EMPTY_STRINGS
static boolean	usePatternCache

Constructor Summary

Constructors

Constructor	Description
StringUtil()

Method Summary

Modifier and Type	Method	Description
static void	appendedField(java.lang.StringBuilder stringBuilder, boolean b)
static void	appendedField(java.lang.StringBuilder stringBuilder, int number)
static void	appendedField(java.lang.StringBuilder stringBuilder, long number)
static void	appendedField(java.lang.StringBuilder stringBuilder, java.lang.String string)
static void	appendedSeparator(java.lang.StringBuilder stringBuilder)
static int	bitStringToInt(java.lang.String bits)
static java.lang.String	byteToBitString(byte number)
static void	clearPatternCache()
static boolean	doesStringMatchMultiWildcard(java.lang.String string, java.lang.String wildcard, boolean caseSensitive)
static boolean	doesStringMatchMultiWildcard(java.lang.String string, java.lang.String wildcard, java.lang.String separator, java.lang.String notPrefix, java.lang.String regExpPrefix, boolean caseSensitive)
static boolean	doesStringMatchRegExp(java.lang.String string, java.lang.String regExp)	Returns true if the entire string matches regular expression in regExp.
static boolean	doesStringMatchRegExp(java.lang.String string, java.lang.String regExp, int flags)
static boolean	doesStringMatchWildcard(java.lang.String string, java.lang.String wildcard, boolean caseSensitive)
static java.lang.String	firstCharUpperCase(java.lang.String text)
static java.lang.String	getFirstGroupForRegExp(java.lang.String string, java.lang.String regExp)	Returns the result from calling getFirstGroupForRegExp(String, String, int) with DEFAULT_REG_EXP_FLAGS.
static java.lang.String	getFirstGroupForRegExp(java.lang.String string, java.lang.String regExp, int flags)	Returns the first group of the first match of the regular expression regExp in string using flags.
static java.lang.String	getFirstNamedGroupForRegExp(java.lang.String string, java.lang.String regExp, java.lang.String namedGroup)
static java.lang.String	getFirstNamedGroupForRegExp(java.lang.String string, java.lang.String regExp, java.lang.String namedGroup, int flags)
static java.lang.String[][]	getGroupsForRegExpAs2DimensionsArray(java.lang.String string, java.lang.String regExp)
static java.lang.String[][]	getGroupsForRegExpAs2DimensionsArray(java.lang.String string, java.lang.String regExp, int flags)
static java.lang.String[]	getGroupsForRegExpAsFlatArray(java.lang.String string, java.lang.String regExp)
static java.lang.String[]	getGroupsForRegExpAsFlatArray(java.lang.String string, java.lang.String regExp, int flags)
static java.lang.String[]	getGroupsForRegExpAsFlatArrayWithValidation(int expectedLength, java.lang.String string, java.lang.String regExp)
static java.lang.String[]	getGroupsForRegExpAsFlatArrayWithValidation(int expectedLength, java.lang.String string, java.lang.String regExp, int flags)
static java.util.regex.Matcher	getMatcherForRegExp(java.lang.String string, java.lang.String regExp)
static java.util.regex.Matcher	getMatcherForRegExp(java.lang.String string, java.lang.String regExp, int flags)
static java.lang.String[]	getMatchesForRegExp(java.lang.String string, java.lang.String regExp)
static java.lang.String[]	getMatchesForRegExp(java.lang.String string, java.lang.String regExp, int flags)
static java.util.Comparator<java.lang.String>	getNumericStringCompare()
static java.lang.String	indentLines(java.lang.String string, java.lang.String indent)
static int	indexOfFirstRegExpMatch(java.lang.String string, java.lang.String regExp)	Returns the index of the first occurrence of regExp in string.
static int	indexOfFirstRegExpMatch(java.lang.String string, java.lang.String regExp, int flags)
static int	indexOfOccurrence(java.lang.String baseString, java.lang.String search, int occurrenceNumber)
static java.lang.String	intToBitString(int number)
static java.lang.String	intToBitString(int number, int length)
static java.lang.String	intToStringWithThousands(int number)
static java.lang.String	intToStringWithThousands(long number)
static boolean	isStringADouble(java.lang.String text)
static boolean	isStringALong(java.lang.String text)
static boolean	isStringAnInt(java.lang.String text)
static java.lang.String	javaConstantDecodeString(java.lang.String s)
static void	javaConstantDecodeString(java.lang.StringBuilder stringBuilder, java.lang.String string)
static java.lang.String	javaConstantEncodeString(java.lang.String s)
static void	javaConstantEncodeString(java.lang.StringBuilder stringBuilder, java.lang.String string)
static void	javaConstantEncodeString(java.lang.StringBuilder stringBuilder, java.lang.String string, boolean forceAscii)
static java.lang.String	javaConstantEncodeString(java.lang.String s, boolean forceAscii)
static char	lastChar(java.lang.String string)
static java.lang.String	longToStringWithFixLength(long number, int length, char fillChar)
static java.lang.String	longToStringWithFixLengthWith0(long number, int length)
static java.lang.String	longToStringWithFixLengthWithSpace(long number, int length)
static java.lang.String	longToStringWithUnit(long number)
static java.lang.String	multiWildcardError(java.lang.String wildcard)
static java.lang.String	multiWildcardError(java.lang.String wildcard, java.lang.String separator, java.lang.String notPrefix, java.lang.String regExpPrefix)
static int	numberOfCharsInString(java.lang.String baseString, char searchChar)
static java.lang.String	onlyFirstLinesOf(java.lang.String string, int maximumNumberOfLines)
static java.lang.String	replace(java.lang.String base, java.lang.String from, java.lang.String to)
static java.lang.String	replace(java.lang.String base, java.lang.String from, java.lang.String to, boolean all)
static java.lang.String[]	splitStringAtComma(java.lang.String line, boolean safe)
static StringUtil.Fields	splitStringAtCommaAsFields(java.lang.String line)
static StringUtil.Fields	splitStringAtCommaAsFields(java.lang.String line, boolean safe)
static boolean	stringEquals(java.lang.String s1, java.lang.String s2)	Returns if s1 and s2 are equal in any combination of null.
static byte	stringToByte(java.lang.String text)
static byte	stringToByte(java.lang.String text, boolean throwOnFail)
static double	stringToDouble(java.lang.String text)
static double	stringToDouble(java.lang.String text, boolean throwOnFail)	Return the double value in the text parameter.
static float	stringToFloat(java.lang.String text)
static float	stringToFloat(java.lang.String text, boolean throwOnFail)
static int	stringToInt(java.lang.String text)
static int	stringToInt(java.lang.String text, boolean throwOnFail)
static long	stringToLong(java.lang.String text)
static long	stringToLong(java.lang.String text, boolean throwOnFail)
static java.lang.String	stringWithFixLength(java.lang.String string, int length, char fillChar)
static java.lang.String	stringWithFixLength(java.lang.String string, int length, char fillChar, StringUtil.STRING_WITH_FIX_LENGTH_ALIGN align)
static java.lang.String	stringWithNumberOfChar(int number, char c)
static java.lang.String	toCamelCase(java.lang.String string)
static java.lang.String	toHex(int number)	Return the number parameter as hex.
static java.lang.String	toHex(int number, int minLength)
static java.lang.String	toSentenceCase(java.lang.String text)
static java.lang.String	toUnderscoreCase(java.lang.String string)
static java.lang.String	toWordCase(java.lang.String text)
static java.lang.String	unwrapString(java.lang.String string)
static void	wrapString(java.lang.StringBuilder stringBuilderOutput, java.lang.String string)

Methods inherited from class java.lang.Object

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

Field Detail

STRING_SPLIT_INCLUDING_TRAILING_EMPTY_STRINGS

public static final int STRING_SPLIT_INCLUDING_TRAILING_EMPTY_STRINGS

See Also:

Constant Field Values

DEFAULT_WILDCARD_SEPARATOR

public static final java.lang.String DEFAULT_WILDCARD_SEPARATOR

See Also:

Constant Field Values

DEFAULT_WILDCARD_NOT_PREFIX

public static final java.lang.String DEFAULT_WILDCARD_NOT_PREFIX

See Also:

Constant Field Values

DEFAULT_WILDCARD_REG_EXP_PREFIX

public static final java.lang.String DEFAULT_WILDCARD_REG_EXP_PREFIX

See Also:

Constant Field Values

DEFAULT_REG_EXP_FLAGS

public static final int DEFAULT_REG_EXP_FLAGS

See Also:

Constant Field Values

usePatternCache

public static boolean usePatternCache

patternCacheSize

public static int patternCacheSize

HEX

public static final char[] HEX

Constructor Detail

StringUtil

public StringUtil()

Method Detail

onlyFirstLinesOf

public static java.lang.String onlyFirstLinesOf(java.lang.String string,
                                                int maximumNumberOfLines)

indentLines

public static java.lang.String indentLines(java.lang.String string,
                                           java.lang.String indent)

indexOfOccurrence

public static int indexOfOccurrence(java.lang.String baseString,
                                    java.lang.String search,
                                    int occurrenceNumber)

replace

public static java.lang.String replace(java.lang.String base,
                                       java.lang.String from,
                                       java.lang.String to)

replace

public static java.lang.String replace(java.lang.String base,
                                       java.lang.String from,
                                       java.lang.String to,
                                       boolean all)

appendedSeparator

public static void appendedSeparator(java.lang.StringBuilder stringBuilder)

appendedField

public static void appendedField(java.lang.StringBuilder stringBuilder,
                                 java.lang.String string)

wrapString

public static void wrapString(java.lang.StringBuilder stringBuilderOutput,
                              java.lang.String string)

unwrapString

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

javaConstantEncodeString

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

javaConstantEncodeString

public static java.lang.String javaConstantEncodeString(java.lang.String s,
                                                        boolean forceAscii)

javaConstantEncodeString

public static void javaConstantEncodeString(java.lang.StringBuilder stringBuilder,
                                            java.lang.String string)

javaConstantEncodeString

public static void javaConstantEncodeString(java.lang.StringBuilder stringBuilder,
                                            java.lang.String string,
                                            boolean forceAscii)

javaConstantDecodeString

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

javaConstantDecodeString

public static void javaConstantDecodeString(java.lang.StringBuilder stringBuilder,
                                            java.lang.String string)

appendedField

public static void appendedField(java.lang.StringBuilder stringBuilder,
                                 int number)

appendedField

public static void appendedField(java.lang.StringBuilder stringBuilder,
                                 long number)

appendedField

public static void appendedField(java.lang.StringBuilder stringBuilder,
                                 boolean b)

splitStringAtCommaAsFields

public static StringUtil.Fields splitStringAtCommaAsFields(java.lang.String line)

splitStringAtCommaAsFields

public static StringUtil.Fields splitStringAtCommaAsFields(java.lang.String line,
                                                           boolean safe)

splitStringAtComma

public static java.lang.String[] splitStringAtComma(java.lang.String line,
                                                    boolean safe)

isStringAnInt

public static boolean isStringAnInt(java.lang.String text)

isStringALong

public static boolean isStringALong(java.lang.String text)

isStringADouble

public static boolean isStringADouble(java.lang.String text)

stringToByte

public static byte stringToByte(java.lang.String text)

stringToByte

public static byte stringToByte(java.lang.String text,
                                boolean throwOnFail)

stringToInt

public static int stringToInt(java.lang.String text)

stringToInt

public static int stringToInt(java.lang.String text,
                              boolean throwOnFail)

stringToLong

public static long stringToLong(java.lang.String text)

stringToLong

public static long stringToLong(java.lang.String text,
                                boolean throwOnFail)

stringToFloat

public static float stringToFloat(java.lang.String text)

stringToFloat

public static float stringToFloat(java.lang.String text,
                                  boolean throwOnFail)

stringToDouble

public static double stringToDouble(java.lang.String text)

stringToDouble

public static double stringToDouble(java.lang.String text,
                                    boolean throwOnFail)

Return the double value in the text parameter.
NOTE: This method can't handle strings containing thousands separator(s)

longToStringWithFixLengthWith0

public static java.lang.String longToStringWithFixLengthWith0(long number,
                                                              int length)

longToStringWithFixLengthWithSpace

public static java.lang.String longToStringWithFixLengthWithSpace(long number,
                                                                  int length)

longToStringWithFixLength

public static java.lang.String longToStringWithFixLength(long number,
                                                         int length,
                                                         char fillChar)

intToStringWithThousands

public static java.lang.String intToStringWithThousands(int number)

intToStringWithThousands

public static java.lang.String intToStringWithThousands(long number)

longToStringWithUnit

public static java.lang.String longToStringWithUnit(long number)

numberOfCharsInString

public static int numberOfCharsInString(java.lang.String baseString,
                                        char searchChar)

stringWithNumberOfChar

public static java.lang.String stringWithNumberOfChar(int number,
                                                      char c)

stringWithFixLength

public static java.lang.String stringWithFixLength(java.lang.String string,
                                                   int length,
                                                   char fillChar)

stringWithFixLength

public static java.lang.String stringWithFixLength(java.lang.String string,
                                                   int length,
                                                   char fillChar,
                                                   StringUtil.STRING_WITH_FIX_LENGTH_ALIGN align)

getNumericStringCompare

public static final java.util.Comparator<java.lang.String> getNumericStringCompare()

multiWildcardError

public static java.lang.String multiWildcardError(java.lang.String wildcard)

multiWildcardError

public static java.lang.String multiWildcardError(java.lang.String wildcard,
                                                  java.lang.String separator,
                                                  java.lang.String notPrefix,
                                                  java.lang.String regExpPrefix)

doesStringMatchMultiWildcard

public static boolean doesStringMatchMultiWildcard(java.lang.String string,
                                                   java.lang.String wildcard,
                                                   boolean caseSensitive)

doesStringMatchMultiWildcard

public static boolean doesStringMatchMultiWildcard(java.lang.String string,
                                                   java.lang.String wildcard,
                                                   java.lang.String separator,
                                                   java.lang.String notPrefix,
                                                   java.lang.String regExpPrefix,
                                                   boolean caseSensitive)

indexOfFirstRegExpMatch

public static int indexOfFirstRegExpMatch(java.lang.String string,
                                          java.lang.String regExp)

Returns the index of the first occurrence of regExp in string. Returns -1 if not found.
"Contains"
For "Equals" see doesStringMatchRegExp(String, String)

indexOfFirstRegExpMatch

public static int indexOfFirstRegExpMatch(java.lang.String string,
                                          java.lang.String regExp,
                                          int flags)

getMatchesForRegExp

public static java.lang.String[] getMatchesForRegExp(java.lang.String string,
                                                     java.lang.String regExp)

getMatchesForRegExp

public static java.lang.String[] getMatchesForRegExp(java.lang.String string,
                                                     java.lang.String regExp,
                                                     int flags)

getFirstGroupForRegExp

public static java.lang.String getFirstGroupForRegExp(java.lang.String string,
                                                      java.lang.String regExp)

Returns the result from calling getFirstGroupForRegExp(String, String, int) with DEFAULT_REG_EXP_FLAGS.
See getFirstGroupForRegExp(String, String, int) for details.

getFirstGroupForRegExp

public static java.lang.String getFirstGroupForRegExp(java.lang.String string,
                                                      java.lang.String regExp,
                                                      int flags)

Returns the first group of the first match of the regular expression regExp in string using flags.
If no match or group is found null is returned.
NOTE: If more than one match or group is found an exception is thrown.

getGroupsForRegExpAsFlatArrayWithValidation

public static java.lang.String[] getGroupsForRegExpAsFlatArrayWithValidation(int expectedLength,
                                                                             java.lang.String string,
                                                                             java.lang.String regExp)

getGroupsForRegExpAsFlatArrayWithValidation

public static java.lang.String[] getGroupsForRegExpAsFlatArrayWithValidation(int expectedLength,
                                                                             java.lang.String string,
                                                                             java.lang.String regExp,
                                                                             int flags)

getGroupsForRegExpAsFlatArray

public static java.lang.String[] getGroupsForRegExpAsFlatArray(java.lang.String string,
                                                               java.lang.String regExp)

getGroupsForRegExpAsFlatArray

public static java.lang.String[] getGroupsForRegExpAsFlatArray(java.lang.String string,
                                                               java.lang.String regExp,
                                                               int flags)

getGroupsForRegExpAs2DimensionsArray

public static java.lang.String[][] getGroupsForRegExpAs2DimensionsArray(java.lang.String string,
                                                                        java.lang.String regExp)

getGroupsForRegExpAs2DimensionsArray

public static java.lang.String[][] getGroupsForRegExpAs2DimensionsArray(java.lang.String string,
                                                                        java.lang.String regExp,
                                                                        int flags)

getFirstNamedGroupForRegExp

public static java.lang.String getFirstNamedGroupForRegExp(java.lang.String string,
                                                           java.lang.String regExp,
                                                           java.lang.String namedGroup)

getFirstNamedGroupForRegExp

public static java.lang.String getFirstNamedGroupForRegExp(java.lang.String string,
                                                           java.lang.String regExp,
                                                           java.lang.String namedGroup,
                                                           int flags)

doesStringMatchRegExp

public static boolean doesStringMatchRegExp(java.lang.String string,
                                            java.lang.String regExp)

Returns true if the entire string matches regular expression in regExp. Otherwise it returns false.
"Equals"
For "Contains" see indexOfFirstRegExpMatch(String, String)

doesStringMatchRegExp

public static boolean doesStringMatchRegExp(java.lang.String string,
                                            java.lang.String regExp,
                                            int flags)

getMatcherForRegExp

public static java.util.regex.Matcher getMatcherForRegExp(java.lang.String string,
                                                          java.lang.String regExp)

getMatcherForRegExp

public static java.util.regex.Matcher getMatcherForRegExp(java.lang.String string,
                                                          java.lang.String regExp,
                                                          int flags)

clearPatternCache

public static void clearPatternCache()

doesStringMatchWildcard

public static boolean doesStringMatchWildcard(java.lang.String string,
                                              java.lang.String wildcard,
                                              boolean caseSensitive)

byteToBitString

public static java.lang.String byteToBitString(byte number)

intToBitString

public static java.lang.String intToBitString(int number)

intToBitString

public static java.lang.String intToBitString(int number,
                                              int length)

bitStringToInt

public static int bitStringToInt(java.lang.String bits)

toHex

public static java.lang.String toHex(int number)

Return the number parameter as hex.

See Also:

see java.lang.Integer#toString(int, 16), see java.lang.Integer#toHexString(int) (dynamic length, lower case), see java.lang.Integer#parseInt("00ff00", 16), see java.lang.String#format("%04X", Integer) (Always 4 in length, upper case. "%04x" will make it lower case.)

toHex

public static java.lang.String toHex(int number,
                                     int minLength)

lastChar

public static char lastChar(java.lang.String string)

firstCharUpperCase

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

toWordCase

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

toSentenceCase

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

toCamelCase

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

toUnderscoreCase

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

stringEquals

public static boolean stringEquals(java.lang.String s1,
                                   java.lang.String s2)

Returns if s1 and s2 are equal in any combination of null.