org.yawlfoundation.yawl.util

Class StringUtil

java.lang.Object

org.yawlfoundation.yawl.util.StringUtil

public class StringUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StringUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	capitalise(java.lang.String s) Converts a string to all lower case, and capitalises the first letter of the string
static java.lang.String	convertThrowableToString(java.lang.Throwable t) Converts the throwable object into the standard Java stack trace format.
static java.lang.String	deQuote(java.lang.String s) Removes single or double quotes surrounding a string
static long	durationStrToMSecs(java.lang.String s)
static long	durationToMSecs(javax.xml.datatype.Duration d)
static long	durationToMSecs(javax.xml.datatype.Duration d, long def)
static java.lang.String	enQuote(java.lang.String s, char quoteMark) Wraps a string in the specified quote marks
static java.lang.String	extract(java.lang.String source, java.lang.String pattern)
static java.lang.String	fileToString(java.io.File f)
static java.lang.String	fileToString(java.lang.String filename)
static int	find(java.lang.String toSearch, java.lang.String toFind)
static int	find(java.lang.String toSearch, java.lang.String toFind, int start)
static int	find(java.lang.String toSearch, java.lang.String toFind, int start, boolean ignoreCase)
static java.util.List<java.lang.Integer>	findAll(java.lang.String toSearch, java.lang.String toFind)
static java.util.List<java.lang.Integer>	findAll(java.lang.String toSearch, java.lang.String toFind, boolean ignoreCase)
static java.lang.String	firstWord(java.lang.String s)
static java.lang.String	formatDecimalCost(java.math.BigDecimal value) Utility routine which takes a decimal value as a string (e.g.
static java.lang.String	formatForHTML(java.lang.String string) Esacpes all HTML entities and "funky accents" into the HTML 4.0 encodings, replacing new lines with "<br>", tabs with four "&nbsp;" and single spaces with "&nbsp;".
static java.lang.String	formatPostCode(java.lang.String postcode) Formats a postcode into standard Royal Mail format
static java.lang.String	formatSortCode(java.lang.String sortcode) Formats a sortcode into the common form nn-nn-nn
static java.lang.String	formatTime(long time) formats a long time value into a string of the form 'ddd:hh:mm:ss'
static java.lang.String	formatUIDate(java.util.Calendar calendar) Deprecated. Use TimeUtil.formatUIDate
static java.lang.String	getDebugMessage(java.lang.String msg) Utility routine to return a debug message suitable for logging.
static java.lang.String	getISOFormattedDate(java.util.Date date) Utility routine to return the date supplied as an ISO formatted string.
static java.lang.String	getRandomString(int length)
static java.lang.String	insert(java.lang.String base, java.lang.String addition, int position)
static boolean	isIntegerString(java.lang.String s)
static boolean	isNullOrEmpty(java.lang.String s)
static boolean	isValidDurationString(java.lang.String s)
static java.lang.String	join(java.util.List<java.lang.String> strList, char separator)
static java.lang.String	longToDateTime(long time)
static javax.xml.datatype.Duration	msecsToDuration(long msecs)
static java.lang.String	pad(java.lang.String s, int len, char padChar)
static java.lang.String	pad(java.lang.String s, int len, char padChar, boolean left)
static java.lang.String	removeAllWhiteSpace(java.lang.String string) Removes all white space from a string.
static java.lang.String	repeat(char c, int count)
static boolean	replaceInFile(java.io.File f, java.lang.CharSequence oldChars, java.lang.CharSequence newChars)
static boolean	replaceInFile(java.lang.String fileName, java.lang.CharSequence oldChars, java.lang.CharSequence newChars)
static java.lang.String	replaceTokens(java.lang.String buffer, java.lang.String fromToken, java.lang.String toToken) Utility routine to replace one token with another within a string object.
static java.lang.String	reverseString(java.lang.String inputString) Utility method to take a string and return the string in revserse sequence.
static java.lang.String	setToXML(java.util.Set<java.lang.String> set)
static java.util.List<java.lang.String>	splitToList(java.lang.String s, java.lang.String separator)
static java.lang.String	streamToString(java.io.InputStream is)
static java.lang.String	streamToString(java.io.InputStream is, int bufSize)
static java.io.File	stringToFile(java.io.File f, java.lang.String contents)
static java.io.File	stringToFile(java.lang.String path, java.lang.String contents)
static java.io.File	stringToTempFile(java.lang.String contents)
static double	strToDouble(java.lang.String s, double def)
static javax.xml.datatype.Duration	strToDuration(java.lang.String s)
static int	strToInt(java.lang.String s, int def)
static long	strToLong(java.lang.String s, long def)
static java.lang.String	unwrap(java.lang.String xml) Removes an outer set of xml tags from an xml string, if possible
static java.lang.String	wrap(java.lang.String core, java.lang.String wrapTag) encases a string with a pair of xml tags
static java.lang.String	wrapEscaped(java.lang.String core, java.lang.String wrapTag)
static long	xmlDateToLong(java.lang.String s)
static java.lang.String	xmlDecode(java.lang.String s) Decodes reserved characters in an xml string
static java.lang.String	xmlEncode(java.lang.String s) Encodes reserved characters in an xml string
static java.util.Set<java.lang.String>	xmlToSet(java.lang.String xml)

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

replaceTokens

public static java.lang.String replaceTokens(java.lang.String buffer,
                                             java.lang.String fromToken,
                                             java.lang.String toToken)

Utility routine to replace one token with another within a string object.

Parameters:

buffer - String object to be manipulated

fromToken - Token to be replaced

toToken - Token used in replacement

Returns:

String object holding modified String

getISOFormattedDate

public static java.lang.String getISOFormattedDate(java.util.Date date)

Utility routine to return the date supplied as an ISO formatted string.

Parameters:

date - Date object to be formatted

Returns:

String object holding ISO formatted representation of date supplied

getDebugMessage

public static java.lang.String getDebugMessage(java.lang.String msg)

Utility routine to return a debug message suitable for logging. It basically prefixes the supplied message with the current timestamp in ISO format.

Parameters:

msg - Body of debug message to be prefixed with the current timestamp

Returns:

String object holding debug message prefixed with ISO formatted current timestamp

reverseString

public static java.lang.String reverseString(java.lang.String inputString)

Utility method to take a string and return the string in revserse sequence.

Parameters:

inputString - String to be reversed

Returns:

Reversed string

removeAllWhiteSpace

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

Removes all white space from a string.

Parameters:

string - String to remove white space from

Returns:

Resulting whitespaceless string.

formatPostCode

public static java.lang.String formatPostCode(java.lang.String postcode)

Formats a postcode into standard Royal Mail format

Parameters:

postcode -

Returns:

Postcode correctly formatted

formatSortCode

public static java.lang.String formatSortCode(java.lang.String sortcode)

Formats a sortcode into the common form nn-nn-nn

Parameters:

sortcode -

Returns:

Sortcode correctly formatted

capitalise

public static java.lang.String capitalise(java.lang.String s)

Converts a string to all lower case, and capitalises the first letter of the string

Parameters:

s - unformated string.

Returns:

The formated string.

formatUIDate

public static java.lang.String formatUIDate(java.util.Calendar calendar)

Deprecated. Use TimeUtil.formatUIDate

Utility routine that takes in a Calendar referece and returns a date/time stamp suitable for use in a Portlets environment.

Parameters:

calendar -

Returns:

Date/timestamp suitable for display.

formatDecimalCost

public static java.lang.String formatDecimalCost(java.math.BigDecimal value)

Utility routine which takes a decimal value as a string (e.g. 0.25 equating to 25p) and returns the value in UI currency format (e.g. £0.25).

Returns:

A formatted currency

formatTime

public static java.lang.String formatTime(long time)

formats a long time value into a string of the form 'ddd:hh:mm:ss'

Parameters:

time - the time value (in milliseconds)

Returns:

the formatted time string

convertThrowableToString

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

Converts the throwable object into the standard Java stack trace format.

Parameters:

t - Throwable to convert to a String

Returns:

String representation of Throwable t

formatForHTML

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

Esacpes all HTML entities and "funky accents" into the HTML 4.0 encodings, replacing new lines with "<br>", tabs with four "&nbsp;" and single spaces with "&nbsp;".

Parameters:

string - to escape

Returns:

escaped string

wrap

public static java.lang.String wrap(java.lang.String core,
                                    java.lang.String wrapTag)

encases a string with a pair of xml tags

Parameters:

core - the text to encase

wrapTag - the name of the tag to encase the text

Returns:

the encased string (e.g. "core")

wrapEscaped

public static java.lang.String wrapEscaped(java.lang.String core,
                                           java.lang.String wrapTag)

unwrap

public static java.lang.String unwrap(java.lang.String xml)

Removes an outer set of xml tags from an xml string, if possible

Parameters:

xml - the xml string to strip

Returns:

the stripped xml string

deQuote

public static java.lang.String deQuote(java.lang.String s)

Removes single or double quotes surrounding a string

Parameters:

s - the string

Returns:

the string with the quotes removed

enQuote

public static java.lang.String enQuote(java.lang.String s,
                                       char quoteMark)

Wraps a string in the specified quote marks

Parameters:

s - the string to wrap

quoteMark - the quote character to use

Returns:

the wrapped sgtring

xmlEncode

public static java.lang.String xmlEncode(java.lang.String s)

Encodes reserved characters in an xml string

Parameters:

s - the string to encode

Returns:

the newly encoded string

xmlDecode

public static java.lang.String xmlDecode(java.lang.String s)

Decodes reserved characters in an xml string

Parameters:

s - the string to decode

Returns:

the newly decoded string

isIntegerString

public static boolean isIntegerString(java.lang.String s)

stringToFile

public static java.io.File stringToFile(java.lang.String path,
                                        java.lang.String contents)

stringToTempFile

public static java.io.File stringToTempFile(java.lang.String contents)

stringToFile

public static java.io.File stringToFile(java.io.File f,
                                        java.lang.String contents)

fileToString

public static java.lang.String fileToString(java.io.File f)

streamToString

public static java.lang.String streamToString(java.io.InputStream is)

streamToString

public static java.lang.String streamToString(java.io.InputStream is,
                                              int bufSize)

fileToString

public static java.lang.String fileToString(java.lang.String filename)

replaceInFile

public static boolean replaceInFile(java.io.File f,
                                    java.lang.CharSequence oldChars,
                                    java.lang.CharSequence newChars)

replaceInFile

public static boolean replaceInFile(java.lang.String fileName,
                                    java.lang.CharSequence oldChars,
                                    java.lang.CharSequence newChars)

extract

public static java.lang.String extract(java.lang.String source,
                                       java.lang.String pattern)

getRandomString

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

isNullOrEmpty

public static boolean isNullOrEmpty(java.lang.String s)

strToInt

public static int strToInt(java.lang.String s,
                           int def)

strToLong

public static long strToLong(java.lang.String s,
                             long def)

strToDouble

public static double strToDouble(java.lang.String s,
                                 double def)

strToDuration

public static javax.xml.datatype.Duration strToDuration(java.lang.String s)

msecsToDuration

public static javax.xml.datatype.Duration msecsToDuration(long msecs)

isValidDurationString

public static boolean isValidDurationString(java.lang.String s)

durationToMSecs

public static long durationToMSecs(javax.xml.datatype.Duration d,
                                   long def)

durationToMSecs

public static long durationToMSecs(javax.xml.datatype.Duration d)

durationStrToMSecs

public static long durationStrToMSecs(java.lang.String s)

xmlDateToLong

public static long xmlDateToLong(java.lang.String s)

longToDateTime

public static java.lang.String longToDateTime(long time)

find

public static int find(java.lang.String toSearch,
                       java.lang.String toFind,
                       int start,
                       boolean ignoreCase)

find

public static int find(java.lang.String toSearch,
                       java.lang.String toFind,
                       int start)

find

public static int find(java.lang.String toSearch,
                       java.lang.String toFind)

findAll

public static java.util.List<java.lang.Integer> findAll(java.lang.String toSearch,
                                                        java.lang.String toFind,
                                                        boolean ignoreCase)

findAll

public static java.util.List<java.lang.Integer> findAll(java.lang.String toSearch,
                                                        java.lang.String toFind)

repeat

public static java.lang.String repeat(char c,
                                      int count)

join

public static java.lang.String join(java.util.List<java.lang.String> strList,
                                    char separator)

splitToList

public static java.util.List<java.lang.String> splitToList(java.lang.String s,
                                                           java.lang.String separator)

insert

public static java.lang.String insert(java.lang.String base,
                                      java.lang.String addition,
                                      int position)

pad

public static java.lang.String pad(java.lang.String s,
                                   int len,
                                   char padChar)

pad

public static java.lang.String pad(java.lang.String s,
                                   int len,
                                   char padChar,
                                   boolean left)

firstWord

public static java.lang.String firstWord(java.lang.String s)

setToXML

public static java.lang.String setToXML(java.util.Set<java.lang.String> set)

xmlToSet

public static java.util.Set<java.lang.String> xmlToSet(java.lang.String xml)