com.k2.Util

Class StringUtil

java.lang.Object

com.k2.Util.StringUtil

public class StringUtil
extends java.lang.Object

This utility provides static method for handling String values.

Author:

simon

Constructor Summary

Constructors

Constructor and Description
StringUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	aliasCase(java.lang.String value) This method converts a String into alias case.
static java.lang.String	braceConcatenate(java.lang.String open, java.lang.String join, java.lang.String close, java.lang.Object... clauses) This method concatenates the given clauses separated by the given join string, prefixed with the given open string and post fixed with close string
static java.lang.String	camelCase(java.lang.String value) This method converts a String to camel case Camel case has an upper case initial character for each word in the input string and separates the words with a single white space
static java.lang.String	classCase(java.lang.String value) This method converts a string to class case.
static java.lang.String	concatenate(java.lang.String join, java.lang.Object... clauses) This method concatenates the given clauses separated by the given join.
static boolean	containsChar(java.lang.String s, char c) This static method returns true if the given string contains the given char
static java.lang.String	indexToString(int i) This static method converts the given integer value in to a base26 string with a - z having values 0 - 25 respectively
static java.lang.String	initialLowerCase(java.lang.String input) This method returns the given String with a lower case initial character
static java.lang.String	initialUpperCase(java.lang.String input) The method returns the given String with its initial character in upper case
static boolean	isSet(java.lang.String value) This method checks whether the string is not null and has no white space charaters
static java.lang.String	kebabCase(java.lang.String value) This method converts a string to kebab case Kebab case is all in lower case with words separated by a hyphen '-'
static java.lang.String	lastChar(java.lang.String string) This method returns the last character of a string
static java.lang.String	nvl(java.lang.String checkValue, java.lang.String valueIfNull) This method converts null values
static java.lang.String	plural(java.lang.String singular) This method returns the plural of the given singular string
static java.lang.String	random(int length) This method generates a random String of the given length
static java.lang.String	random(java.lang.Integer minLength, java.lang.Integer maxLength, java.lang.String saltChars) This method returns a random String in the given length range from the given set of characters
static java.lang.String	random(java.lang.Integer length, java.lang.String saltChars) This method generates a random String of the given length from the given set of characters
static java.lang.String	random(int minLength, int maxLength) This method generates a String of within the length range specified
static void	registerTypeConverter(TypeConverter<?,java.lang.String> converter) This method registers with this static utility an instance of a String TypeConverter to convert an instance of the convertible class into a String value
static java.lang.String	replaceAll(java.lang.String input, java.lang.String match, java.lang.Object... replacements) This method replaces each occurrence of the match string with the replacements in the given order.
static java.lang.String	safeChars() Get the set of safe characters
static void	safeChars(java.lang.String newSafeChars) Set the safe characters
static java.lang.String	safeWord(java.lang.String word) This method ensures that only safe characters exist in the word.
static java.lang.String	saltChars() Get the set of characters from which to build random strings
static void	saltChars(java.lang.String newSaltChars) Set the characters from which to build random strings
static java.lang.String	splitCamelCase(java.lang.String camelCase) This method splits the given camel case string into words
static java.lang.String	staticCase(java.lang.String value) This method converts a string to static case Static case is all in upper case with words separated by a single underscore '_'
static int	stringToIndex(java.lang.String index) This static method converts the given string into an index value in a base26 manner with a - z having values 0 - 25 respectively Non alpha numeric values are stripped from the string and it is converted to lower case
static java.lang.Boolean	toBoolean(java.lang.String v) This method converts the given string into a Boolean value
static java.util.Date	toDate(java.lang.String v) This method converts the given string into a Date value
static java.util.Date	toDate(java.lang.String v, DateUtil.DateFormat format) This method converts the given string into a Date value
static java.util.Date	toDate(java.lang.String v, java.text.SimpleDateFormat formatter) This method converts the given string into a Date value
static java.util.Date	toDate(java.lang.String v, java.lang.String format) This method converts the given string into a Date value
static java.lang.Double	toDouble(java.lang.String v) This method converts the given string into a Double value
static java.lang.Float	toFloat(java.lang.String v) This method converts the given string into a Float value
static java.lang.Integer	toInteger(java.lang.String v) This method converts the given string into a Integer value
static java.lang.Long	toLong(java.lang.String v) This method converts the given string into a Long value
static java.lang.String	toString(java.lang.Object v) This method converts the given object into a String value Static utility methods convert Strings, Integers, Longs, Floats, Doubles, Dates and Booleans into String values If the given object is not one of the above types then a type converter must have been registered with this static utility in order for the given object to be converted into a String value If no type converter has been registered for the class of the given object then a null is returned
static java.lang.String	toString(java.lang.String v) This method converts the given string into a String value
static java.lang.String	trim(javax.persistence.criteria.CriteriaBuilder.Trimspec trimSpec, char trimChar, java.lang.String s) This static method trims the leading and/or trailing chars from the given string according to the given trim spec.
static java.lang.String	verySafeChars() Get the set of safe characters
static void	verySafeChars(java.lang.String newVerySafeChars) Set the very safe characters
static java.lang.String	verySafeWord(java.lang.String word) This method ensures that only safe characters exist in the word.
static java.lang.String[]	words(java.lang.String value) This method splits a String into words on any whitespace characters

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtil

