Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.pf.text
Class StringUtil

java.lang.Object
  extended by org.pf.text.StringUtil

public class StringUtil
extends java.lang.Object

The sole instance of this class provides several convienience methods for string manipulation such as substring replacement or character repetition.
It also provides many convenience methods to split up strings and to handle string arrays.

Get the instance by calling StringUtil.current().

Version:
3.2
Author:
Manfred Duchrow

Field Summary
static char CH_CR
          Constant for the carriage return character
static char CH_NEWLINE
          Constant for the new line character
static char CH_SPACE
          Constant for the space character
static char CH_TAB
          Constant for the tabulator character
static java.lang.String EMPTY_STRING
          An empty String to avoid multiple creation of such an object
static java.lang.String[] EMPTY_STRING_ARRAY
          An empty String array to avoid multiple creation of such an object
static java.lang.String STR_CR
          Constant for the String representation of the carriage return character
static java.lang.String STR_INNER_CLASS_SEPARATOR
          Constant that defines the separator for inner classes in full qualified class names ("$")
static java.lang.String STR_NEWLINE
          Constant for the String representation of the new line character
static java.lang.String STR_PACKAGE_SEPARATOR
          Constant that defines the separator for package elements and classes (".")
static java.lang.String STR_SPACE
          Constant for the String representation of the space character
static java.lang.String STR_TAB
          Constant for the String representation of the tabulator character
 
Method Summary
 void addAll(java.util.Collection collection, java.lang.String[] strings)
          Adds all given strings to the specified collection.
 void addAllNew(java.util.Collection collection, java.lang.String[] strings)
          Adds all given strings to the specified collection, if they are not already in the collection.
 java.lang.String[] allParts(java.lang.String text, java.lang.String separators)
          Returns an array of substrings of the given text.
 java.lang.String[] allParts(java.lang.String text, java.lang.String separators, char quoteChar)
          Returns an array of substrings of the given text.
 java.lang.String[] allParts(java.lang.String text, java.lang.String separators, char[] quoteChars)
          Returns an array of substrings of the given text.
 java.lang.String[] allSubstrings(java.lang.String text, java.lang.String separator)
          Returns the given text split up into an array of strings, at the occurrences of the separator string.
 java.lang.String[] append(java.lang.String[] strings, java.lang.String string)
          Returns the given string array extended by one element that hold the specified string.
 java.lang.String[] append(java.lang.String[] strings, java.lang.String[] appendStrings)
          Returns an array of strings that contains all strings given by the first and second string array.
 java.lang.String[] appendIfNotThere(java.lang.String[] strings, java.lang.String appendString)
          Returns an array of strings that contains all strings given in the first plus the specified string to append, if it is not already in the given array.
 java.lang.String[] appendIfNotThere(java.lang.String[] strings, java.lang.String[] appendStrings)
          Returns an array of strings that contains all strings given in the first plus all strings of the second array that are not already in the first array.
 boolean areEqual(java.lang.String[] strings1, java.lang.String[] strings2)
          Returns true if all elements of the first given array are in the second given array and the length of both arrays are equal.
 boolean areEqualIgnoreCase(java.lang.String[] strings1, java.lang.String[] strings2)
          Returns true if all elements of the first given array are in the second given array and the length of both arrays are equal.
 java.util.Map asMap(java.lang.String str)
          Returns a new map object that contains all key-value pairs of the specified string.
 java.util.Map asMap(java.lang.String str, java.lang.String elementSeparator)
          Returns a new map object that contains all key-value pairs of the specified string.
 java.util.Map asMap(java.lang.String str, java.lang.String elementSeparator, java.lang.String keyValueSeparator)
          Returns a new map object that contains all key-value pairs of the specified string.
 java.util.Properties asProperties(java.lang.String str)
          Adds all key-value pairs of the given string to a new properties object.
 java.lang.String asSortedString(java.lang.String[] strings)
          Returns a string that contains all given strings sorted (in ascending order), concatenated and separated by the specified separator.
 java.lang.String asSortedString(java.lang.String[] strings, java.lang.String separator)
          Returns a string that contains all given strings sorted (in ascending order), concatenated and separated by the specified separator.
 java.lang.String asSortedString(java.lang.String[] strings, java.lang.String separator, boolean ascending)
          Returns a string that contains all given strings sorted, concatenated and separated by the specified separator.
 java.lang.String asSortedString(java.lang.String[] strings, java.lang.String separator, java.util.Comparator comparator)
          Returns a string that contains all given strings sorted, concatenated and separated by the specified separator.
 java.lang.String asString(char ch)
          Returns a new string that contains only the given character.
 java.lang.String asString(java.util.Collection strings)
          Returns a string that contains all strings from the given collection concatenated and separated by comma.
 java.lang.String asString(java.util.Collection strings, java.lang.String separator)
          Returns a string that contains all strings from the given collection concatenated and separated by the specified separator.
 java.lang.String asString(java.util.Map map)
          Converts the given map to a string.
 java.lang.String asString(java.util.Map map, java.lang.String elementSeparator)
          Converts the given map to a string utilizing the given separator.
 java.lang.String asString(java.util.Map map, java.lang.String elementSeparator, java.lang.String keyValueSeparator)
          Converts the given map to a string utilizing the given separators.
 java.lang.String asString(java.lang.String[] strings)
          Returns a string that contains all given strings concatenated and separated by comma.
 java.lang.String asString(java.lang.String[] strings, java.lang.String separator)
          Returns a string that contains all given strings concatenated and separated by the specified separator.
 java.lang.String[] asStrings(java.util.Collection collection)
          Returns a string array containing all elements of the given collection.
 java.lang.String center(java.lang.String str, int len)
          Returns the given string filled (on the right and right) up to the specified length with spaces.
 java.lang.String centerCh(java.lang.String str, int len, char ch)
          Returns the given string filled equally left and right up to the specified length with the given character.
 boolean contains(java.lang.String[] strArray, java.lang.String searchStr)
          Returns whether or not the specified string can be found in the given string array.
 boolean contains(java.lang.String[] strArray, java.lang.String searchStr, boolean ignoreCase)
          Returns whether or not the specified string can be found in the given string array.
 boolean contains(java.lang.String[] strArray, StringPattern pattern)
          Returns whether or not a string can be found in the given string array that matches the specified string pattern.
 boolean containsIgnoreCase(java.lang.String[] strArray, java.lang.String searchStr)
          Returns whether or not the specified string can be found in the given string array.
 java.util.Collection copy(java.util.Collection strings, StringFilter filter)
          Returns a new array that contains all strings of the given array that matched the specified filter.
 java.lang.String[] copy(java.lang.String[] strings)
          Returns a copy (new array) that contains all the strings of the given array
 java.lang.String[] copy(java.lang.String[] strings, StringFilter filter)
          Returns a new array that contains all strings of the given array that matched the specified filter.
 java.lang.String[] copyFrom(java.lang.String[] from, int start)
          Returns all elements of string array from in a new array from index start up to the end.
 java.lang.String[] copyFrom(java.lang.String[] from, int start, int end)
          Returns all elements of string array from in a new array from index start up to index end (inclusive).
 java.lang.String[] copyLowerCase(java.lang.String[] strings)
          Returns a copy of the given string array where all elements are converted to lower case.
 java.lang.String[] copyUpperCase(java.lang.String[] strings)
          Returns a copy of the given string array where all elements are converted to upper case.
 java.util.Collection copyWithout(java.util.Collection strings, StringFilter filter)
          Returns a new collection that contains all strings of the given collection that do NOT match the specified filter.
 java.lang.String[] copyWithout(java.lang.String[] strings, StringFilter filter)
          Returns a new array that contains all strings of the given array that do NOT match the specified filter.
 int count(java.lang.String sourceStr, java.lang.String subStr)
          Returns how often the given sub string occurs in the source String.
