com.force.i18n.commons.text

Class TextUtil

java.lang.Object

com.force.i18n.commons.text.TextUtil

@Beta
public final class TextUtil
extends Object

A package of generic text utility functions. Beta class. Classes under com.force.i18n.commons package will be moved into a dedicated project.

Author:

davem,pnakada,jjordano,et. al.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextUtil.SuspiciousValueLogger Interface you can i

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_GACK_LENGTH

Constructor Summary

Constructors

Constructor and Description
TextUtil()

Method Summary

Modifier and Type	Method and Description
static String	breakLongWordsAndEscapeToHTML(String text, boolean preserveNewLinesInHtml) Break long words and escape markup to HTML.
static String	breakLongWordsAndEscapeToHTML(String text, boolean preserveNewLinesInHtml, int maxWordLength) Break long words and escape markup to HTML.
static String	escapeForMessageFormat(String str)
static StringBuilder	escapeForMessageFormat(String src, StringBuilder sb, boolean check) Single-quotes and curly brackets are special characters used by Java's MessageFormat class.
static String	escapeToHtml(String value) Escape output being sent to the user to be safe in HTML.
static String	escapeToHtml(String value, boolean escapeNewline) Escape output being sent to the user to be safe in HTML.
static String	escapeToXml(CharSequence input) Escapes Strings into valid xml.
static String	escapeToXml(CharSequence input, boolean allowNewLines, boolean convertNulls)
static String	escapeToXml(CharSequence input, boolean allowNewLines, boolean convertNulls, boolean escapeApos)
static String	escapeToXml(CharSequence input, boolean allowNewLines, boolean convertNulls, boolean escapeApos, boolean preserveWhitespace) Escapes Strings into valid xml.
static Comparator<String>	getComparator(Collator collator, int size)
static String	initCap(String in) Makes the first letter of the input string upper case.
static boolean	isEmptyOrWhitespace(CharSequence str)
static boolean	isIsoControlOrOddUnicode(char c) Determines if the given input char is an iso-control character, undefined, or in an unusable Unicode block.
static boolean	isNullEmptyOrWhitespace(CharSequence str)
static String	join(String separator, Object... objects) Concatenate the string values of zero or more objects.
static String	join(String separator, String... strings) Concatenate the string values of zero or more strings.
protected static void	logValue(String source, CharSequence value)
static List<String>	splitSimple(String delimiter, String str) Splits the given string str using the given delimiter and returns the result as a string list.
static List<String>	splitSimple(String delimiter, String str, int expectedSize) Splits the given string str using the given delimiter and returns the result as a string list.
static List<String>	splitSimpleAndTrim(String str, String delimiter, int expectedSize) Splits the given string str using the given delimiter, trims each element, and returns the result as a string list.
static String	trim(String str)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_GACK_LENGTH

public static final int MIN_GACK_LENGTH

See Also:

Constant Field Values

Constructor Detail

TextUtil

public TextUtil()

Method Detail

logValue

protected static void logValue(String source,
                               CharSequence value)

escapeToXml

public static String escapeToXml(CharSequence input)

Escapes Strings into valid xml. Similar to escapeInput except that it will also replace control characters with spaces.

Unless you are writing an element class or writing something that doesn't use elements, you probably shouldn't call this method.

Calling this method in conjunction with an element is an error and will result in double-escaping.

The convention in the app is that all escaping is done at output time by Elements and output should go through elements when possible. If you are using this method, you should think carefully about what you are doing and decide if it's truly necessary to bypass elements.

escapeToXml

public static String escapeToXml(CharSequence input,
                                 boolean allowNewLines,
                                 boolean convertNulls)

escapeToXml

public static String escapeToXml(CharSequence input,
                                 boolean allowNewLines,
                                 boolean convertNulls,
                                 boolean escapeApos)

escapeToXml

public static String escapeToXml(CharSequence input,
                                 boolean allowNewLines,
                                 boolean convertNulls,
                                 boolean escapeApos,
                                 boolean preserveWhitespace)

Escapes Strings into valid xml. Similar to escapeInput except that it will also replace control characters with spaces.

Unless you are writing an element class or writing something that doesn't use elements, you probably shouldn't call this method.

Calling this method in conjunction with an element is an error and will result in double-escaping.

The convention in the app is that all escaping is done at output time by Elements and output should go through elements when possible. If you are using this method, you should think carefully about what you are doing and decide if it's truly necessary to bypass elements.

Parameters:

input - the text to escape

allowNewLines - if false, newlines (\r or \n) are converted to spaces instead

convertNulls - convert nulls to the empty string if treu

escapeApos - Add a backslash in front of apostrophes to deal with MSXML's nonsense

preserveWhitespace - if true, whitespace chars (as defined by Character.isWhitespace(char)) are not converted to spaces. If false, they may be converted to spaces if they are control characters. This argument is weaker than allowNewLines, so if allowNewLines is true but this argument is false, newlines will be preserved anyway. Since newlines are also whitespace, if allowNewLines is false but this argument is true, then newlines will still be preserved.

isIsoControlOrOddUnicode

public static boolean isIsoControlOrOddUnicode(char c)

Determines if the given input char is an iso-control character, undefined, or in an unusable Unicode block.

escapeToHtml

public static String escapeToHtml(String value)

Escape output being sent to the user to be safe in HTML. Replaces < > & " etc. with their HTML escape sequences. Does not translate \n's.

Unless you are writing an element class or writing something that doesn't use elements, you probably shouldn't call this method.

Calling this method in conjunction with an element is an error and will result in double-escaping.

The convention in the app is that all escaping is done at output time by Elements and output should go through elements when possible. If you are using this method, you should think carefully about what you are doing and decide if it's truly necessary to bypass elements.