public StringUtil()

Method Detail

saltChars

public static java.lang.String saltChars()

Get the set of characters from which to build random strings

Returns:

The set of characters from which to build random strings

saltChars

public static void saltChars(java.lang.String newSaltChars)

Set the characters from which to build random strings

Parameters:

newSaltChars - The new set of characters from which to build random strings

safeChars

public static java.lang.String safeChars()

Get the set of safe characters

Returns:

The set of safe characters

safeChars

public static void safeChars(java.lang.String newSafeChars)

Set the safe characters

Parameters:

newSafeChars - The new set of safe characters

verySafeChars

public static java.lang.String verySafeChars()

Get the set of safe characters

Returns:

The set of very safe characters

verySafeChars

public static void verySafeChars(java.lang.String newVerySafeChars)

Set the very safe characters

Parameters:

newVerySafeChars - The new set of safe characters

registerTypeConverter

public static void registerTypeConverter(TypeConverter<?,java.lang.String> converter)

This method registers with this static utility an instance of a String TypeConverter to convert an instance of the convertible class into a String value

Parameters:

converter - The String TypeConverter instance

toString

public static java.lang.String toString(java.lang.Object v)

This method converts the given object into a String value Static utility methods convert Strings, Integers, Longs, Floats, Doubles, Dates and Booleans into String values If the given object is not one of the above types then a type converter must have been registered with this static utility in order for the given object to be converted into a String value If no type converter has been registered for the class of the given object then a null is returned

Parameters:

v - The object to convert into a String value

Returns:

The String representation of the given object or null if the given object is null or the class of the given object cannot be converted into a String value

toInteger

public static java.lang.Integer toInteger(java.lang.String v)

This method converts the given string into a Integer value

Parameters:

v - The String to convert

Returns:

A Integer representing the given String

toLong

public static java.lang.Long toLong(java.lang.String v)

This method converts the given string into a Long value

Parameters:

v - The String to convert

Returns:

A Long representing the given String

toFloat

public static java.lang.Float toFloat(java.lang.String v)

This method converts the given string into a Float value

Parameters:

v - The String to convert

Returns:

A Float representing the given String

toDouble

public static java.lang.Double toDouble(java.lang.String v)

This method converts the given string into a Double value

Parameters:

v - The String to convert

Returns:

A Double representing the given String

toBoolean

public static java.lang.Boolean toBoolean(java.lang.String v)

This method converts the given string into a Boolean value

Parameters:

v - The String to convert

Returns:

A Boolean representing the given String

toDate

public static java.util.Date toDate(java.lang.String v)

This method converts the given string into a Date value

Parameters:

v - The String to convert

Returns:

A Date representing the given String

toDate

public static java.util.Date toDate(java.lang.String v,
                                    DateUtil.DateFormat format)

This method converts the given string into a Date value

Parameters:

v - The String to convert

format - The requested data format

Returns:

A Date representing the given String in the requested format

toDate

public static java.util.Date toDate(java.lang.String v,
                                    java.text.SimpleDateFormat formatter)

This method converts the given string into a Date value

Parameters:

v - The String to convert

formatter - The date formatter to convert the Date

Returns:

A Date representing the given String in the requested format

toDate

public static java.util.Date toDate(java.lang.String v,
                                    java.lang.String format)

This method converts the given string into a Date value

Parameters:

v - The String to convert

format - A String representing the format of the required date

Returns:

A Date representing the given String in the requested format

toString

public static java.lang.String toString(java.lang.String v)

This method converts the given string into a String value

Parameters:

v - The String to convert

Returns:

A String representing the given String

random

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

This method generates a random String of the given length

Parameters:

length - The desired length of the random string

Returns:

A random String of the given length

random

public static java.lang.String random(int minLength,
                                      int maxLength)

This method generates a String of within the length range specified

Parameters:

minLength - The minimum length of the String

maxLength - The maximum length of the String

Returns:

The random string within the given length range

random

public static java.lang.String random(java.lang.Integer length,
                                      java.lang.String saltChars)

This method generates a random String of the given length from the given set of characters

Parameters:

length - The desired length of the random string

saltChars - The set of characters from which to build the random String

Returns:

The random string of the desired length

random

public static java.lang.String random(java.lang.Integer minLength,
                                      java.lang.Integer maxLength,
                                      java.lang.String saltChars)

This method returns a random String in the given length range from the given set of characters

Parameters:

minLength - The minimum length of the string

maxLength - The maximum length of the string

saltChars - The set of characters from which to build the string

Returns:

The random string of the desired length

initialLowerCase

public static java.lang.String initialLowerCase(java.lang.String input)

This method returns the given String with a lower case initial character

Parameters:

input - the String

Returns:

The string with its initial character in lower case

initialUpperCase

public static java.lang.String initialUpperCase(java.lang.String input)

The method returns the given String with its initial character in upper case

Parameters:

input - The String

Returns:

The String with its initial character in upper case

isSet

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

This method checks whether the string is not null and has no white space charaters

Parameters:

value - The string to check

Returns:

True if the string is no null and has non-whitespace characters

words

public static java.lang.String[] words(java.lang.String value)

This method splits a String into words on any whitespace characters

Parameters:

value - The string to split into words

Returns:

An array of words

safeWord

public static java.lang.String safeWord(java.lang.String word)

This method ensures that only safe characters exist in the word. If the word only contains unsafe characters then an 6 character random string is returned

Parameters:

word - The word to make safe

Returns:

The word with unsafe characters removed

verySafeWord

public static java.lang.String verySafeWord(java.lang.String word)

This method ensures that only safe characters exist in the word. If the word only contains unsafe characters then an 6 character random string is returned

Parameters:

word - The word to make safe

Returns:

The word with unsafe characters removed

aliasCase

public static java.lang.String aliasCase(java.lang.String value)

This method converts a String into alias case. Alias case has a lower case initial character for the first word and an upper case initial character for all subsequent words and no spaces

Parameters:

value - The string to convert to alias case

Returns:

The string in alias case

camelCase

public static java.lang.String camelCase(java.lang.String value)

This method converts a String to camel case Camel case has an upper case initial character for each word in the input string and separates the words with a single white space

Parameters:

value - The String to convert to Camel case

Returns:

The String in Camel case

classCase

public static java.lang.String classCase(java.lang.String value)