static StringUtil current()
          Returns the one and only instance of this class.
 java.lang.String cutHead(java.lang.String text, java.lang.String separator)
          Returns the portion of the given string that comes after the last occurrence of the specified separator.
 java.lang.String cutTail(java.lang.String text, java.lang.String separator)
          Returns the portion of the given string that comes before the last occurrence of the specified separator.
 java.lang.String getDelimitedSubstring(java.lang.String text, IStringPair delimiter)
          Returns the first substring that is enclosed by the specified delimiter pair.
 java.lang.String getDelimitedSubstring(java.lang.String text, IStringPair[] delimiters)
          Returns the first substring that is enclosed by one of the specified delimiter pairs.
 java.lang.String getDelimitedSubstring(java.lang.String text, java.lang.String delimiter)
          Returns the first substring that is enclosed by the specified delimiter.
 java.lang.String getDelimitedSubstring(java.lang.String text, java.lang.String startDelimiter, java.lang.String endDelimiter)
          Returns the first substring that is enclosed by the specified delimiters.
 java.lang.String getPackageName(java.lang.String qualifiedClassName)
          Returns the package name of the given full qualified class name.
 java.lang.String getUnqualifiedClassName(java.lang.String qualifiedClassName)
          Returns the class name without the package name.
 int indexOf(char[] charArray, char ch, boolean ignoreCase)
          Returns the index of the specified character in the given char array.
 int indexOf(java.lang.String[] strArray, java.lang.String searchStr)
          Returns the index of the specified string in the given string array.
 int indexOf(java.lang.String[] strArray, StringPattern pattern)
          Returns the index of the first string in the given string array that matches the specified string pattern.
 int indexOfIgnoreCase(java.lang.String[] strArray, java.lang.String searchStr)
          Returns the index of the specified string in the given string array.
 int indexOfString(java.lang.String[] strArray, java.lang.String searchStr, boolean ignoreCase)
          Returns the index of the specified string in the given string array.
 boolean isNullOrBlank(java.lang.String str)
          Returns true if the given string is null or empty or consists of whitespace characters only.
 boolean isNullOrEmpty(java.lang.String str)
          Returns true if the given string is null or empty
 boolean isNullOrEmpty(java.lang.String[] strings)
          Returns true if the given string array is null or empty
 java.lang.String leftPad(int value, int len)
          Returns the given integer as string filled (on the left) up to the specified length with zeroes.
 java.lang.String leftPad(long value, int len)
          Returns the given long as string filled (on the left) up to the specified length with zeroes.
 java.lang.String leftPad(java.lang.String str, int len)
          Returns the given string filled (on the left) up to the specified length with spaces.
 java.lang.String leftPadCh(int value, int len, char fillChar)
          Returns the given integer as string filled (on the left) up to the specified length with the given fill character.
 java.lang.String leftPadCh(long value, int len, char fillChar)
          Returns the given long as string filled (on the left) up to the specified length with the given fill character.
 void leftPadCh(java.lang.StringBuffer buffer, long value, int len, char fillChar)
          Returns the given long as string filled (on the left) up to the specified length with the given fill character.
 java.lang.String leftPadCh(java.lang.String str, int len, char ch)
          Returns the given string filled (on the left) up to the specified length with the given character.
 java.lang.String[] parts(java.lang.String text, java.lang.String separators)
          Returns an array of substrings of the given text.
 java.lang.String[] parts(java.lang.String text, java.lang.String separators, char quoteChar)
          Returns an array of substrings of the given text.
 java.lang.String[] parts(java.lang.String text, java.lang.String separators, char[] quoteChars)
          Returns an array of substrings of the given text.
 java.lang.String prefix(java.lang.String str, java.lang.String separator)
          Returns the substring of the given string that comes before the first occurrence of the specified separator.
 java.lang.String[] remove(java.lang.String[] strings, java.lang.String removeString)
          Removes the given string from the specified string array.
 java.lang.String[] remove(java.lang.String[] strings, java.lang.String[] removeStrings)
          Removes all string of the second array from the first array.
 java.lang.String[] removeNull(java.lang.String[] strings)
          Removes all null values from the given string array.
 java.lang.String repeat(char ch, int count)
          Returns a string with size of count and all characters initialized with ch.
 java.lang.String replaceAll(java.lang.String sourceStr, java.lang.String oldSubStr, java.lang.String newSubStr)
          Returns the given string with all found oldSubStr replaced by newSubStr.
 java.lang.String replaceEach(java.lang.String sourceStr, java.lang.String oldChars, java.lang.String newChars)
          Returns the given sourceString with all characters occurring in oldChars replaced by the characters at the corresponding index in newChars.
 java.lang.String reverse(java.lang.String str)
          Returns a string that contains all characters of the given string in reverse order.
 java.lang.String rightPad(int value, int len)
          Returns the given integer as string filled (on the right) up to the specified length with spaces.
 java.lang.String rightPad(long value, int len)
          Returns the given integer as string filled (on the right) up to the specified length with spaces.
 java.lang.String rightPad(java.lang.String str, int len)
          Returns the given string filled (on the right) up to the specified length with spaces.
 java.lang.String rightPadCh(int value, int len, char fillChar)
          Returns the given integer as string filled (on the right) up to the specified length with the given character.
 java.lang.String rightPadCh(long value, int len, char fillChar)
          Returns the given long as string filled (on the right) up to the specified length with the given character.
 java.lang.String rightPadCh(java.lang.String str, int len, char ch)
          Returns the given string filled (on the right) up to the specified length with the given character.
 java.lang.String setFileNameExtension(java.lang.String filename, java.lang.String extension, boolean replace)
          Sets the given extension as filename extension to the given filename.
 java.lang.String[] splitNameValue(java.lang.String str, java.lang.String separator)
          Returns a string array with two elements where the first is the attribute name and the second is the attribute value.
 IStringPair splitStringPair(java.lang.String str, java.lang.String separator)
          Returns a string pair where the first is the string before the first occurrence of the defined separator and the second string is everything after that separator.
 java.lang.String stackTrace(java.lang.Throwable throwable)
          Prints the stack trace of the specified throwable to a string and returns it.
 java.lang.String startingFrom(java.lang.String str, java.lang.String separator)
          Returns the substring of the given string that comes after the first occurrence of the specified separator.
 java.lang.String[] substrings(java.lang.String text, java.lang.String separator)
          Returns the given text split up into an array of strings, at the occurrences of the separator string.
 java.lang.String suffix(java.lang.String str, java.lang.String separator)
          Returns the substring of the given string that comes after the first occurrence of the specified separator.
 void toLowerCase(java.lang.String[] strings)
          Modifies the strings in the given array to be all lower case.
 java.util.Map toMap(java.lang.String str, java.util.Map map)
          Adds all key-value pairs of the given string to the specified map.
 java.util.Map toMap(java.lang.String str, java.lang.String elementSeparator, java.util.Map map)
          Returns the given map object with all key-value pairs of the specified string added to it.
 java.util.Map toMap(java.lang.String str, java.lang.String elementSeparator, java.lang.String keyValueSeparator, java.util.Map map)
          Returns the given map with new entries from the specified String.
 java.util.Properties toProperties(java.lang.String str, java.util.Properties properties)
          Adds all key-value pairs of the given string to the specified properties.
 void toUpperCase(java.lang.String[] strings)
          Modifies the strings in the given array to be all upper case.
 java.lang.String[] trimmedParts(java.lang.String text, java.lang.String separators)
          Returns an array of substrings of the given text.
 java.lang.String upTo(java.lang.String str, java.lang.String separator)
          Returns the substring of the given string that comes before the first occurrence of the specified separator.
 java.lang.String[] words(java.lang.String text)
          Returns an array of substrings of the given text.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CH_SPACE

