oracle.stellent.ridc.common.util

Class StringTools

java.lang.Object

oracle.stellent.ridc.common.util.StringTools

@Exported
public class StringTools
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringTools.RegexAppendCallback Allows a user to append/modify a buffer during a call to evaluateRegexWithCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOLEAN_FALSE Boolean string "false"
static String	BOOLEAN_NO Boolean string "no" - analog for "false"
static String	BOOLEAN_OFF Boolean string "off" - analog for "false"
static String	BOOLEAN_ON Boolean string "on" - analog for "true"
static String	BOOLEAN_TRUE Boolean string "true"
static String	BOOLEAN_YES Boolean string "yes" - analog for "true"
static char	CHR_BACK_SLASH Character for "\"
static char	CHR_DOT Character for "."
static char	CHR_FORWARD_SLASH Character for "/"
static char	CHR_TAB Tab character
static String	STR_AND String constant for "&" sign
static String	STR_COMMA String constant for "," sign
static String	STR_EQUALS String constant for "=" sign
static String	STR_QUESTION String constant for "?" sign
static String	STR_SEMICOLON String constant for ";" sign
static String	STR_SPACE String constant for " " sign

Constructor Summary

Constructors

Constructor and Description
StringTools()

Method Summary

Modifier and Type	Method and Description
static String	change(String input, String oldPattern, String newPattern) Replaces the specified substring with the new substring in the given input.
static String	concat(String s1, String s2) Fast 2 string concatenation using StringBuffer.
static String	evaluateRegexWithCallback(String text, String regEx, StringTools.RegexAppendCallback callback) Analyze a string and invoke a callback when a match is found.
static String[]	getArrayFromCsvString(String csv) Parses comma (",") delimited string to string array.
static String	getCsvFromCollection(Collection collection) Constructs string from a collection
static List<String>	getDelimitedList(String value, String delims) Get List of tokens from delimited original string
static String	getFirstSegment(String value, String separator) Get first string segment separated by passed separator
static int[]	getIntArrayFromDelimitedString(String data, String delimiter) Parses string with the specified delimiter and returns array of ints as a result of parsing.
static String	getLastSegment(String value, String separator) Get last string segment separated by passed separator
static String	getLastSegment(String value, String separator, boolean includeSeparator) Get last string segment separated by passed separator
static List<String>	getListFromCsv(String value) Parses comma delimited string to List of String instances
static List<String>	getListFromDelimitedString(String data, String delimiter) Parses data with the specified delimiter
static List<Long>	getLongsListFromCsv(String value) Parses comma delimited string to List of Long instances
static String	getSegment(String str, String separator, int segment) Returns the segment, null if not found, first segment is segment 0
static String	getValueOrDefault(String value, String defaultValue) Checks the value and returns a non-null value or the default value
static boolean	isEmpty(char[] array) Verifies whether passed character array is empty/null or not.
static boolean	isEmpty(CharSequence sequence) Verifies whether passed character sequence is empty/null or not.
static boolean	isEmpty(String str) Verifies whether passed string is empty/null or not.
static boolean	isTrue(String value) Test if the value of a string is considered true.
static String	replaceChars(String orig, String chars, char replace) Replaces all chars with the replacement char
static String	replaceParams(String source, String[] params) Replace placeholders, or parameters, in a string that are of the format {number}
static String	stripFirstSegment(String value, String separator) Strips string first segment, defined by separator and returns stripped string
static String	stripLastSegment(String value, String separator) Strips string last segment, defined by separator and returns stripped string
static boolean	toBoolean(String value) Converts string to boolean.
static String	toCsv(List<String> strings) Convert List of strings to comma-separated string
static String	toCsv(Object[] objects) Convert array of objects to comma-separated string
static String	unwrap(String value, String prefix, String postfix) Unwraps string using selected prefix and postfix
static String	wrap(String value, String prefix, String postfix) Wrap string value with prefix and postfix.
static String	wrapIfRequired(String value, String prefix, String postfix) Wrap the string value with prefix and postfix, but only if the prefix and/or postfix does not exist in the value.

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_ON

public static final String BOOLEAN_ON

Boolean string "on" - analog for "true"

See Also:

Constant Field Values

BOOLEAN_OFF

public static final String BOOLEAN_OFF

Boolean string "off" - analog for "false"

See Also:

Constant Field Values

BOOLEAN_YES

public static final String BOOLEAN_YES

Boolean string "yes" - analog for "true"