This method converts a string to class case. Class case has an upper case initial character for each word and no spaces

Parameters:

value - The string to convert to class case

Returns:

The string in class case

staticCase

public static java.lang.String staticCase(java.lang.String value)

This method converts a string to static case Static case is all in upper case with words separated by a single underscore '_'

Parameters:

value - The string to convert to static case

Returns:

The string in static case

kebabCase

public static java.lang.String kebabCase(java.lang.String value)

This method converts a string to kebab case Kebab case is all in lower case with words separated by a hyphen '-'

Parameters:

value - The string to convert to kebab case

Returns:

The string in kebab case

nvl

public static java.lang.String nvl(java.lang.String checkValue,
                                   java.lang.String valueIfNull)

This method converts null values

Parameters:

checkValue - The value to check for null

valueIfNull - The value to return if the value to check is null

Returns:

The checkValue if it is not null else the valueIfNull

replaceAll

public static java.lang.String replaceAll(java.lang.String input,
                                          java.lang.String match,
                                          java.lang.Object... replacements)

This method replaces each occurrence of the match string with the replacements in the given order.

Parameters:

input - The string in which to replace the match strings

match - The string to match

replacements - An array of objects with which to replace the match strings

Returns:

The input string with the match strings replaces with the string variant of the given replacement using StringUtil.toString(Object)

concatenate

public static java.lang.String concatenate(java.lang.String join,
                                           java.lang.Object... clauses)

This method concatenates the given clauses separated by the given join. Note the join is only included in the output between each clause.

Parameters:

join - The string to join the clauses together

clauses - An array of object clauses to concatenate together

Returns:

The clauses concatenated together with the join string between each clause

braceConcatenate

public static java.lang.String braceConcatenate(java.lang.String open,
                                                java.lang.String join,
                                                java.lang.String close,
                                                java.lang.Object... clauses)

This method concatenates the given clauses separated by the given join string, prefixed with the given open string and post fixed with close string

Parameters:

open - The opening string e.g '{'

join - The joining string e.g. ', '

close - The closing string e.g. '}'

clauses - The objects to concatenate together using the result of StingUtil.toString(Object) to convert to a String

Returns:

The resultant concatenation

lastChar

public static java.lang.String lastChar(java.lang.String string)

This method returns the last character of a string

Parameters:

string - The string to test

Returns:

The last character of the string

plural

public static java.lang.String plural(java.lang.String singular)

This method returns the plural of the given singular string

Parameters:

singular - The singular name for which the plural variant is required

Returns:

The plural variant of the singular string or the singular string if it already ends with 'es'

splitCamelCase

public static java.lang.String splitCamelCase(java.lang.String camelCase)

This method splits the given camel case string into words

Parameters:

camelCase - A string in camel case

Returns:

The given camel case string as separate words

stringToIndex

public static int stringToIndex(java.lang.String index)

This static method converts the given string into an index value in a base26 manner with a - z having values 0 - 25 respectively Non alpha numeric values are stripped from the string and it is converted to lower case

Parameters:

index - The string to convert to an index value

Returns:

The integer value of the given base26 string

indexToString

public static java.lang.String indexToString(int i)

This static method converts the given integer value in to a base26 string with a - z having values 0 - 25 respectively

Parameters:

i - The integer value to convert

Returns:

The resultant base26 string

trim

public static java.lang.String trim(javax.persistence.criteria.CriteriaBuilder.Trimspec trimSpec,
                                    char trimChar,
                                    java.lang.String s)

This static method trims the leading and/or trailing chars from the given string according to the given trim spec.

Parameters:

trimSpec - Whether to trim leading, trailing of both

trimChar - The character to trim from the string

s - The String to trim

Returns:

The trimmed string

containsChar

public static boolean containsChar(java.lang.String s,
                                   char c)

This static method returns true if the given string contains the given char

Parameters:

s - The string to test

c - The char to search for

Returns:

True if the string contains the char