public static final char CH_SPACE
Constant for the space character

See Also:
Constant Field Values

CH_NEWLINE

public static final char CH_NEWLINE
Constant for the new line character

See Also:
Constant Field Values

CH_CR

public static final char CH_CR
Constant for the carriage return character

See Also:
Constant Field Values

CH_TAB

public static final char CH_TAB
Constant for the tabulator character

See Also:
Constant Field Values

STR_SPACE

public static final java.lang.String STR_SPACE
Constant for the String representation of the space character

See Also:
Constant Field Values

STR_NEWLINE

public static final java.lang.String STR_NEWLINE
Constant for the String representation of the new line character

See Also:
Constant Field Values

STR_CR

public static final java.lang.String STR_CR
Constant for the String representation of the carriage return character

See Also:
Constant Field Values

STR_TAB

public static final java.lang.String STR_TAB
Constant for the String representation of the tabulator character

See Also:
Constant Field Values

STR_PACKAGE_SEPARATOR

public static final java.lang.String STR_PACKAGE_SEPARATOR
Constant that defines the separator for package elements and classes (".")

See Also:
Constant Field Values

STR_INNER_CLASS_SEPARATOR

public static final java.lang.String STR_INNER_CLASS_SEPARATOR
Constant that defines the separator for inner classes in full qualified class names ("$")

See Also:
Constant Field Values

EMPTY_STRING

public static final java.lang.String EMPTY_STRING
An empty String to avoid multiple creation of such an object

See Also:
Constant Field Values

EMPTY_STRING_ARRAY

public static final java.lang.String[] EMPTY_STRING_ARRAY
An empty String array to avoid multiple creation of such an object

Method Detail

current

public static StringUtil current()
Returns the one and only instance of this class.

addAll

public void addAll(java.util.Collection collection,
                   java.lang.String[] strings)
Adds all given strings to the specified collection. All null values in the string array will be skipped.

Parameters:
collection - The collection to which the strings are added
strings - The strings to add to the collection

addAllNew

public void addAllNew(java.util.Collection collection,
                      java.lang.String[] strings)
Adds all given strings to the specified collection, if they are not already in the collection. All null values in the string array will be skipped.

