sapphire.util

Class StringUtil

java.lang.Object

com.labvantage.sapphire.gwt.shared.util.StringUtil

sapphire.util.StringUtil

public class StringUtil
extends com.labvantage.sapphire.gwt.shared.util.StringUtil

Provides a collection of String utility classes

Constructor Summary

Constructors

Constructor and Description
StringUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	arrayToString(java.lang.String[] array, java.lang.String delimiter) converts an array to a string with delimiter
static java.lang.String	escape(java.lang.String in) Escapes a String as per the JavaScript escaping mechanism by converting (most) non-alphanumerics to %nn
static java.lang.String	escapeXMLAttributeValue(java.lang.String attributeValue)
static java.lang.String[]	getExpressionTokens(java.lang.String input) Returns a list of tokens (delimetered by [token]) in a string for a groovy or regular calculation expression
static long	getLen(java.lang.String str) Returns the length of a string checking for nulls as well as standard length
static java.lang.String	getRandomString(int length) Fetches you a random string
static java.lang.String	getRGBHex(int value) Returns an RGB numeric value in Hex format
static java.lang.String[]	getTokens(java.lang.String input) Returns a list of tokens (delimetered by [token]) in a string
static java.lang.String[]	getTokens(java.lang.String input, java.lang.String starttoken, java.lang.String endtoken) Returns a list of tokens (delimetered by [token]) in a string
static java.lang.String[]	getTokens(java.lang.String input, java.lang.String starttoken, java.lang.String endtoken, boolean ignoreCDATA) Returns a list of tokens (delimetered by [token]) in a string
static java.lang.String[]	getTokens(java.lang.String input, java.lang.String starttoken, java.lang.String endtoken, boolean ignoreCDATA, boolean keepDuplicate) Returns a list of tokens (delimetered by [token]) in a string
static java.lang.String	getYN(java.lang.String input, java.lang.String defaultresponse) Converts Yes/No, Y/N, yes/no, true/false, TRUE/FALSE etc.
static java.lang.String	initCaps(java.lang.String in) Converts the intial letter to caps in a string
static java.lang.String	padLeft(java.lang.String input, int desiredlength) Pads the left side of a String with spaces to the desired length
static java.lang.String	padLeft(java.lang.String input, int desiredlength, char padchar) Pads the left side of a String with a specified character to the desired length
static java.lang.String	padRight(java.lang.String input, int desiredlength) Pads the right side of a String with a specified character to the desired length
static java.lang.String	padRight(java.lang.String input, int desiredlength, char padchar) Pads the right side of a String with a specified character to the desired length
static java.lang.String	repeat(java.lang.String basestring, int repeat) Returns a String that represents a given string repeated 'n' times
static java.lang.String	repeat(java.lang.String basestring, int repeat, java.lang.String separator) Returns a String that represents a given string repeated 'n' times delimited by the separator
static java.lang.String	replaceAll(java.lang.String inputString, java.lang.String oldString, java.lang.String newString) Replaces all instances of a string in a string
static java.lang.String	replaceAll(java.lang.String inputString, java.lang.String oldString, java.lang.String newString, boolean caseSensitive) Replaces all instances of a string in a string
static java.lang.String[]	split(java.lang.String input, java.lang.String delimeter) Splits a string into an array of substrings
static java.lang.String[]	split(java.lang.String input, java.lang.String delimeter, boolean trim) Splits a string into an array of substrings
static java.lang.String	unescape(java.lang.String in) Unescapes a String as per the JavaScript unescaping mechanism by converting %nn text to their ascii equivalent

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtil

public StringUtil()

Method Detail

arrayToString

public static java.lang.String arrayToString(java.lang.String[] array,
                                             java.lang.String delimiter)

converts an array to a string with delimiter

Parameters:

array - The array to convert

delimiter - the delimiter (defaults to ;).

Returns:

the new String from the array

split

public static java.lang.String[] split(java.lang.String input,
                                       java.lang.String delimeter)

Splits a string into an array of substrings

Parameters:

input - the string to be parsed.

delimeter - character(s) that indicate breaks in the source String. Note that two adjacent delimiters constitutes an additional blank entry in the final list. For example, parsing "A;B;;C;" will return five substrings.

Returns:

list of parsed substrings (including blank values for adjacent delimeters)

split

public static java.lang.String[] split(java.lang.String input,
                                       java.lang.String delimeter,
                                       boolean trim)

Splits a string into an array of substrings

Parameters:

input - the string to be parsed.

delimeter - character(s) that indicate breaks in the source String.

trim - removes white space after spliting the values Note that two adjacent delimiters constitutes an additional blank entry in the final list. For example, parsing "A;B;;C;" will return five substrings.

Returns:

list of parsed substrings (including blank values for adjacent delimeters)

replaceAll

public static java.lang.String replaceAll(java.lang.String inputString,
                                          java.lang.String oldString,
                                          java.lang.String newString,
                                          boolean caseSensitive)

Replaces all instances of a string in a string

Parameters:

inputString - The String to change things in

oldString - the text that is to be replace.

newString - the new text the old text will be replaced with

caseSensitive - boolean to indicate whether matching is case sensitive or not

Returns:

the new modified String

replaceAll

public static java.lang.String replaceAll(java.lang.String inputString,
                                          java.lang.String oldString,
                                          java.lang.String newString)

Replaces all instances of a string in a string

Parameters:

inputString - The String to change things in

oldString - the text that is to be replace.

newString - the new text the old text will be replaced with

Returns:

the new modified String

getRandomString

public static java.lang.String getRandomString(int length)

Fetches you a random string

Parameters:

length -

Returns:

the new String

getRGBHex

public static java.lang.String getRGBHex(int value)

Returns an RGB numeric value in Hex format

Parameters:

value - Numeric value representing the RGB value (65536*Blue)+(256+Green)+(Red)

Returns:

The RGB value in Hex. For Red, Green & Blue values each less than 256, the return is guaranteed to be a six character string

repeat

public static java.lang.String repeat(java.lang.String basestring,
                                      int repeat)

Returns a String that represents a given string repeated 'n' times

Parameters:

basestring - the string that is to be repeated

repeat - the number of times to repeat

Returns:

A string composed of basestring repeated 'n' times

repeat

public static java.lang.String repeat(java.lang.String basestring,
                                      int repeat,
                                      java.lang.String separator)

Returns a String that represents a given string repeated 'n' times delimited by the separator

Parameters:

basestring - the string that is to be repeated

repeat - the number of times to repeat

separator - the string to be padded between every repetition

Returns:

A string composed of basestring repeated 'n' times

getLen

public static long getLen(java.lang.String str)

Returns the length of a string checking for nulls as well as standard length

Parameters:

str - the string to be checked.

Returns:

the length of the String, or 0 if the String is null

getExpressionTokens

public static java.lang.String[] getExpressionTokens(java.lang.String input)

Returns a list of tokens (delimetered by [token]) in a string for a groovy or regular calculation expression

Parameters:

input - the String to be parsed.

Returns:

list of the tokens inside the String minus any duplicates, and minus the delimeters.

getTokens

public static java.lang.String[] getTokens(java.lang.String input)

Returns a list of tokens (delimetered by [token]) in a string

Parameters:

input - the String to be parsed.

Returns:

list of the tokens inside the String minus any duplicates, and minus the square brackets.

getTokens

public static java.lang.String[] getTokens(java.lang.String input,
                                           java.lang.String starttoken,
                                           java.lang.String endtoken)

Returns a list of tokens (delimetered by [token]) in a string

Parameters:

input - the String to be parsed.

starttoken - the starting delimeter text.

endtoken - the ending delimeter text.

Returns:

list of the tokens inside the String minus any duplicates, and minus the delimiters.

getTokens

public static java.lang.String[] getTokens(java.lang.String input,
                                           java.lang.String starttoken,
                                           java.lang.String endtoken,
                                           boolean ignoreCDATA)

Returns a list of tokens (delimetered by [token]) in a string

Parameters:

input - the String to be parsed.

starttoken - the starting delimeter text.

endtoken - the ending delimeter text.

ignoreCDATA - ignore CDATA characters clashes

Returns:

list of the tokens inside the String minus any duplicates, and minus the delimiters.

getTokens

public static java.lang.String[] getTokens(java.lang.String input,
                                           java.lang.String starttoken,
                                           java.lang.String endtoken,
                                           boolean ignoreCDATA,
                                           boolean keepDuplicate)

Returns a list of tokens (delimetered by [token]) in a string

Parameters:

input - the String to be parsed.

starttoken - the starting delimeter text.

endtoken - the ending delimeter text.

ignoreCDATA - ignore CDATA characters clashes

keepDuplicate - whether to keep duplicate tokens

Returns:

list of the tokens inside the String minus the delimiters.

padLeft

public static java.lang.String padLeft(java.lang.String input,
                                       int desiredlength)

Pads the left side of a String with spaces to the desired length

Parameters:

input - String to be padded.

desiredlength - required final length of the String. Note that the input String is never truncated.

Returns:

the padded string

padLeft

public static java.lang.String padLeft(java.lang.String input,
                                       int desiredlength,
                                       char padchar)

Pads the left side of a String with a specified character to the desired length

Parameters:

input - String to be padded.

desiredlength - required final length of the String. Note that the input String is never truncated.

padchar - the character to pad the String with.

Returns:

the padded string

padRight

public static java.lang.String padRight(java.lang.String input,
                                        int desiredlength)

Pads the right side of a String with a specified character to the desired length

Parameters:

input - String to be padded.

desiredlength - required final length of the String. Note that the input String is never truncated.

Returns:

the padded string

padRight

public static java.lang.String padRight(java.lang.String input,
                                        int desiredlength,
                                        char padchar)

Pads the right side of a String with a specified character to the desired length

Parameters:

input - String to be padded.

desiredlength - required final length of the String. Note that the input String is never truncated.

padchar - the character to pad the String with.

Returns:

the padded string

getYN

public static java.lang.String getYN(java.lang.String input,
                                     java.lang.String defaultresponse)

Converts Yes/No, Y/N, yes/no, true/false, TRUE/FALSE etc. values into either Y or N

Parameters:

input - String to be parsed.

defaultresponse - value to return if input value is null or empty String

Returns:

either Y or N depending on the input value. Specifically, the routine will return Y if the first uppercase character of the input value is a Y, T or the number 1.

escape

public static java.lang.String escape(java.lang.String in)

Escapes a String as per the JavaScript escaping mechanism by converting (most) non-alphanumerics to %nn

Parameters:

in - String to be escaped.

Returns:

The escaped string

unescape

public static java.lang.String unescape(java.lang.String in)

Unescapes a String as per the JavaScript unescaping mechanism by converting %nn text to their ascii equivalent

Parameters:

in - String to be unescaped.

Returns:

The unescaped string

initCaps

public static java.lang.String initCaps(java.lang.String in)

Converts the intial letter to caps in a string

Parameters:

in - String to be capitalized

Returns:

the capitalized string

escapeXMLAttributeValue

public static java.lang.String escapeXMLAttributeValue(java.lang.String attributeValue)