Package uk.blankaspect.common.string

Class StringUtils

java.lang.Object

uk.blankaspect.common.string.StringUtils

public class StringUtils
extends Object

This class contains utility methods that relate to strings and character sequences.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StringUtils.SplitMode	This is an enumeration of the ways in which an input string may be split by the split*(…) methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	ESCAPE_PREFIX_CHAR	The prefix that is recognised by the escape(CharSequence, String) method.

Method Summary

Modifier and Type	Method	Description
static String	applyPrefix(String str, String prefix)
static boolean	containsIgnoreCase(String target, Iterable<String> strs)
static String	escape(CharSequence seq, String metachars)
static List<String>	extractLines(CharSequence text)	Splits the specified text at line separators and returns the resulting list of lines.
static String	firstCharsToLowerCase(String str)
static String	firstCharsToUpperCase(String str)
static String	firstCharToLowerCase(String str)
static String	firstCharToUpperCase(String str)
static int	getMaxLength(Iterable<? extends CharSequence> seqs)
static int	getMaxLength(String... strs)
static String	getPrefixFirst(String str, char ch)
static String	getPrefixLast(String str, char ch)
static String	getSuffixAfterFirst(String str, char ch)
static String	getSuffixAfterLast(String str, char ch)
static String	getSuffixFirst(String str, char ch)
static String	getSuffixLast(String str, char ch)
static int	indexOfIgnoreCase(String target, List<String> strs)
static boolean	isNullOrBlank(String str)	Returns true if the specified string is null or empty or it contains only whitespace characters.
static boolean	isNullOrEmpty(String str)	Returns true if the specified string is null or empty.
static String	join(char separator, boolean trailingSeparator, Iterable<? extends CharSequence> seqs)
static String	join(char separator, boolean trailingSeparator, String... strs)
static String	join(char separator, Iterable<? extends CharSequence> seqs)
static String	join(char separator, String... strs)
static String	join(CharSequence separator, boolean trailingSeparator, Iterable<? extends CharSequence> seqs)
static String	join(CharSequence separator, boolean trailingSeparator, String... strs)
static String	join(CharSequence separator, Iterable<? extends CharSequence> seqs)
static String	join(CharSequence separator, String... strs)
static String	padAfter(CharSequence seq, int length)
static String	padAfter(CharSequence seq, int length, char ch)
static String	padBefore(CharSequence seq, int length)
static String	padBefore(CharSequence seq, int length, char ch)
static String	removePrefix(String str, String prefix)
static String	removeSuffix(String str, String suffix)
static List<String>	split(String str, char separator)
static List<String>	split(String str, char separator, boolean discardFinalEmptyElement)
static String[]	splitAt(String str, int index, StringUtils.SplitMode splitMode)
static String[]	splitAtFirst(String str, char ch)
static String[]	splitAtFirst(String str, char ch, StringUtils.SplitMode splitMode)
static String[]	splitAtLast(String str, char ch)
static String[]	splitAtLast(String str, char ch, StringUtils.SplitMode splitMode)
static String	stripAfter(CharSequence seq)
static String	stripBefore(CharSequence seq)
static String	toCamelCase(CharSequence text)	Converts the specified text to camel case and returns the resulting string.
static String	wrap(CharSequence seq, int maxLineLength)
static List<String>	wrapLines(CharSequence seq, int maxLineLength)

Methods inherited from class java.lang.Object

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

Field Details

ESCAPE_PREFIX_CHAR

public static final char ESCAPE_PREFIX_CHAR

The prefix that is recognised by the escape(CharSequence, String) method.

See Also:

• Constant Field Values

Method Details

isNullOrEmpty

public static boolean isNullOrEmpty(String str)

Returns true if the specified string is null or empty.

Parameters:

str - the string that will be tested.

Returns:

true if str is null or empty.

isNullOrBlank

public static boolean isNullOrBlank(String str)

Returns true if the specified string is null or empty or it contains only whitespace characters.

Parameters:

str - the string that will be tested.

Returns:

true if str is null or empty or it contains only whitespace characters.

getMaxLength

public static int getMaxLength(Iterable<? extends CharSequence> seqs)

getMaxLength

public static int getMaxLength(String... strs)