Parameters:
collection - The collection to which the strings are added
strings - The strings to add to the collection

replaceAll

public java.lang.String replaceAll(java.lang.String sourceStr,
                                   java.lang.String oldSubStr,
                                   java.lang.String newSubStr)
Returns the given string with all found oldSubStr replaced by newSubStr.
Example: StringUtil.current().replaceAll( "Seven of ten", "even", "ix" ) ;
results in: "Six of ten"

Parameters:
sourceStr - The string that should be checked for occurrences of oldSubStr
oldSubStr - The string that is searched for in sourceStr
newSubStr - The new string that is placed everywhere the oldSubStr was found
Returns:
The original string with all found substrings replaced by new strings

replaceEach

public java.lang.String replaceEach(java.lang.String sourceStr,
                                    java.lang.String oldChars,
                                    java.lang.String newChars)
Returns the given sourceString with all characters occurring in oldChars replaced by the characters at the corresponding index in newChars.
This is faster and more convenient than calling sourceString.replace( oldChar, newChar) for each character to replace.

Example: replaceEach( "(Test):77", "():7", "[]/9" ) ==> "[Test]/99"

If oldChars or newChars is null or empty the source string will be returned unchanged. The strings oldChars and newChars should have the same length. However, this method also works with different lengths.

Parameters:
sourceStr - The string in which to replace the characters
oldChars - The characters that must be replaced in sourceString
newChars - The characters that must be used instead of the old characters
Returns:
A new string with the old characters replaced by the new characters

count

public int count(java.lang.String sourceStr,
                 java.lang.String subStr)
Returns how often the given sub string occurs in the source String.
Example: StringUtil.current().count( "Seven of ten", "en" ) ;
returns: 2

Parameters:
sourceStr - The string that should be checked for occurrences of subStr (must not be null)
subStr - The string that is searched for in sourceStr (must not be null)
Returns:
The number of occurrences of subStr in sourceStr

repeat

public java.lang.String repeat(char ch,
                               int count)
Returns a string with size of count and all characters initialized with ch.

Parameters:
ch - the character to be repeated in the result string.
count - the number of times the given character should occur in the result string.
Returns:
A string containing count characters ch.

words

public java.lang.String[] words(java.lang.String text)
Returns an array of substrings of the given text.
The delimiters between the substrings are the whitespace characters SPACE, NEWLINE, CR and TAB.

Parameters:
text - The string that should be split up into whitespace separated words
Returns:
An array of substrings of the given text
See Also:
parts(String, String)

trimmedParts

public java.lang.String[] trimmedParts(java.lang.String text,
                                       java.lang.String separators)
Returns an array of substrings of the given text.
The separators between the substrings are the given delimiters. Each character in the separators string is treated as a separator.
All consecutive separators are treated as one separator, that is there will be no empty strings in the result.
It is also ensured that all strings in the result array have no leading or trailing white space characters.

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
Returns:
An array of substrings of the given text
See Also:
parts(String, String), allParts(String, String), substrings(String, String), allSubstrings(String, String)

parts

public java.lang.String[] parts(java.lang.String text,
                                java.lang.String separators)
Returns an array of substrings of the given text.
The separators between the substrings are the given delimiters. Each character in the separators string is treated as a separator.
All consecutive separators are treated as one separator, that is there will be no empty strings in the result.

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
Returns:
An array of substrings of the given text
See Also:
parts(String, String, char), allParts(String, String), substrings(String, String), allSubstrings(String, String)

parts

public java.lang.String[] parts(java.lang.String text,
                                java.lang.String separators,
                                char quoteChar)
Returns an array of substrings of the given text.
The separators between the substrings are the given separators. Each character in the separators string is treated as a separator.
All consecutive separators are treated as one separator, so there will be no empty strings in the result.

Examples:

parts( "A,B,C", ",", '*' ) --> { "A", "B", "C" }
parts( "A,*B,C*", ",", '*' ) --> { "A", "B,C" }
parts( "%A,B;C%;D;E", ";,", '%' ) --> { "A,B;C", "D", "E" }

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
quoteChar - A character that is used to enclose string that might contain a separator
Returns:
An array of substrings of the given text
See Also:
parts(String, String), allParts(String, String), substrings(String, String), allSubstrings(String, String)

parts

public java.lang.String[] parts(java.lang.String text,
                                java.lang.String separators,
                                char[] quoteChars)
Returns an array of substrings of the given text.
The separators between the substrings are the given separators. Each character in the separators string is treated as a separator.
All consecutive separators are treated as one separator, so there will be no empty strings in the result.

The quote characters define that strings enclosed in a pair of such a quote character can contain separators and will not be split up.

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
quoteChars - All characters that can be used to enclose strings that might contain a separator
Returns:
An array of substrings of the given text
See Also:
parts(String, String), allParts(String, String), substrings(String, String), allSubstrings(String, String)

allParts

public java.lang.String[] allParts(java.lang.String text,
                                   java.lang.String separators)
Returns an array of substrings of the given text.
The separators between the substrings are specified in parameter separators. Each character in the separators string is treated as a separator.
For each separator that is followed immediately by another separator an empty string will be added to the result. There are no empty strings added to the result for a delimiter at the very beginning of at the very end.

Examples:

allParts( "/A/B//", "/" ) --> { "A", "B", "" }
allParts( "/A,B/C;D", ",;/" ) --> { "A", "B", "C", "D" }
allParts( "A/B,C/D", "," ) --> { "A/B", "C/D" }

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
Returns:
An array of substrings of the given text
See Also:
parts(String, String), substrings(String, String), allSubstrings(String, String)

allParts

public java.lang.String[] allParts(java.lang.String text,
                                   java.lang.String separators,
                                   char quoteChar)
Returns an array of substrings of the given text.
The separators between the substrings are specified in parameter separators. Each character in the separators string is treated as a separator.
For each separator that is followed immediately by another separator an empty string will be added to the result. There are no empty strings added to the result for a delimiter at the very beginning or at the very end.

