com.avaje.ebean.util

Class StringHelper

java.lang.Object

com.avaje.ebean.util.StringHelper

public class StringHelper
extends Object

Utility String class that supports String manipulation functions.

Constructor Summary

Constructors

Constructor and Description
StringHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static int	countOccurances(String content, String occurs) Returns the number of times a particular String occurs in another String.
static String[]	delimitedToArray(String str, String delimiter, boolean keepEmpties) Convert a string that has delimited values (say comma delimited) in a String[].
static Map<String,String>	delimitedToMap(String allNameValuePairs, String listDelimiter, String nameValueSeparator) Parses out a list of Name Value pairs that are delimited together.
static String	getBoundedString(String str, String leftBound, String rightBound) This returns the FIRST string in str that is bounded on the left by leftBound, and bounded on the right by rightBound.
static boolean	isNull(String value) Return true if the value is null or an empty string.
static HashMap<String,String>	parseNameQuotedValue(String tag) parses a String of the form name1='value1' name2='value2'.
static String	removeChar(String s, char chr) This method takes a String as an argument and removes all occurrences of the supplied Char.
static String	removeChars(String s, char[] chr) This method takes a String as an argument and removes all occurrences of the supplied Chars.
static String	replaceString(String source, String match, String replace) This method takes a String and will replace all occurrences of the match String with that of the replace String.
static String	replaceString(String source, String match, String replace, int additionalSize, int startPos, int endPos) Additionally specify the additionalSize to add to the buffer.
static String	replaceStringMulti(String source, String[] match, String replace) A search and replace with multiple matching strings.
static String	replaceStringMulti(String source, String[] match, String replace, int additionalSize, int startPos, int endPos) Additionally specify an additional size estimate for the buffer plus start and end positions.
static String	setBoundedString(String str, String leftBound, String rightBound, String replaceString) Takes the String bounded by leftBound & rightBound, and replaces it with replaceString.
static String	trimFront(String source, String trim) Trims off recurring strings from the front of a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringHelper

public StringHelper()

Method Detail

parseNameQuotedValue

public static HashMap<String,String> parseNameQuotedValue(String tag)
                                                   throws RuntimeException

parses a String of the form name1='value1' name2='value2'. Note that you can use either single or double quotes for any particular name value pair and the end quote must match the begin quote.

Throws:

RuntimeException

countOccurances

public static int countOccurances(String content,
                  String occurs)

Returns the number of times a particular String occurs in another String. e.g. count the number of single quotes.

delimitedToMap

public static Map<String,String> delimitedToMap(String allNameValuePairs,
                                String listDelimiter,
                                String nameValueSeparator)

Parses out a list of Name Value pairs that are delimited together. Will always return a StringMap. If allNameValuePairs is null, or no name values can be parsed out an empty StringMap is returned.

Parameters:

allNameValuePairs - the entire string to be parsed.

listDelimiter - (typically ';') the delimited between the list

nameValueSeparator - (typically '=') the separator between the name and value

trimFront

public static String trimFront(String source,
               String trim)

Trims off recurring strings from the front of a string.

Parameters:

source - the source string

trim - the string to trim off the front

isNull

public static boolean isNull(String value)

Return true if the value is null or an empty string.

delimitedToArray

public static String[] delimitedToArray(String str,
                        String delimiter,
                        boolean keepEmpties)

Convert a string that has delimited values (say comma delimited) in a String[]. You must explicitly choose whether or not to include empty values (say two commas that a right beside each other.

e.g. "alpha,beta,,theta"
With keepEmpties true, this results in a String[] of size 4 with the third one having a String of 0 length. With keepEmpties false, this results in a String[] of size 3.

e.g. ",alpha,beta,,theta,"
With keepEmpties true, this results in a String[] of size 6 with the 1st,4th and 6th one having a String of 0 length. With keepEmpties false, this results in a String[] of size 3.

getBoundedString

public static String getBoundedString(String str,
                      String leftBound,
                      String rightBound)
                               throws RuntimeException

This returns the FIRST string in str that is bounded on the left by leftBound, and bounded on the right by rightBound. This will return null if the leftBound is not found within str.

If leftBound can't be found this returns null.

This rightBound can't be found then this throws a StringIndexOutOfBoundsException.

Parameters:

str - the base string that we will search for the bounded string.

leftBound - the left bound of the string.

rightBound - the right bound of the string.

Throws:

RuntimeException

setBoundedString

public static String setBoundedString(String str,
                      String leftBound,
                      String rightBound,
                      String replaceString)

Takes the String bounded by leftBound & rightBound, and replaces it with replaceString. Actually removes the left and right bound strings aswell.

replaceString

public static String replaceString(String source,
                   String match,
                   String replace)

This method takes a String and will replace all occurrences of the match String with that of the replace String.

Parameters:

source - the source string

match - the string used to find a match

replace - the string used to replace match with

Returns:

the source string after the search and replace

replaceString

public static String replaceString(String source,
                   String match,
                   String replace,
                   int additionalSize,
                   int startPos,
                   int endPos)

Additionally specify the additionalSize to add to the buffer. This will make the buffer bigger so that it doesn't have to grow when replacement occurs.

replaceStringMulti

public static String replaceStringMulti(String source,
                        String[] match,
                        String replace)

A search and replace with multiple matching strings.

Useful when converting CRNL CR and NL all to a BR tag for example.

 
 String[] multi = { "\r\n", "\r", "\n" };
 content = StringHelper.replaceStringMulti(content, multi, "<br/>");
 
 

replaceStringMulti

public static String replaceStringMulti(String source,
                        String[] match,
                        String replace,
                        int additionalSize,
                        int startPos,
                        int endPos)

Additionally specify an additional size estimate for the buffer plus start and end positions.

The start and end positions can limit the search and replace. Otherwise these default to startPos = 0 and endPos = source.length().

removeChar

public static String removeChar(String s,
                char chr)

This method takes a String as an argument and removes all occurrences of the supplied Char. It returns the resulting String.

removeChars

public static String removeChars(String s,
                 char[] chr)

This method takes a String as an argument and removes all occurrences of the supplied Chars. It returns the resulting String.