com.atlassian.renderer.util

Class TextUtils

java.lang.Object

com.atlassian.renderer.util.TextUtils

public class TextUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	SINGLE_TAGS

Constructor Summary

Constructors

Constructor and Description
TextUtils()

Method Summary

Modifier and Type	Method and Description
static String	closeTags(String str) Search through a String for any tags that have been opened and append closing tags for those that have not been closed.
static String	htmlEncode(String s)
static String	htmlEncode(String s, boolean encodeSpecialChars) Escape html entity characters and high characters (eg "curvy" Word quotes).
static String	join(String glue, Collection pieces) Join a Collection of Strings together.
static String	join(String glue, Iterator pieces) Join an Iteration of Strings together.
static String	noNull(String string)
static String	noNull(String string, String defaultString) Return string, or defaultString if string is null or "".
static float	parseFloat(String in) Convert a String to a float.
static int	parseInt(String in) Convert a String to an int.
static boolean	stringSet(String string) Check whether string has been set to something other than "" or null.
static String	trimToEndingChar(String str, int len) Trim a String to the specified length.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_TAGS

public static final String[] SINGLE_TAGS

Constructor Detail

TextUtils

public TextUtils()

Method Detail

stringSet

public static boolean stringSet(String string)

Check whether string has been set to something other than "" or null.

Parameters:

string - the String to check

Returns:

a boolean indicating whether the string was non-empty (and non-null)

noNull

public static String noNull(String string,
                            String defaultString)

Return string, or defaultString if string is null or "". Never returns null.

Examples:

 // prints "hello"
 String s=null;
 System.out.println(TextUtils.noNull(s,"hello");

 // prints "hello"
 s="";
 System.out.println(TextUtils.noNull(s,"hello");

 // prints "world"
 s="world";
 System.out.println(TextUtils.noNull(s, "hello");
 

Parameters:

string - the String to check.

defaultString - The default string to return if string is null or ""

Returns:

string if string is non-empty, and defaultString otherwise

See Also:

stringSet(java.lang.String)

noNull

public static String noNull(String string)

join

public static String join(String glue,
                          Iterator pieces)

Join an Iteration of Strings together.

Example

   // get Iterator of Strings ("abc","def","123");
   Iterator i = getIterator();
   out.print( TextUtils.join(", ",i) );
   // prints: "abc, def, 123"
 

Parameters:

glue - Token to place between Strings.

pieces - Iteration of Strings to join.

Returns:

String presentation of joined Strings.

join

public static final String join(String glue,
                                Collection pieces)

Join a Collection of Strings together.

Parameters:

glue - Token to place between Strings.

pieces - Collection of Strings to join.

Returns:

String presentation of joined Strings.

See Also:

join(String, java.util.Iterator)

parseInt

public static int parseInt(String in)

Convert a String to an int. Truncates numbers if it's a float string; for example, 4.5 yields a value of 4.

Parameters:

in - String containing number to be parsed.

Returns:

Integer value of number or 0 if error.

parseFloat

public static float parseFloat(String in)

Convert a String to a float.

Parameters:

in - String containing number to be parsed.

Returns:

Float value of number or 0 if error.

trimToEndingChar

public static String trimToEndingChar(String str,
                                      int len)

Trim a String to the specified length. However, if the cutoff point is in the middle of a sentence (remember that a String can contain many sentences), trim the string such that it ends with an ending char, which is defined in the isEndingChar() method.

Parameters:

str - - String to trim.

len - - length to which string is to be trimmed.

Returns:

the trimmed string

closeTags

public static final String closeTags(String str)

Search through a String for any tags that have been opened and append closing tags for those that have not been closed.

Parameters:

str - A string possibly containing unclosed HTML tags

Returns:

the converted string #see #SINGLE_TAGS

htmlEncode

public static final String htmlEncode(String s)

htmlEncode

public static final String htmlEncode(String s,
                                      boolean encodeSpecialChars)

Escape html entity characters and high characters (eg "curvy" Word quotes). Note this method can also be used to encode XML.

Parameters:

s - the String to escape.

encodeSpecialChars - if true high characters will be encode other wise not.

Returns:

the escaped string