Examples:

allParts( "/A/B//'C/D'", "/", '\'' ) --> { "A", "B", "", "C/D" }
allParts( "/A,\"B/C\";,;D", ",;/", '"' ) --> { "A", "B/C", "", "", "D" }

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
quoteChar - A character that is used to enclose string that might contain a separator
Returns:
An array of substrings of the given text
See Also:
parts(String, String), substrings(String, String), allSubstrings(String, String)

allParts

public java.lang.String[] allParts(java.lang.String text,
                                   java.lang.String separators,
                                   char[] quoteChars)
Returns an array of substrings of the given text.
The separators between the substrings are specified in parameter separators. Each character in the separators string is treated as a separator.
For each separator that is followed immediately by another separator an empty string will be added to the result. There are no empty strings added to the result for a delimiter at the very beginning or at the very end.

The quote character define the delimiters to be used to enclose sub-strings that contain separators but must not be split-up into different parts.

Parameters:
text - The string that should be split up into substrings
separators - All characters that should be recognized as a separator of substrings
quoteChars - The characters that are used to enclose strings that might contain a separator
Returns:
An array of substrings of the given text
See Also:
parts(String, String), substrings(String, String), allSubstrings(String, String)

substrings

public java.lang.String[] substrings(java.lang.String text,
                                     java.lang.String separator)
Returns the given text split up into an array of strings, at the occurrences of the separator string. In contrary to method parts() the separator is a one or many character sequence delimiter. That is, only the exact sequence of the characters in separator identifies the end of a substring. Subsequent occurrences of separator will be skipped. Therefore no empty strings ("") will be in the result array.

Parameters:
text - The text to be split up
separator - The string that separates the substrings
Returns:
An array of substrings not containing any separator anymore
See Also:
allSubstrings(String, String), parts(String, String), allParts(String, String)

allSubstrings

public java.lang.String[] allSubstrings(java.lang.String text,
                                        java.lang.String separator)
Returns the given text split up into an array of strings, at the occurrences of the separator string. In contrary to method allParts() the separator is a one or many character sequence delimiter. That is, only the exact sequence of the characters in separator identifies the end of a substring. Subsequent occurrences of separator are not skipped. They are added as empty strings to the result.

Parameters:
text - The text to be split up
separator - The string that separates the substrings
Returns:
An array of substrings not containing any separator anymore
See Also:
substrings(String, String), parts(String, String), allParts(String, String)

getDelimitedSubstring

public java.lang.String getDelimitedSubstring(java.lang.String text,
                                              IStringPair[] delimiters)
Returns the first substring that is enclosed by one of the specified delimiter pairs. It automatically chooses the delimiters that are found first from left to right.
The delimiters are not included in the return string.

Parameters:
text - The input string that contains the delimited part.
delimiters - The start and end delimiters to be looked for.
Returns:
The substring or if no delimiters are found, an empty string.

getDelimitedSubstring

public java.lang.String getDelimitedSubstring(java.lang.String text,
                                              IStringPair delimiter)
Returns the first substring that is enclosed by the specified delimiter pair.
The delimiters are not included in the return string.

Parameters:
text - The input string that contains the delimited part.
delimiter - The start and end delimiter to be looked for.
Returns:
The substring or if no delimiters are found, an empty string.

getDelimitedSubstring

public java.lang.String getDelimitedSubstring(java.lang.String text,
                                              java.lang.String startDelimiter,
                                              java.lang.String endDelimiter)
Returns the first substring that is enclosed by the specified delimiters.
The delimiters are not included in the return string.

Example:
getDelimitedSubstring( "This {placeholder} belongs to me", "{", "}" ) --> returns "placeholder"

Parameters:
text - The input string that contains the delimited part
startDelimiter - The start delimiter of the substring
endDelimiter - The end delimiter of the substring
Returns:
The substring or an empty string, if no delimiters are found.

getDelimitedSubstring

public java.lang.String getDelimitedSubstring(java.lang.String text,
                                              java.lang.String delimiter)
Returns the first substring that is enclosed by the specified delimiter.
The delimiters are not included in the return string.

Example:
getDelimitedSubstring( "File 'text.txt' not found.", "'", "'" ) --> returns "text.txt"

Parameters:
text - The input string that contains the delimited part
delimiter - The start and end delimiter of the substring
Returns:
The substring or an empty string, if no delimiters are found.

stackTrace

public java.lang.String stackTrace(java.lang.Throwable throwable)
Prints the stack trace of the specified throwable to a string and returns it.

leftPadCh

public java.lang.String leftPadCh(java.lang.String str,
                                  int len,
                                  char ch)
Returns the given string filled (on the left) up to the specified length with the given character.
Example: leftPadCh( "12", 6, '0' ) --> "000012"

leftPad

public java.lang.String leftPad(java.lang.String str,
                                int len)
Returns the given string filled (on the left) up to the specified length with spaces.
Example: leftPad( "XX", 4 ) --> " XX"

Parameters:
str - The string that has to be filled up to the specified length
len - The length of the result string

leftPadCh

public java.lang.String leftPadCh(int value,
                                  int len,
                                  char fillChar)
Returns the given integer as string filled (on the left) up to the specified length with the given fill character.
Example:
leftPad( 24, 5, '*' ) --> "***24"
leftPadCh( -288, 8, '#' ) --> "-####288"

leftPad

public java.lang.String leftPad(int value,
                                int len)
Returns the given integer as string filled (on the left) up to the specified length with zeroes.
Example: leftPad( 12, 4 ) --> "0012"

leftPadCh

public java.lang.String leftPadCh(long value,
                                  int len,
                                  char fillChar)
Returns the given long as string filled (on the left) up to the specified length with the given fill character.
Negative values will also be filled-up but the minus character will be the most left character.
Examples: leftPadCh( 24L, 5, '*' ) --> "***24"
leftPadCh( -109L, 8, '0' ) --> "-0000109"

leftPadCh

