org.pf.text
Class StringUtil

java.lang.Object
  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.

Version:

2.0

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	STR_CR Constant for the String representation of the carriage return character
static java.lang.String	STR_NEWLINE Constant for the String representation of the new line character
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

Constructor Summary

StringUtil()

Method Summary

java.lang.String[]	allParts(java.lang.String text, java.lang.String delimiters) 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 occurrances 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.
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	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	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.
protected void	collectParts(java.util.List list, java.util.StringTokenizer tokenizer)
protected void	collectParts(java.util.List list, java.util.StringTokenizer tokenizer, java.lang.String delimiter)
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.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).
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 stands after the last occurance 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 occurance of the specified separator.
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.
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.
protected int	indexOfString(java.lang.String[] strArray, java.lang.String searchStr, boolean ignoreCase)
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(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(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.
protected java.lang.String	padCh(java.lang.String str, int len, char ch, boolean left)
java.lang.String[]	parts(java.lang.String text, java.lang.String delimiters) Returns an array of substrings of the given text.
protected java.lang.String[]	parts(java.lang.String text, java.lang.String delimiters, boolean all) 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 occurance of the specified separator.
protected java.lang.String	prefix(java.lang.String str, java.lang.String separator, boolean returnNull) Returns the substring of the given string that comes before the first occurance 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.
protected java.lang.String[]	removeFromStringArray(java.lang.String[] strings, java.lang.String[] removeStrings) Removes the given strings from the 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	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(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(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[]	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.
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 occurance 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 occurrances of the separator string.
protected java.lang.String[]	substrings(java.lang.String text, java.lang.String separator, boolean all) Returns the given text split up into an array of strings, at the occurrances 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 occurance of the specified separator.
protected java.lang.String	suffix(java.lang.String str, java.lang.String separator, boolean returnNull) Returns the substring of the given string that comes after the first occurance of the specified separator.
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.
protected java.lang.String	trimSeparator(java.lang.String text, java.lang.String separator) Cuts off all leading and trailing occurences of separator in 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 occurance 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

clone, equals, finalize, 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

Constructor Detail

StringUtil

public StringUtil()

Method Detail

current

public static StringUtil current()

Returns the one and only instance of this class.

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

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 splitted into whitespace separated words

Returns:

An array of substrings of the given text

See Also:

parts(String, String)

parts

public java.lang.String[] parts(java.lang.String text,
                                java.lang.String delimiters)

Returns an array of substrings of the given text.
The separators between the substrings are the given delimiters. Each character in the delimiter string is treated as a separator.
All consecutive delimiters are treated as one delimiter, that is there will be no empty strings in the result.

Parameters:

text - The string that should be splitted into substrings

delimiters - All characters that should be recognized as a separator or substrings

Returns:

An array of substrings of the given text

See Also:

allParts(String, String), substrings(String, String), allSubstrings(String, String)

allParts

public java.lang.String[] allParts(java.lang.String text,
                                   java.lang.String delimiters)

Returns an array of substrings of the given text.
The separators between the substrings are the given delimiters. Each character in the delimiter string is treated as a separator.
For each delimiter that is followed immediately by another delimiter 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 splitted into substrings

delimiters - All characters that should be recognized as a separator or substrings

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 occurrances 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 occurences 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 occurrances 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 occurences 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,
                                              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"

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"

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 "

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,
                                 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

Returns:

One string containing the concatenated strings separated by separator

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 (",")

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

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

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 occurance 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 stands after the last occurance 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 occurance 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

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 occurance 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 occurance 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 Also:

prefix( String, String ), cutTail( String, String ), cutHead( String, String ), startingFrom( String, String ), upTo( String, String )

upTo

public java.lang.String upTo(java.lang.String str,
                             java.lang.String separator)

Returns the substring of the given string that comes before the first occurance 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 the whole string unchanged.

Examples:

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

Parameters:

str - The string of which the prefix is desired

separator - Separates the prefix from the rest of the string

See Also:

prefix( String, String ), cutTail( String, String ), cutHead( String, String ), startingFrom( String, String ), suffix( String, String )

startingFrom

public java.lang.String startingFrom(java.lang.String str,
                                     java.lang.String separator)

Returns the substring of the given string that comes after the first occurance of the specified separator. If the string doesn't contain the separator the method returns the whole string unchanged.

Examples:

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

Parameters:

str - The string of which the suffix is desired

separator - Separates the suffix from the rest of the string

See Also:

prefix( String, String ), cutTail( String, String ), cutHead( String, String ), suffix( String, String ), upTo( String, String )

reverse

public java.lang.String reverse(java.lang.String str)

Returns a string that contains all characters of the given string in reverse order.

toMap

public 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. If the specified map is null a new empty java.util.Hashtable will be created.
The string is split up into elements separated by the elementSeparator parameter. If this parameter is null the default separator "," is used.
After that each part is split up to a key-value pair separated by the keyValueSeparator parameter. If this parameter is null the default "=" is used.
Then the key-value pairs are added to the map and the map is returned.

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

elementSeparator - The separator between the elements of the list

keyValueSeparator - The separator between the keys and values

map - The map to which the key-value pairs are added

asMap

public java.util.Map asMap(java.lang.String str)

Returns a new map object that contains all key-value pairs of the specified string.
The separator between the elements is assumed to be "," and "=" between key and value.

Example:
"main=Fred,support1=John,support2=Stella,manager=Oscar"

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string with the list of key-value pairs

asMap

public 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.
The separator between the keys and values is assumed to be "=".

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

elementSeparator - The separator between the elements of the list

asMap

public 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.

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

elementSeparator - The separator between the elements of the list

keyValueSeparator - The separator between the keys and values

toMap

public 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.
The separator between the keys and values is assumed to be "=".

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

elementSeparator - The separator between the elements of the list

map - The map to which the key-value pairs are added

toMap

public 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.
The separator between the elements is assumed to be "," and "=" between key and value.

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

map - The map to which the key-value pairs are added

asProperties

public java.util.Properties asProperties(java.lang.String str)

Adds all key-value pairs of the given string to a new properties object.
The separator between the elements is assumed to be "," and "=" between key and value.

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

toProperties

public 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.
The separator between the elements is assumed to be "," and "=" between key and value.

Be aware that all leading and trailing whitespaces of keys and values will be removed!

Parameters:

str - The string that contains the list of key-value pairs

properties - The properties where the key-value pairs should be added

trimSeparator

protected java.lang.String trimSeparator(java.lang.String text,
                                         java.lang.String separator)

Cuts off all leading and trailing occurences of separator in text.

parts

protected java.lang.String[] parts(java.lang.String text,
                                   java.lang.String delimiters,
                                   boolean all)

Returns an array of substrings of the given text.
The separators between the substrings are the given delimiters. Each character in the delimiter string is treated as a separator.

Parameters:

text - The string that should be splitted into substrings

delimiters - All characters that should be recognized as a separator or substrings

all - If true, empty elements will be returned, otherwise thye are skipped

Returns:

An array of substrings of the given text

collectParts

protected void collectParts(java.util.List list,
                            java.util.StringTokenizer tokenizer)

collectParts

protected void collectParts(java.util.List list,
                            java.util.StringTokenizer tokenizer,
                            java.lang.String delimiter)

substrings

protected java.lang.String[] substrings(java.lang.String text,
                                        java.lang.String separator,
                                        boolean all)

Returns the given text split up into an array of strings, at the occurrances 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. Parameter all defines whether empty strings between consecutive separators are added to the result or not.

Parameters:

text - The text to be split up

separator - The string that separates the substrings

all - If true, empty strings are added, otherwise skipped

Returns:

An array of substrings not containing any separator anymore

See Also:

parts(String, String, boolean)

padCh

protected java.lang.String padCh(java.lang.String str,
                                 int len,
                                 char ch,
                                 boolean left)

indexOfString

protected int indexOfString(java.lang.String[] strArray,
                            java.lang.String searchStr,
                            boolean ignoreCase)

prefix

protected java.lang.String prefix(java.lang.String str,
                                  java.lang.String separator,
                                  boolean returnNull)

Returns the substring of the given string that comes before the first occurance 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 or the whole string, depending on the returnNull flag.

Parameters:

str - The string of which the prefix is desired

separator - Separates the prefix from the rest of the string

returnNull - Specifies if null will be returned if no separator is found

suffix

protected java.lang.String suffix(java.lang.String str,
                                  java.lang.String separator,
                                  boolean returnNull)

Returns the substring of the given string that comes after the first occurance 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 or the whole string, depending on the returnNull flag.

Parameters:

str - The string of which the suffix is desired

separator - Separates the suffix from the rest of the string

returnNull - Specifies if null will be returned if no separator is found

removeFromStringArray

protected java.lang.String[] removeFromStringArray(java.lang.String[] strings,
                                                   java.lang.String[] removeStrings)

Removes the given strings from the array. If removeStrings is null it means that all null values are removed from the first array.