com.communote.common.string

Class StringHelper

java.lang.Object

com.communote.common.string.StringHelper

public final class StringHelper
extends Object

Helper class for Strings.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static String	cleanString(String string) Cleans a string, removes whitespaces on start and end, and removes multiple whitespaces.
static List<String>	cleanStringList(List<String> list) Cleans a List of Strings, handle null parameter
static String	cleanUpString(String str, String cleanUpChar, String replaceChar) Remove the cleanUpChar from the given string by stripping it from the start and end.
static Long	getStringAsLong(String value, Long fallback) Converts a string containing a decimal number into a long.
static Long[]	getStringAsLongArray(String value) Gets the string as long array.
static Long[]	getStringAsLongArray(String[] values)
static List<Long>	getStringAsLongList(String value) Convert a string of longs which are separated by commas into a list of Long objects.
static List<Long>	getStringAsLongList(String[] values)
static List<Long>	getStringAsLongList(String value, boolean ignoreValuesEqualLessZero) Convert a string of longs which are separated by commas into a list of Long objects.
static List<Long>	getStringAsLongList(String value, String separator) Convert a string of longs which are separated by a given string into a list of Long objects.
static List<Long>	getStringAsLongList(String value, String separator, boolean ignoreValuesEqualLessZero) Convert a string of longs which are separated by a given string into a list of Long objects.
static Map<String,String>	getStringAsMap(String mapping) Converts a string of the form 'k1=v1,k2=v2,k3=v3' into a map with k's as key and the v's as the associated values.
static String	replaceCharacter(String source, char charToReplace, String replacement) Replaces all occurrences of a character with the replacement.
static String	toString(Collection<?> coll) Build a string containing toString for each sub element.
static String	toString(Map<String,String> mapping) Converts the map into a string of the form 'k1=v1,k2=v2,k3=v3'.
static String	toString(Object[] array, String separator) Build a string of the array in the form "o1, o2, o3" if separator is ", "
static String	truncateMiddle(String string, int maxLength, String ellipses) To cut out middle part of a String.

Methods inherited from class java.lang.Object

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

Method Detail

cleanString

public static String cleanString(String string)

Cleans a string, removes whitespaces on start and end, and removes multiple whitespaces. Handles null parameter and returns an empty string.

Parameters:

string - the string

Returns:

the cleaned string

cleanStringList

public static List<String> cleanStringList(List<String> list)

Cleans a List of Strings, handle null parameter

Parameters:

list - the list

Returns:

the cleaned list

cleanUpString

public static String cleanUpString(String str,
                                   String cleanUpChar,
                                   String replaceChar)

Remove the cleanUpChar from the given string by stripping it from the start and end. If it still exists use the replaceChar to remove it. Example: str="%bla%bla", cleanUpChar="%", replaceChar="-" will return "bla-bla"

Parameters:

str - the string to cleanup

cleanUpChar - the string to replace

replaceChar - the string to replace with

Returns:

the cleaned string

getStringAsLong

public static Long getStringAsLong(String value,
                                   Long fallback)

Converts a string containing a decimal number into a long. If the conversion is not possible the fallback will be returned.

Parameters:

value - the value to convert

fallback - the fallback to return if conversion failed

Returns:

the long value

getStringAsLongArray

public static Long[] getStringAsLongArray(String value)

Gets the string as long array.

Parameters:

value - the value

Returns:

the string as long array

getStringAsLongArray

public static Long[] getStringAsLongArray(String[] values)

Parameters:

values - The values to parse.

Returns:

The values as Long array.

getStringAsLongList

public static List<Long> getStringAsLongList(String value)

Convert a string of longs which are separated by commas into a list of Long objects.

Parameters:

value - the value to process

Returns:

the list of Longs

getStringAsLongList

public static List<Long> getStringAsLongList(String value,
                                             boolean ignoreValuesEqualLessZero)

Convert a string of longs which are separated by commas into a list of Long objects.

Parameters:

value - the value to process

ignoreValuesEqualLessZero - if true, parsed long values <= 0 will not be added to the returning list

Returns:

the list of Longs

getStringAsLongList

public static List<Long> getStringAsLongList(String value,
                                             String separator)

Convert a string of longs which are separated by a given string into a list of Long objects.

Parameters:

value - the value to process

separator - the separator

Returns:

the list of Longs

getStringAsLongList

public static List<Long> getStringAsLongList(String value,
                                             String separator,
                                             boolean ignoreValuesEqualLessZero)

Convert a string of longs which are separated by a given string into a list of Long objects.

Parameters:

value - the value to process

separator - the separator

ignoreValuesEqualLessZero - if true, parsed long values <= 0 will not be added to the returning list

Returns:

the list of Longs

getStringAsLongList

public static List<Long> getStringAsLongList(String[] values)

Parameters:

values - The values to parse.

Returns:

The values as list of Long

getStringAsMap

public static Map<String,String> getStringAsMap(String mapping)

Converts a string of the form 'k1=v1,k2=v2,k3=v3' into a map with k's as key and the v's as the associated values.

Parameters:

mapping - the string based mapping to convert

Returns:

the created map

replaceCharacter

public static String replaceCharacter(String source,
                                      char charToReplace,
                                      String replacement)

Replaces all occurrences of a character with the replacement.

Parameters:

source - the source to process

charToReplace - the character to replace

replacement - the replacement for the character

Returns:

the processed string

toString

public static String toString(Collection<?> coll)

Build a string containing toString for each sub element. The result will be in the form [a,b,null,c ...]

Parameters:

coll - The collection to use

Returns:

The String

toString

public static String toString(Map<String,String> mapping)

Converts the map into a string of the form 'k1=v1,k2=v2,k3=v3'. This method does no escaping, thus keys and values should not contain commas or equal signs. The counterpart of this function is getStringAsMap(String).

Parameters:

mapping - the map to convert

Returns:

the string

toString

public static String toString(Object[] array,
                              String separator)

Build a string of the array in the form "o1, o2, o3" if separator is ", "

Parameters:

array - an array of objects which should be "stringed"

separator - the separator to use

Returns:

null if array is null otherwise the objects strings separated by the separator

truncateMiddle

public static String truncateMiddle(String string,
                                    int maxLength,
                                    String ellipses)

To cut out middle part of a String.

Parameters:

string - the string to truncate

maxLength - the max length of a string

ellipses - the replacement in case of cutting the string

Returns:

The abbreviated string if the string exceeds the max length otherwise the original string is returned.