public void leftPadCh(java.lang.StringBuffer buffer,
                      long value,
                      int len,
                      char fillChar)
Returns the given long as string filled (on the left) up to the specified length with the given fill character.
Negative values will also be filled-up but the minus character will be the most left character.
Examples: leftPadCh( 24L, 5, '*' ) --> "***24"
leftPadCh( -109L, 8, '0' ) --> "-0000109"

Parameters:
buffer - The buffer to append the result to.
value - The value to fill-up to the specified length.
len - The length of the resulting string.
fillChar - The character to use for filling up.

leftPad

public java.lang.String leftPad(long value,
                                int len)
Returns the given long as string filled (on the left) up to the specified length with zeroes.
Example: leftPad( 12L, 4 ) --> "0012"

rightPadCh

public java.lang.String rightPadCh(java.lang.String str,
                                   int len,
                                   char ch)
Returns the given string filled (on the right) up to the specified length with the given character.
Example: rightPadCh( "34", 5, 'X' ) --> "34XXX"

rightPad

public java.lang.String rightPad(java.lang.String str,
                                 int len)
Returns the given string filled (on the right) up to the specified length with spaces.
Example: rightPad( "88", 6 ) --> "88 "

rightPadCh

public java.lang.String rightPadCh(int value,
                                   int len,
                                   char fillChar)
Returns the given integer as string filled (on the right) up to the specified length with the given character.
Example: rightPad( 32, 4, '#' ) --> "32##"

rightPad

public java.lang.String rightPad(int value,
                                 int len)
Returns the given integer as string filled (on the right) up to the specified length with spaces.
Example: rightPad( 17, 5 ) --> "17 "

rightPadCh

public java.lang.String rightPadCh(long value,
                                   int len,
                                   char fillChar)
Returns the given long as string filled (on the right) up to the specified length with the given character.
Example: rightPad( 32L, 7, '#' ) --> "32#####"

rightPad

public java.lang.String rightPad(long value,
                                 int len)
Returns the given integer as string filled (on the right) up to the specified length with spaces.
Example: rightPad( 233L, 5 ) --> "233 "

centerCh

public java.lang.String centerCh(java.lang.String str,
                                 int len,
                                 char ch)
Returns the given string filled equally left and right up to the specified length with the given character.
Example: centerCh( "A", 5, '_' ) --> "__A__"
Example: centerCh( "XX", 7, '+' ) --> "++XX+++"

center

public java.lang.String center(java.lang.String str,
                               int len)
Returns the given string filled (on the right and right) up to the specified length with spaces.
Example: center( "Mike", 10 ) --> " Mike "

append

public java.lang.String[] append(java.lang.String[] strings,
                                 java.lang.String string)
Returns the given string array extended by one element that hold the specified string.

append

public java.lang.String[] append(java.lang.String[] strings,
                                 java.lang.String[] appendStrings)
Returns an array of strings that contains all strings given by the first and second string array. The strings from the second array will be added at the end of the first array.

Parameters:
strings - The array of string to which to append
appendStrings - The string to be appended to the first array

appendIfNotThere

public java.lang.String[] appendIfNotThere(java.lang.String[] strings,
                                           java.lang.String appendString)
Returns an array of strings that contains all strings given in the first plus the specified string to append, if it is not already in the given array.

appendIfNotThere

public java.lang.String[] appendIfNotThere(java.lang.String[] strings,
                                           java.lang.String[] appendStrings)
Returns an array of strings that contains all strings given in the first plus all strings of the second array that are not already in the first array.

remove

public java.lang.String[] remove(java.lang.String[] strings,
                                 java.lang.String[] removeStrings)
Removes all string of the second array from the first array. Returns a new array of string that contains all remaining strings of the original strings array.

Parameters:
strings - The array from which to remove the strings
removeStrings - The strings to be removed

remove

public java.lang.String[] remove(java.lang.String[] strings,
                                 java.lang.String removeString)
Removes the given string from the specified string array. Returns a new array of string that contains all remaining strings of the original strings array.

Parameters:
strings - The array from which to remove the string
removeString - The string to be removed

removeNull

public java.lang.String[] removeNull(java.lang.String[] strings)
Removes all null values from the given string array. Returns a new string array that contains all none null values of the input array.

Parameters:
strings - The array to be cleared of null values

asString

public java.lang.String asString(java.lang.String[] strings)
Returns a string that contains all given strings concatenated and separated by comma.

Parameters:
strings - The array of strings that should be concatenated
Returns:
One string containing the concatenated strings separated by comma (",")

asString

public java.lang.String asString(java.lang.String[] strings,
                                 java.lang.String separator)
Returns a string that contains all given strings concatenated and separated by the specified separator.

Parameters:
strings - The array of strings that should be concatenated
separator - The separator between the strings (if null the default is used)
Returns:
One string containing the concatenated strings separated by separator

asString

public java.lang.String asString(java.util.Collection strings)
Returns a string that contains all strings from the given collection concatenated and separated by comma.

Parameters:
strings - The collection of strings that should be concatenated
Returns:
One string containing the concatenated strings separated by comma (",")

asString

public java.lang.String asString(java.util.Collection strings,
                                 java.lang.String separator)
Returns a string that contains all strings from the given collection concatenated and separated by the specified separator.

Parameters:
strings - The collection of strings that should be concatenated
separator - The separator between the strings
Returns:
One string containing the concatenated strings separated by separator

asSortedString

public java.lang.String asSortedString(java.lang.String[] strings)
Returns a string that contains all given strings sorted (in ascending order), concatenated and separated by the specified separator.
The comparator used is the java.text.Collator for the default locale.

Example: asSortedString( new String[] {"Carmen","Rose","Anna","Rita"} )
returns "Anna,Carmen,Rita,Rose"

Parameters:
strings - The array of strings that should be concatenated
Returns:
One string containing the concatenated strings separated by separator

asSortedString

public java.lang.String asSortedString(java.lang.String[] strings,
                                       java.lang.String separator)