See Also:

Constant Field Values

BOOLEAN_NO

public static final String BOOLEAN_NO

Boolean string "no" - analog for "false"

See Also:

Constant Field Values

BOOLEAN_FALSE

public static final String BOOLEAN_FALSE

Boolean string "false"

See Also:

Constant Field Values

BOOLEAN_TRUE

public static final String BOOLEAN_TRUE

Boolean string "true"

See Also:

Constant Field Values

STR_COMMA

public static final String STR_COMMA

String constant for "," sign

See Also:

Constant Field Values

STR_SEMICOLON

public static final String STR_SEMICOLON

String constant for ";" sign

See Also:

Constant Field Values

STR_QUESTION

public static final String STR_QUESTION

String constant for "?" sign

See Also:

Constant Field Values

STR_EQUALS

public static final String STR_EQUALS

String constant for "=" sign

See Also:

Constant Field Values

STR_AND

public static final String STR_AND

String constant for "&" sign

See Also:

Constant Field Values

STR_SPACE

public static final String STR_SPACE

String constant for " " sign

See Also:

Constant Field Values

CHR_DOT

public static final char CHR_DOT

Character for "."

See Also:

Constant Field Values

CHR_FORWARD_SLASH

public static final char CHR_FORWARD_SLASH

Character for "/"

See Also:

Constant Field Values

CHR_BACK_SLASH

public static final char CHR_BACK_SLASH

Character for "\"

See Also:

Constant Field Values

CHR_TAB

public static final char CHR_TAB

Tab character

See Also:

Constant Field Values

Constructor Detail

StringTools

public StringTools()

Method Detail

getListFromDelimitedString

public static List<String> getListFromDelimitedString(String data,
                                                      String delimiter)

Parses data with the specified delimiter

Parameters:

data - Original data to parse

delimiter - Delimiter to use for data parsing

Returns:

LinkedList of tokens parsed, delimiters are not returned

getIntArrayFromDelimitedString

public static int[] getIntArrayFromDelimitedString(String data,
                                                   String delimiter)

Parses string with the specified delimiter and returns array of ints as a result of parsing. Of course this is applicable only when you do know that string contains integers

Parameters:

data - Original data to parse

delimiter - Delimiter to use for data parsing

Returns:

array of integers

getArrayFromCsvString

public static String[] getArrayFromCsvString(String csv)

