com.alkacon.geranium.client.util

Class ClientStringUtil

java.lang.Object

com.alkacon.geranium.client.util.ClientStringUtil

public final class ClientStringUtil
extends java.lang.Object

Additional string related helper methods.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	escapeHtml(java.lang.String source) Replaces occurrences of special control characters in the given input with a HTML representation.
static java.lang.String	formatResourceName(java.lang.String name, int maxLength) Formats a resource name that it is displayed with the maximum length and path information is adjusted.
static java.lang.String	getMessage(java.lang.Throwable t) Returns the exception message.
static java.lang.String	getStackTrace(java.lang.Throwable t, java.lang.String separator) Returns the stack trace of the Throwable as a string.
static java.lang.String	getStackTraceAsString(java.lang.StackTraceElement[] trace, java.lang.String separator) Returns the stack trace as a string.
static boolean	isEmpty(java.lang.String value) Returns true if the provided String is either null or the empty String "".
static boolean	isEmptyOrWhitespaceOnly(java.lang.String value) Returns true if the provided String is either null or contains only white spaces.
static boolean	isNotEmpty(java.lang.String value) Returns true if the provided String is neither null nor the empty String "".
static boolean	isNotEmptyOrWhitespaceOnly(java.lang.String value) Returns true if the provided String is neither null nor contains only white spaces.
static boolean	isPrefixPath(java.lang.String firstPath, java.lang.String secondPath) Checks whether one path is a prefix path of another, i.e. its path components are the initial path components of the second path.
static java.lang.String	joinPaths(java.lang.String... paths) Concatenates multiple paths and separates them with '/'.
static <E> java.lang.String	listAsString(java.util.List<E> list, java.lang.String separator) Returns a string representation for the given list using the given separator.
static double	parseFloat(java.lang.String str) The parseFloat() function parses a string and returns a float.
static int	parseInt(java.lang.String str) The parseInt() function parses a string and returns an integer.
static void	pushArray(com.google.gwt.core.client.JavaScriptObject array, java.lang.String s) Pushes a String into a javascript array.
static java.lang.String	shortenString(java.lang.String text, int maxLength) Shortens the string to the given maximum length.
static java.lang.String[]	splitAsArray(java.lang.String str, java.lang.String splitter) Splits a String into substrings along the provided char delimiter and returns the result as an Array of Substrings.
static java.util.List<java.lang.String>	splitAsList(java.lang.String source, char delimiter, boolean trim) Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.
static java.util.List<java.lang.String>	splitAsList(java.lang.String source, java.lang.String delimiter) Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
static java.util.List<java.lang.String>	splitAsList(java.lang.String source, java.lang.String delimiter, boolean trim) Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
static java.util.Map<java.lang.String,java.lang.String>	splitAsMap(java.lang.String source, java.lang.String paramDelim, java.lang.String keyValDelim) Splits a String into substrings along the provided paramDelim delimiter, then each substring is treat as a key-value pair delimited by keyValDelim.
static java.lang.String	substitute(java.lang.String source, java.lang.String searchString, java.lang.String replaceString) Substitutes searchString in the given source String with replaceString.

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public static java.lang.String getMessage(java.lang.Throwable t)

Returns the exception message.

Parameters:

t - the exception to get the message for

Returns:

the exception message

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable t,
                             java.lang.String separator)

Returns the stack trace of the Throwable as a string.

Parameters:

t - the Throwable for which the stack trace should be returned

separator - the separator between the lines of the stack trace

Returns:

a string representing a stack trace

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.StackTraceElement[] trace,
                                     java.lang.String separator)

Returns the stack trace as a string.

Parameters:

trace - the stack trace

separator - the separator between the lines of the stack trace

Returns:

a string representing a stack trace

parseFloat

public static double parseFloat(java.lang.String str)

The parseFloat() function parses a string and returns a float.

Only the first number in the string is returned. Leading and trailing spaces are allowed.

Parameters:

str - the string to be parsed

Returns:

the parsed number

parseInt

public static int parseInt(java.lang.String str)

The parseInt() function parses a string and returns an integer.

Only the first number in the string is returned. Leading and trailing spaces are allowed. If the first character cannot be converted to a number, parseInt() returns zero.

Parameters:

str - the string to be parsed

Returns:

the parsed number

pushArray

public static void pushArray(com.google.gwt.core.client.JavaScriptObject array,
             java.lang.String s)

Pushes a String into a javascript array.

Parameters:

array - the array to push the String into

s - the String to push into the array

shortenString

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

Shortens the string to the given maximum length.

Will include HTML entity ellipses replacing the cut off text.

Parameters:

text - the string to shorten

maxLength - the maximum length

Returns:

the shortened string

escapeHtml

public static java.lang.String escapeHtml(java.lang.String source)

Replaces occurrences of special control characters in the given input with a HTML representation.

This method currently replaces line breaks to <br/> and special HTML chars like < > & " with their HTML entity representation.