Returns a string that contains all given strings sorted (in ascending order), concatenated and separated by the specified separator.
The comparator used is the java.text.Collator for the default locale.

Example: asSortedString( new String[] {"Mike","Ben","Gil"}, "/")
returns "Ben/Gil/Mike"

Parameters:
strings - The array of strings that should be concatenated
separator - The separator between the strings (must not be null)
Returns:
One string containing the concatenated strings separated by separator

asSortedString

public java.lang.String asSortedString(java.lang.String[] strings,
                                       java.lang.String separator,
                                       boolean ascending)
Returns a string that contains all given strings sorted, concatenated and separated by the specified separator.
The comparator used is the java.text.Collator for the default locale.

Example: asSortedString( new String[] {"Fred","Sam","Joe"}, ";", false)
returns "Sam;Joe;Fred"

Parameters:
strings - The array of strings that should be concatenated
separator - The separator between the strings (must not be null)
ascending - If true the strings are sorted ascending otherwise descending
Returns:
One string containing the concatenated strings separated by separator

asSortedString

public java.lang.String asSortedString(java.lang.String[] strings,
                                       java.lang.String separator,
                                       java.util.Comparator comparator)
Returns a string that contains all given strings sorted, concatenated and separated by the specified separator.

Parameters:
strings - The array of strings that should be concatenated
separator - The separator between the strings (must not be null)
comparator - A comparater that is used to compare the strings when sorting (must not be null)
Returns:
One string containing the sorted, concatenated strings separated by separator

asStrings

public java.lang.String[] asStrings(java.util.Collection collection)
Returns a string array containing all elements of the given collection. Of course the elements must be strings, otherwise ClassCastException will be thrown.
If the given collection is null, the result is null as well.

Parameters:
collection - A collection of strings

asString

public java.lang.String asString(java.util.Map map,
                                 java.lang.String elementSeparator,
                                 java.lang.String keyValueSeparator)
Converts the given map to a string utilizing the given separators. If the given elementSeparator is null it defaults to ','. If the given keyValueSeparator is null it defaults to '='. On all keys and values from the given map the toString() method gets called to add the string representation to the result. If the given map is null the result will also be null. If the given map is empty the result string will be an empty string.

A result string might look like this: "alpha=200,beta=872,delta=N/A"

Parameters:
map - The map that contains the key-value pairs
elementSeparator - The separator between the elements in the string representation
keyValueSeparator - The separator between the keys and values in the string representation
See Also:
toMap(String, String, String, Map)

asString

public java.lang.String asString(java.util.Map map,
                                 java.lang.String elementSeparator)
Converts the given map to a string utilizing the given separator. If the given elementSeparator is null it defaults to ','. The separator between keys and values will be '='. On all keys and values from the given map the toString() method gets called to add the string representation to the result. If the given map is null the result will also be null. If the given map is empty the result string will be an empty string.

A result string might look like this: "alpha=200,beta=872,delta=N/A"

Parameters:
map - The map that contains the key-value pairs
elementSeparator - The separator between the elements in the string representation
See Also:
asString(Map, String, String), toMap(String, String, String, Map)

asString

public java.lang.String asString(java.util.Map map)
Converts the given map to a string. The separator between the elements will be ','. The separator between keys and values will be '='. On all keys and values from the given map the toString() method gets called to add the string representation to the result. If the given map is null the result will also be null. If the given map is empty the result string will be an empty string.

A result string might look like this: "alpha=200,beta=872,delta=N/A"

Parameters:
map - The map that contains the key-value pairs
See Also:
asString(Map, String, String), toMap(String, String, String, Map)

indexOf

public int indexOf(java.lang.String[] strArray,
                   StringPattern pattern)
Returns the index of the first string in the given string array that matches the specified string pattern. If no string is found in the array the result is -1.

Parameters:
strArray - An array of string (may contain null elements)
pattern - The pattern the searched string must match
Returns:
The index of the matching string in the array or -1 if not found

indexOf

public int indexOf(java.lang.String[] strArray,
                   java.lang.String searchStr)
Returns the index of the specified string in the given string array. It returns the index of the first occurrence of the string. If the string is not found in the array the result is -1. The comparison of the strings is case-sensitive!

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
Returns:
The index of the string in the array or -1 if not found

indexOfIgnoreCase

public int indexOfIgnoreCase(java.lang.String[] strArray,
                             java.lang.String searchStr)
Returns the index of the specified string in the given string array. It returns the index of the first occurrence of the string. If the string is not found in the array the result is -1. The comparison of the strings is case-insensitive!

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
Returns:
The index of the string in the array or -1 if not found

indexOfString

public int indexOfString(java.lang.String[] strArray,
                         java.lang.String searchStr,
                         boolean ignoreCase)
Returns the index of the specified string in the given string array. It returns the index of the first occurrence of the string. If the string is not found in the array the result is -1. The comparison of the strings is case-insensitive if the ignoreCase parameter is true.

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
ignoreCase - If true, do case-insensitive comparison.
Returns:
The index of the string in the array or -1 if not found

indexOf

public int indexOf(char[] charArray,
                   char ch,
                   boolean ignoreCase)
Returns the index of the specified character in the given char array. It returns the index of the first occurrence of the character. If the character is not found in the array the result is -1.

Parameters:
charArray - An array of string (may contain null elements)
ch - The string to be looked up in the array (null allowed)
ignoreCase - If comparison should be case-insensitive
Returns:
The index of the character in the array or -1 if not found

contains

public boolean contains(java.lang.String[] strArray,
                        java.lang.String searchStr,
                        boolean ignoreCase)
Returns whether or not the specified string can be found in the given string array.

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
ignoreCase - Defines whether or not the comparison is case-sensitive.
Returns:
true, if the specified array contains the given string

contains

public boolean contains(java.lang.String[] strArray,
                        StringPattern pattern)
Returns whether or not a string can be found in the given string array that matches the specified string pattern.