escapeToHtml

public static String escapeToHtml(String value,
                                  boolean escapeNewline)

Escape output being sent to the user to be safe in HTML. Replaces < > & " etc. with their HTML escape sequences. Also translates '\n' to <br> if escapeNewline is true.

Unless you are writing an element class or writing something that doesn't use elements, you probably shouldn't call this method.

Calling this method in conjunction with an element is an error and will result in double-escaping.

The convention in the app is that all escaping is done at output time by Elements and output should go through elements when possible. If you are using this method, you should think carefully about what you are doing and decide if it's truly necessary to bypass elements.

trim

public static String trim(String str)

Returns:

a copy of the string, with all leading and trailing whitespace characters omitted. This is different from java.lang.String.trim(), which only trims characters before '\u0020' but not characters like the wide space character in Japanese ('\u3000'). will return an empty String if the input String is all whitespace

isNullEmptyOrWhitespace

public static boolean isNullEmptyOrWhitespace(CharSequence str)

isEmptyOrWhitespace

public static boolean isEmptyOrWhitespace(CharSequence str)

splitSimple

public static List<String> splitSimple(String delimiter,
                                       String str)

Splits the given string str using the given delimiter and returns the result as a string list. If str is null, then null is returned.

The returned string list is an ArrayList that is constructed using the 4 as the ArrayList's initial size. If you expect to have more than four elements more than just on the rare occasion, then please consider using another splitSimple overload that lets you pass in the expected size.

This is more efficient than String.split or TextUtil.split because it does not use a regular expression.

CAUTION: The str and delimiter parameters are in an order that differs from other string splitting methods. Be absolutely sure that you get the str and delimiter parameter arguments correct. This may eventually be fixed with a refactoring.

Parameters:

delimiter - The delimiter to split the string using

str - The string to split

Returns:

String list or, if str was null, then null

splitSimple

public static List<String> splitSimple(String delimiter,
                                       String str,
                                       int expectedSize)

Splits the given string str using the given delimiter and returns the result as a string list. If str is null, then null is returned.

The returned string list is an ArrayList that is constructed using the given expected size as the ArrayList's initial size. If you are not aware of the expected size, then use 0, which will cause this method to use a LinkedList instead of an ArrayList.

This is more efficient than String.split or TextUtil.split because it does not use a regular expression.

CAUTION: The str and delimiter parameters are in an order that differs from other string splitting methods. Be absolutely sure that you get the str and delimiter parameter arguments correct. This may eventually be fixed with a refactoring.

Parameters:

delimiter - The delimiter to split the string using

str - The string to split

expectedSize - The expected number of elements in the output list. If you don't know, or if it could be arbitrarily large, and if you will only access the returned list sequentially with an iterator, then use 0 to tell this method to use a LinkedList

Returns:

String list or, if str was null, then null

splitSimpleAndTrim

public static List<String> splitSimpleAndTrim(String str,
                                              String delimiter,
                                              int expectedSize)

Splits the given string str using the given delimiter, trims each element, and returns the result as a string list. If str is null, then null is returned.

The returned string list is an ArrayList that is constructed using the given expected size as the ArrayList's initial size. If you are not aware of the expected size, then use 0, which will cause this method to use a LinkedList instead of an ArrayList.

This is more efficient than String.split or TextUtil.split because it does not use a regular expression.

Parameters:

str - The string to split

delimiter - The delimiter to split the string using

expectedSize - The expected number of elements in the output list. If you don't know, or if it could be arbitrarily large, and if you will only access the returned list sequentially with an iterator, then use 0 to tell this method to use a LinkedList

Returns:

String list or, if str was null, then null

initCap

public static String initCap(String in)

Makes the first letter of the input string upper case.

escapeForMessageFormat

public static String escapeForMessageFormat(String str)

escapeForMessageFormat

public static StringBuilder escapeForMessageFormat(String src,
                                                   StringBuilder sb,
                                                   boolean check)

Single-quotes and curly brackets are special characters used by Java's MessageFormat class. Specify check = true to only escape if a numbered param (eg. {0}) is specified The escaping rules are: 1) All single quotes => '' 2) All left curly brackets that are not part of a numbered param need to be wrapped with single quotes => '{' NOTE: There's only support for wrapping left curly brackets with single-quotes; any other use of single-quotes will be escaped

breakLongWordsAndEscapeToHTML

public static String breakLongWordsAndEscapeToHTML(String text,
                                                   boolean preserveNewLinesInHtml)

Break long words and escape markup to HTML. This method does not activate links.

Parameters:

text - the text to break and escape

preserveNewLinesInHtml - whether to preserve new line characters (\n) as
tags

Returns:

the escaped and broken string

breakLongWordsAndEscapeToHTML

public static String breakLongWordsAndEscapeToHTML(String text,
                                                   boolean preserveNewLinesInHtml,
                                                   int maxWordLength)

Break long words and escape markup to HTML. This method does not activate links.

Parameters:

text - the text to break and escape

preserveNewLinesInHtml - whether to preserve new line characters (\n) as
tags

maxWordLength - words longer than this will be broken with tags (defaults to 30)

Returns:

the escaped and broken string

join

public static String join(String separator,
                          String... strings)

Concatenate the string values of zero or more strings.

Parameters:

separator - - string that will delimit the result.

strings - - the strings whose values will be concatenated

join

public static String join(String separator,
                          Object... objects)

Concatenate the string values of zero or more objects.

Parameters:

separator - - string that will delimit the result.

objects - - the objects whose string values will be concatenated

getComparator

public static Comparator<String> getComparator(Collator collator,
                                               int size)

Parameters:

the - number of elements to compare (default is 16).

Returns:

a new fast comparator for strings for the given collator.