org.key_project.util.java

Class StringUtil

java.lang.Object

org.key_project.util.java.StringUtil

public final class StringUtil
extends java.lang.Object

Provides static methods to work with strings.

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	ADDITIONAL_ALLOWED_FILE_NAME_SYSTEM_CHARACTERS Additional characters allowed in file systems.
static java.lang.String	EMPTY_STRING Constant for an empty string.
static java.lang.String	LATIN_ALPHABET_BIG The latin alphabet with big capitals.
static java.lang.String	LATIN_ALPHABET_SMALL The latin alphabet with small capitals.
static java.lang.String	NEW_LINE Constant for a line break.
static java.lang.String	NUMERALS The numerals.
static java.lang.String	WHITESPACE All characters representing whitespace.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StringUtil() Forbid instances by this private constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	chop(java.lang.String text, int maxLength) Chops the given text if required.
static boolean	contains(java.lang.String string, java.lang.CharSequence substring) Checks if the given string contains the substring.
static java.util.Comparator<java.lang.String>	createIgnoreCaseComparator() Creates a Comparator that can be used to compute the equality of two given Strings ignoring the case via String.compareToIgnoreCase(String).
static java.lang.String	createLine(java.lang.String text, int repetitions) Creates a line which consists of the given text.
static boolean	equalIgnoreWhiteSpace(java.lang.String first, java.lang.String second) Checks the equality of the given Strings ignoring whitespace.
static java.lang.String	fillString(java.lang.String text, char leadingCharacter, int length) Fills the given text with the leading character until it has the defined length.
static boolean	isEmpty(java.lang.String text) Checks if the String is empty.
static boolean	isNumber(java.lang.String val)
static boolean	isTrimmedEmpty(java.lang.String text) Checks if the trimmed String is empty.
static java.lang.String	replaceAll(java.lang.String text, char[] toSearch, char toReplace) Replaces all occurrences of a search sign with the replacement sign.
static boolean	startsWith(java.lang.Object obj, java.lang.String prefix) Checks if the given Object is a String which starts with the given prefix.
static java.lang.String	toLowerCase(java.lang.String text) Nullpointer save execution of String.toLowerCase().
static java.lang.String	toSingleLinedString(java.lang.String text) Converts the optional multi lined String in a single lined String by replacing all line breaks and tabs with a space.
static java.lang.String	trim(java.lang.String text) Nullpointer save execution of String.trim()
static java.lang.String	trimRight(java.lang.String text) Performs a trim only on the right side.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

Constant for an empty string.

See Also:

Constant Field Values

NEW_LINE

public static final java.lang.String NEW_LINE

Constant for a line break.

LATIN_ALPHABET_BIG

public static final java.lang.String LATIN_ALPHABET_BIG

The latin alphabet with big capitals.

See Also:

Constant Field Values

LATIN_ALPHABET_SMALL

public static final java.lang.String LATIN_ALPHABET_SMALL

The latin alphabet with small capitals.

ADDITIONAL_ALLOWED_FILE_NAME_SYSTEM_CHARACTERS

public static final char[] ADDITIONAL_ALLOWED_FILE_NAME_SYSTEM_CHARACTERS

Additional characters allowed in file systems.

It is important that ':' is not contained because "::" is replaced with a '/' by the JFileChooser under Mac OS.

NUMERALS

public static final java.lang.String NUMERALS

The numerals.

See Also:

Constant Field Values

WHITESPACE

public static final java.lang.String WHITESPACE

All characters representing whitespace.

See Also:

Constant Field Values

Constructor Detail

StringUtil

private StringUtil()

Forbid instances by this private constructor.

Method Detail

isEmpty

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

Checks if the String is empty.

Parameters:

text - The text to check.

Returns:

true = text is null or empty, false = text is not empty.

isTrimmedEmpty

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

Checks if the trimmed String is empty.

Parameters:

text - The text to check.

Returns:

true = text is null or trimmed empty, false = text is not empty.

trim

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

Nullpointer save execution of String.trim()

Parameters:

text - The text.

Returns:

The trimmed text.

toLowerCase

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

Nullpointer save execution of String.toLowerCase().

Parameters:

text - The text to convert.

Returns:

The text in lower case or null if the given text is null.

createIgnoreCaseComparator

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

Creates a Comparator that can be used to compute the equality of two given Strings ignoring the case via String.compareToIgnoreCase(String). If both values are null also 0 is returned in Comparator.compare(Object, Object). If only one value is null Comparator.compare(Object, Object) will return a value different to 0.

Returns:

The created Comparator.

createLine

public static java.lang.String createLine(java.lang.String text,
                                          int repetitions)

Creates a line which consists of the given text.

Parameters:

text - The text to repeate.

repetitions - The number of repetitions.

Returns:

The created line.

contains

public static boolean contains(java.lang.String string,
                               java.lang.CharSequence substring)

Checks if the given string contains the substring.

Attention: The empty string is contained in every string.

Parameters:

string - The string that should contain the substring.

substring - The substring to check.

Returns:

true strings are not null and the string contains the substring, false if at least one string is null or the string does not contain the substring.

toSingleLinedString

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

Converts the optional multi lined String in a single lined String by replacing all line breaks and tabs with a space.

Parameters:

text - The text to convert.

Returns:

The single lined text.

replaceAll

public static java.lang.String replaceAll(java.lang.String text,
                                          char[] toSearch,
                                          char toReplace)

Replaces all occurrences of a search sign with the replacement sign.

Parameters:

text - The text to search and replace in.

toSearch - The signs to search.

toReplace - The sign to replace with.

Returns:

The new created String.

equalIgnoreWhiteSpace

public static boolean equalIgnoreWhiteSpace(java.lang.String first,
                                            java.lang.String second)

Checks the equality of the given Strings ignoring whitespace.

Parameters:

first - The first String.

second - The second String.

Returns:

true equal ignoring whitespace, false different.

fillString

public static java.lang.String fillString(java.lang.String text,
                                          char leadingCharacter,
                                          int length)
                                   throws java.lang.IllegalArgumentException

Fills the given text with the leading character until it has the defined length.

Parameters:

text - The text to fill.

leadingCharacter - The leading character to use.

length - The length to fill up to.

Returns:

The created text.

Throws:

java.lang.IllegalArgumentException - If the text is already longer as the given length

trimRight

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

Performs a trim only on the right side.

Parameters:

text - The text to trim its right side.

Returns:

The trimmed text.

chop

public static java.lang.String chop(java.lang.String text,
                                    int maxLength)

Chops the given text if required.

Parameters:

text - The text to check.

maxLength - The maximal length to ensure.

Returns:

The text considering the maximal length.

startsWith

public static boolean startsWith(java.lang.Object obj,
                                 java.lang.String prefix)

Checks if the given Object is a String which starts with the given prefix.

Parameters:

obj - The Object to check.

prefix - The prefix to check for.

Returns:

true Object is String with given prefix, false otherwise.

isNumber

public static boolean isNumber(java.lang.String val)