Parses comma (",") delimited string to string array. No quotes (") supported

Parameters:

csv - Comma separated values

Returns:

array of String extracted from line

getListFromCsv

public static List<String> getListFromCsv(String value)

Parses comma delimited string to List of String instances

Parameters:

value - Comma delimited string to parse

Returns:

List of Strings extracted from comma-separated line

getLongsListFromCsv

public static List<Long> getLongsListFromCsv(String value)

Parses comma delimited string to List of Long instances

Parameters:

value - Comma delimited string to parse

Returns:

List of Longs

getCsvFromCollection

public static String getCsvFromCollection(Collection collection)

Constructs string from a collection

Parameters:

collection - source collection of values

Returns:

Comma-separated string as a result of values concatenation

getFirstSegment

public static String getFirstSegment(String value,
                                     String separator)

Get first string segment separated by passed separator

Parameters:

value - initial string

separator - is separator string

Returns:

stripped segment or null

getLastSegment

public static String getLastSegment(String value,
                                    String separator)

Get last string segment separated by passed separator

Parameters:

value - initial string

separator - is separator string

Returns:

stripped segment or null

getLastSegment

public static String getLastSegment(String value,
                                    String separator,
                                    boolean includeSeparator)

Get last string segment separated by passed separator

Parameters:

value - initial string

separator - is separator string

includeSeparator - true to include the separator character in the result, false otherwise

Returns:

stripped segment or null

getSegment

public static String getSegment(String str,
                                String separator,
                                int segment)

Returns the segment, null if not found, first segment is segment 0

Parameters:

str - Source string

separator - Parsing separator

segment - String segment number

Returns:

Specified segment of the string extracted

stripFirstSegment

public static String stripFirstSegment(String value,
                                       String separator)

Strips string first segment, defined by separator and returns stripped string

Parameters:

value - initial string

separator - is separator string

Returns:

stripped value string

stripLastSegment

public static String stripLastSegment(String value,
                                      String separator)

Strips string last segment, defined by separator and returns stripped string

Parameters:

value - initial string

separator - is separator string

Returns:

stripped value string

isEmpty

public static boolean isEmpty(String str)

Verifies whether passed string is empty/null or not.

Parameters:

str - Source string to analyze

Returns:

True, if string is empty or null, False - otherwise

isEmpty

public static boolean isEmpty(CharSequence sequence)

Verifies whether passed character sequence is empty/null or not.

Parameters:

sequence - Source sequence to analyze

Returns:

True, if sequence is empty or null, False - otherwise

isEmpty

public static boolean isEmpty(char[] array)

Verifies whether passed character array is empty/null or not.

Parameters:

array - Source array to analyze

Returns:

True, if array is empty or null, False - otherwise

change

public static String change(String input,
                            String oldPattern,
                            String newPattern)

Replaces the specified substring with the new substring in the given input.

Parameters:

input - the string to examine

oldPattern - a substring representing a pattern to be replaced

newPattern - a substring representing the pattern to replace the old

Returns:

a string with the oldPattern replaced by the newPattern

replaceChars

public static String replaceChars(String orig,
                                  String chars,
                                  char replace)

Replaces all chars with the replacement char

Parameters:

orig - Original string

chars - Characters we want to replace

replace - Replacement character

Returns:

Modified original string with all chars replaced with replacement character

toBoolean

public static boolean toBoolean(String value)

Converts string to boolean. The difference is that is understands "on" and "off" values as true and false respectively

Parameters:

value - Source string value to convert

Returns:

true or false depending on string content. If string is empty - false is returned

isTrue

public static boolean isTrue(String value)

Test if the value of a string is considered true. '1', case agnostic versions of "t", "y", "true","yes" and "on"

Parameters:

value - String to be tested

Returns:

true if string matches criteria, otherwise false

wrap

public static String wrap(String value,
                          String prefix,
                          String postfix)

Wrap string value with prefix and postfix. Result looks as follows:

 result := prefix + value + postfix
 

Parameters:

value - Source string value to wrap

prefix - Prefix to use

postfix - Postfix to use

Returns:

Original string with specified prefix and postfix

wrapIfRequired

public static String wrapIfRequired(String value,
                                    String prefix,
                                    String postfix)

Wrap the string value with prefix and postfix, but only if the prefix and/or postfix does not exist in the value.

Parameters:

value - string value to wrap

prefix - the string to prepend

postfix - the string to append

Returns:

wrapped string

unwrap

public static String unwrap(String value,
                            String prefix,
                            String postfix)

Unwraps string using selected prefix and postfix

Parameters:

value - Previously wrapped string

prefix - Prefix to use

postfix - Postfix to use

Returns:

Original value used inside wrap call

toCsv

public static String toCsv(List<String> strings)

Convert List of strings to comma-separated string

Parameters:

strings - Original strings container

Returns:

Comma-separated list of values taken from original container

toCsv

public static String toCsv(Object[] objects)

Convert array of objects to comma-separated string

Parameters:

objects - array of objects (each will converted by calling toString())

Returns:

a comma-seperated list of the toString() values of each object

getDelimitedList

public static List<String> getDelimitedList(String value,
                                            String delims)

Get List of tokens from delimited original string

Parameters:

value - Original string value

delims - Delimiters used to make tokens

Returns:

list of tokens produced as a result of string parsing

replaceParams

public static String replaceParams(String source,
                                   String[] params)

Replace placeholders, or parameters, in a string that are of the format {number}

  Example: Calling on string "Error locating resource {0} for user {1}" with array {"root", "admin"}
           would result in "Error locating resource root for user admin"
 

Parameters:

source - a string with parameters, starting with 0

params - the values for the parameters, the index corresponding to the parameter value + 1

Returns:

the string with the values in place

concat

public static String concat(String s1,
                            String s2)

Fast 2 string concatenation using StringBuffer.

Parameters:

s1 - source string #1

s2 - source string #2

Returns:

2 strings concatenated

evaluateRegexWithCallback

public static String evaluateRegexWithCallback(String text,
                                               String regEx,
                                               StringTools.RegexAppendCallback callback)

Analyze a string and invoke a callback when a match is found.

Parameters:

text - the text to analyze

regEx - the regular expression to match

callback - the callback to invoke when a match is found

Returns:

the modified string

getValueOrDefault

public static String getValueOrDefault(String value,
                                       String defaultValue)

Checks the value and returns a non-null value or the default value

Parameters:

value - String to test for null

defaultValue - value to return if value is null

Returns:

a non-null value