Parameters:
strArray - An array of string (may contain null elements)
pattern - The string pattern to match against in the array (null allowed)
Returns:
true, if the specified array contains a string matching the pattern

contains

public boolean contains(java.lang.String[] strArray,
                        java.lang.String searchStr)
Returns whether or not the specified string can be found in the given string array. The comparison of the strings is case-sensitive!

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
Returns:
true, if the specified array contains the given string

containsIgnoreCase

public boolean containsIgnoreCase(java.lang.String[] strArray,
                                  java.lang.String searchStr)
Returns whether or not the specified string can be found in the given string array. The comparison of the strings is case-insensitive!

Parameters:
strArray - An array of string (may contain null elements)
searchStr - The string to be looked up in the array (null allowed)
Returns:
true, if the specified array contains the given string

copyFrom

public java.lang.String[] copyFrom(java.lang.String[] from,
                                   int start)
Returns all elements of string array from in a new array from index start up to the end. If start index is larger than the array's length, an empty array will be returned.

Parameters:
from - The string array the elements should be copied from
start - Index of the first element to copy

copyFrom

public java.lang.String[] copyFrom(java.lang.String[] from,
                                   int start,
                                   int end)
Returns all elements of string array from in a new array from index start up to index end (inclusive). If end is larger than the last valid index, it will be reduced to the last index. If end index is less than start index, an empty array will be returned.

Parameters:
from - The string array the elements should be copied from
start - Index of the first element to copy
end - Index of last element to be copied

copy

public java.lang.String[] copy(java.lang.String[] strings,
                               StringFilter filter)
Returns a new array that contains all strings of the given array that matched the specified filter.

Parameters:
strings - The string array to copy from (must not be null)
filter - The filter that determines which strings to copy (if null an empty array will be returned)

copy

public java.lang.String[] copy(java.lang.String[] strings)
Returns a copy (new array) that contains all the strings of the given array

copyWithout

public java.lang.String[] copyWithout(java.lang.String[] strings,
                                      StringFilter filter)
Returns a new array that contains all strings of the given array that do NOT match the specified filter.

Parameters:
strings - The string array to copy from (must not be null)
filter - The filter that determines which strings to copy (if null an empty array will be returned)

copy

public java.util.Collection copy(java.util.Collection strings,
                                 StringFilter filter)
Returns a new array that contains all strings of the given array that matched the specified filter.

Parameters:
strings - A collection of strings to copy from (must not be null)
filter - The filter that determines which strings to copy (if null an empty collection will be returned)

copyWithout

public java.util.Collection copyWithout(java.util.Collection strings,
                                        StringFilter filter)
Returns a new collection that contains all strings of the given collection that do NOT match the specified filter.

Parameters:
strings - A collection of strings to copy from (must not be null)
filter - The filter that determines which strings to copy (if null an empty collection will be returned)

cutTail

public java.lang.String cutTail(java.lang.String text,
                                java.lang.String separator)
Returns the portion of the given string that comes before the last occurrence of the specified separator.
If the separator could not be found in the given string, then the string is returned unchanged.

Examples:

cutTail( "A/B/C", "/" ) ; // returns "A/B"
cutTail( "A/B/C", "," ) ; // returns "A/B/C"

Parameters:
text - The string from which to cut off the tail
separator - The separator from where to cut off
Returns:
the string without the separator and without the characters after the separator
See Also:
prefix( String, String ), suffix( String, String ), cutHead( String, String ), startingFrom( String, String ), upTo( String, String )

cutHead

public java.lang.String cutHead(java.lang.String text,
                                java.lang.String separator)
Returns the portion of the given string that comes after the last occurrence of the specified separator.
If the separator could not be found in the given string, then the string is returned unchanged.

Examples:

cutHead( "A/B/C", "/" ) ; // returns "C"
cutHead( "A/B/C", "," ) ; // returns "A/B/C"

Parameters:
text - The string from which to cut off the head
separator - The separator up to which to cut off
Returns:
the string without the separator and without the characters before the separator
See Also:
prefix( String, String ), cutTail( String, String ), suffix( String, String ), startingFrom( String, String ), upTo( String, String )

splitNameValue

public java.lang.String[] splitNameValue(java.lang.String str,
                                         java.lang.String separator)
Returns a string array with two elements where the first is the attribute name and the second is the attribute value. Splits the given string at the first occurrence of separator and returns the piece before the separator in element 0 and the piece after the separator in the returned array. If the separator is not found, the first element contains the full string and the second an empty string.

Parameters:
str - The string that contains the name-value pair
separator - The separator between name and value

splitStringPair

public IStringPair splitStringPair(java.lang.String str,
                                   java.lang.String separator)
Returns a string pair where the first is the string before the first occurrence of the defined separator and the second string is everything after that separator. If the separator is not found, the first element contains the full string and the second an empty string.

Parameters:
str - The string that contains the name-value pair
separator - The separator between name and value

prefix

public java.lang.String prefix(java.lang.String str,
                               java.lang.String separator)
Returns the substring of the given string that comes before the first occurrence of the specified separator. If the string starts with a separator, the result will be an empty string. If the string doesn't contain the separator the method returns null.

Examples:

prefix( "A/B/C", "/" ) ; // returns "A"
prefix( "A/B/C", "," ) ; // returns null

Parameters:
str - The string of which the prefix is desired
separator - Separates the prefix from the rest of the string
See Also:
suffix( String, String ), cutTail( String, String ), cutHead( String, String ), startingFrom( String, String ), upTo( String, String )

suffix

public java.lang.String suffix(java.lang.String str,
                               java.lang.String separator)
Returns the substring of the given string that comes after the first occurrence of the specified separator. If the string ends with a separator, the result will be an empty string. If the string doesn't contain the separator the method returns null.

Examples:

suffix( "A/B/C", "/" ) ; // returns "B/C"
suffix( "A/B/C", "," ) ; // returns null

Parameters:
str - The string of which the suffix is desired
separator - Separates the suffix from the rest of the string
See Al