stripBefore

public static String stripBefore(CharSequence seq)

stripAfter

public static String stripAfter(CharSequence seq)

padBefore

public static String padBefore(CharSequence seq,
 int length)

padBefore

public static String padBefore(CharSequence seq,
 int length,
 char ch)

padAfter

public static String padAfter(CharSequence seq,
 int length)

padAfter

public static String padAfter(CharSequence seq,
 int length,
 char ch)

split

public static List<String> split(String str,
 char separator)

split

public static List<String> split(String str,
 char separator,
 boolean discardFinalEmptyElement)

splitAt

public static String[] splitAt(String str,
 int index,
 StringUtils.SplitMode splitMode)

splitAtFirst

public static String[] splitAtFirst(String str,
 char ch)

splitAtFirst

public static String[] splitAtFirst(String str,
 char ch,
 StringUtils.SplitMode splitMode)

splitAtLast

public static String[] splitAtLast(String str,
 char ch)

splitAtLast

public static String[] splitAtLast(String str,
 char ch,
 StringUtils.SplitMode splitMode)

getPrefixFirst

public static String getPrefixFirst(String str,
 char ch)

getPrefixLast

public static String getPrefixLast(String str,
 char ch)

getSuffixFirst

public static String getSuffixFirst(String str,
 char ch)

getSuffixAfterFirst

public static String getSuffixAfterFirst(String str,
 char ch)

getSuffixLast

public static String getSuffixLast(String str,
 char ch)

getSuffixAfterLast

public static String getSuffixAfterLast(String str,
 char ch)

removePrefix

public static String removePrefix(String str,
 String prefix)

removeSuffix

public static String removeSuffix(String str,
 String suffix)

join

public static String join(char separator,
 String... strs)

join

public static String join(char separator,
 Iterable<? extends CharSequence> seqs)

join

public static String join(CharSequence separator,
 String... strs)

join

public static String join(CharSequence separator,
 Iterable<? extends CharSequence> seqs)

join

public static String join(char separator,
 boolean trailingSeparator,
 String... strs)

join

public static String join(char separator,
 boolean trailingSeparator,
 Iterable<? extends CharSequence> seqs)

join

public static String join(CharSequence separator,
 boolean trailingSeparator,
 String... strs)

join

public static String join(CharSequence separator,
 boolean trailingSeparator,
 Iterable<? extends CharSequence> seqs)

extractLines

public static List<String> extractLines(CharSequence text)

Splits the specified text at line separators and returns the resulting list of lines. The line separators that are recognised are CR+LF (U+000D, U+000A) and LF (U+000A). The line separators are not included in the output list.

Parameters:

text - the text that will be split into lines at line separators.

Returns:

a list of the strings that result from splitting text at line separators.

wrap

public static String wrap(CharSequence seq,
 int maxLineLength)

wrapLines

public static List<String> wrapLines(CharSequence seq,
 int maxLineLength)

firstCharToLowerCase

public static String firstCharToLowerCase(String str)

firstCharsToLowerCase

public static String firstCharsToLowerCase(String str)

firstCharToUpperCase

public static String firstCharToUpperCase(String str)

firstCharsToUpperCase

public static String firstCharsToUpperCase(String str)

toCamelCase

public static String toCamelCase(CharSequence text)

Converts the specified text to camel case and returns the resulting string.

The conversion is described below. In the description,

• a digit is a character for which Character.isDigit(char) returns true,
• a letter is a character for which Character.isLetter(char) returns true,
• a non-alphanumeric character is a character that is neither a digit nor a letter.

1. Each letter that immediately follows a digit or a non-alphanumeric character is converted to upper case except for a letter that follows a sequence of a latter and an apostrophe (U+0027).
2. All other letters are converted to lower case.
3. All non-alphanumeric characters are removed.

Parameters:

text - the text that will be converted.

Returns:

the camel-case string that results from the conversion of text.

applyPrefix

public static String applyPrefix(String str,
 String prefix)

escape

public static String escape(CharSequence seq,
 String metachars)

containsIgnoreCase

public static boolean containsIgnoreCase(String target,
 Iterable<String> strs)

indexOfIgnoreCase

public static int indexOfIgnoreCase(String target,
 List<String> strs)