Parameters:

source - the String to escape

Returns:

the escaped String

substitute

public static java.lang.String substitute(java.lang.String source,
                          java.lang.String searchString,
                          java.lang.String replaceString)

Substitutes searchString in the given source String with replaceString.

This is a high-performance implementation which should be used as a replacement for String.replaceAll(java.lang.String, java.lang.String) in case no regular expression evaluation is required.

Parameters:

source - the content which is scanned

searchString - the String which is searched in content

replaceString - the String which replaces searchString

Returns:

the substituted String

formatResourceName

public static java.lang.String formatResourceName(java.lang.String name,
                                  int maxLength)

Formats a resource name that it is displayed with the maximum length and path information is adjusted.

In order to reduce the length of the displayed names, single folder names are removed/replaced with ... successively, starting with the second! folder. The first folder is removed as last.

Example: formatResourceName("/myfolder/subfolder/index.html", 21) returns /myfolder/.../index.html.

Parameters:

name - the resource name to format

maxLength - the maximum length of the resource name (without leading /...)

Returns:

the formatted resource name

isEmpty

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

Returns true if the provided String is either null or the empty String "".

Parameters:

value - the value to check

Returns:

true, if the provided value is null or the empty String, false otherwise

isEmptyOrWhitespaceOnly

public static boolean isEmptyOrWhitespaceOnly(java.lang.String value)

Returns true if the provided String is either null or contains only white spaces.

Parameters:

value - the value to check

Returns:

true, if the provided value is null or contains only white spaces, false otherwise

isNotEmpty

public static boolean isNotEmpty(java.lang.String value)

Returns true if the provided String is neither null nor the empty String "".

Parameters:

value - the value to check

Returns:

true, if the provided value is not null and not the empty String, false otherwise

isNotEmptyOrWhitespaceOnly

public static boolean isNotEmptyOrWhitespaceOnly(java.lang.String value)

Returns true if the provided String is neither null nor contains only white spaces.

Parameters:

value - the value to check

Returns:

true, if the provided value is null or contains only white spaces, false otherwise

joinPaths

public static java.lang.String joinPaths(java.lang.String... paths)

Concatenates multiple paths and separates them with '/'.

Consecutive slashes will be reduced to a single slash in the resulting string. For example, joinPaths("/foo/", "/bar", "baz") will return "/foo/bar/baz".

Parameters:

paths - the array of paths

Returns:

the joined path

listAsString

public static <E> java.lang.String listAsString(java.util.List<E> list,
                                java.lang.String separator)

Returns a string representation for the given list using the given separator.

Type Parameters:

E - type of list entries

Parameters:

list - the list to write

separator - the item separator string

Returns:

the string representation for the given map

splitAsArray

public static java.lang.String[] splitAsArray(java.lang.String str,
                              java.lang.String splitter)

Splits a String into substrings along the provided char delimiter and returns the result as an Array of Substrings.

Parameters:

str - the String to split

splitter - the delimiter to split at

Returns:

the Array of substrings

splitAsList

public static java.util.List<java.lang.String> splitAsList(java.lang.String source,
                                           char delimiter,
                                           boolean trim)

Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.

Parameters:

source - the String to split

delimiter - the delimiter to split at

trim - flag to indicate if leading and trailing white spaces should be omitted

Returns:

the List of splitted Substrings

splitAsList

public static java.util.List<java.lang.String> splitAsList(java.lang.String source,
                                           java.lang.String delimiter)

Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.

Parameters:

source - the String to split

delimiter - the delimiter to split at

Returns:

the Array of splitted Substrings

splitAsList

public static java.util.List<java.lang.String> splitAsList(java.lang.String source,
                                           java.lang.String delimiter,
                                           boolean trim)

Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.

Parameters:

source - the String to split

delimiter - the delimiter to split at

trim - flag to indicate if leading and trailing white spaces should be omitted

Returns:

the Array of splitted Substrings

isPrefixPath

public static boolean isPrefixPath(java.lang.String firstPath,
                   java.lang.String secondPath)

Checks whether one path is a prefix path of another, i.e. its path components are the initial path components of the second path.

It is not enough to just use String.startsWith(java.lang.String, int), because we want /foo/bar to be a prefix path of /foo/bar/baz, but not of /foo/bar42.

Parameters:

firstPath - the first path

secondPath - the second path

Returns:

true if the first path is a prefix path of the second path

splitAsMap

public static java.util.Map<java.lang.String,java.lang.String> splitAsMap(java.lang.String source,
                                                          java.lang.String paramDelim,
                                                          java.lang.String keyValDelim)

Splits a String into substrings along the provided paramDelim delimiter, then each substring is treat as a key-value pair delimited by keyValDelim.

Parameters:

source - the string to split

paramDelim - the string to delimit each key-value pair

keyValDelim - the string to delimit key and value

Returns:

a map of splitted key-value pairs