|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.util.TextUtils
Utilities for common String manipulations. This is a class contains static methods only and is not meant to be instantiated.
Field Summary | |
static java.lang.String[] |
SINGLE_TAGS
An array of HTML tags that, in HTML, don't require closing tags. |
Constructor Summary | |
TextUtils()
|
Method Summary | |
static java.lang.String |
br(java.lang.String s)
Convert line breaks to html <br> tag. |
static java.lang.String |
closeTags(java.lang.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 java.lang.String |
colorToHex(java.awt.Color c)
Convert Color to html hex string. |
static byte[] |
decodeBytes(java.lang.String str)
Decode binary data from String using base64. |
static java.lang.Object |
decodeObject(java.lang.String str)
Decode Object from a String by decoding with base64 then deserializing. |
static java.lang.String |
encodeBytes(byte[] data)
Encode binary data into String using base64. |
static java.lang.String |
encodeObject(java.lang.Object o)
Encode an Object to String by serializing it and encoding using base64. |
static java.lang.String |
extractNumber(java.lang.String in)
Extract a number from a String. |
static java.awt.Color |
hexToColor(java.lang.String color)
Convert html hex string to Color. |
static java.lang.String |
html(java.lang.String s)
Deprecated. use htmlEncode(String) instead. |
static java.lang.String |
htmlEncode(java.lang.String s)
Escape html entity characters and high characters (eg "curvy" Word quotes). |
static java.lang.String |
hyperlink(java.lang.String text)
Convert all URLs and E-mail addresses in a string into hyperlinks. |
static java.lang.String |
hyperlink(java.lang.String text,
java.lang.String target)
Convert all URLs and E-mail addresses in a string into hyperlinks. |
static java.lang.String |
indent(java.lang.String string,
int indentSize,
boolean initialLine)
Indent a String with line-breaks. |
static java.lang.String |
innerTrim(java.lang.String s)
Returns a string that has whitespace removed from both ends of the String, as well as duplicate whitespace removed from within the String. |
static java.lang.String |
join(java.lang.String glue,
java.util.Collection pieces)
Join a Collection of Strings together. |
static java.lang.String |
join(java.lang.String glue,
java.util.Iterator pieces)
Join an Iteration of Strings together. |
static java.lang.String |
join(java.lang.String glue,
java.lang.String[] pieces)
Join an array of Strings together. |
static java.lang.String |
leadingSpaces(java.lang.String s)
Finds all leading spaces on each line and replaces it with an HTML space ( ) |
static java.lang.String |
left(java.lang.String s,
int n)
Returns the leftmost n chars of the string. |
static java.lang.String |
linkEmail(java.lang.String str)
Wrap all email addresses in specified string with href tags. |
static java.lang.String |
linkURL(java.lang.String str)
Wrap all urls ('http://', 'www.', and 'ftp://') in specified string with href tags. |
static java.lang.String |
linkURL(java.lang.String str,
java.lang.String target)
Wrap all urls ('abc://' and 'www.abc') in specified string with href tags. |
static java.lang.String |
list(java.lang.String str)
Create elements in a piece of plain text; Will convert lines starting with - or *. |
static java.lang.String |
noNull(java.lang.String string)
Return string , or "" if string
is null . |
static java.lang.String |
noNull(java.lang.String string,
java.lang.String defaultString)
Return string , or defaultString if
string is null or "" . |
static boolean |
parseBoolean(java.lang.String in)
Convert a String to an boolean. |
static java.util.Date |
parseDate(java.lang.String year,
java.lang.String month,
java.lang.String day)
Given 3 Strings representing the the year, month and day, return a Date object. |
static double |
parseDouble(java.lang.String in)
Convert a String to a double. |
static float |
parseFloat(java.lang.String in)
Convert a String to a float. |
static int |
parseInt(java.lang.String in)
Convert a String to an int. |
static long |
parseLong(java.lang.String in)
Convert a String to a long. |
static java.lang.String |
plainTextToHtml(java.lang.String str)
Converts plain text to html code. |
static java.lang.String |
plainTextToHtml(java.lang.String str,
java.lang.String target)
Converts plain text to html code. |
static java.lang.String |
removeAndInsert(java.lang.String str,
int removeAndInsertStart,
int removeEnd,
java.lang.String insertStr)
Removes part of the original string starting at removeAndInsertStart and ending at removeEnd. |
static java.lang.String |
slashes(java.lang.String s)
Escape chars that need slashes in front of them. |
static boolean |
stringSet(java.lang.String string)
Check whether string has been set to
something other than "" or null . |
static java.lang.String |
trimToEndingChar(java.lang.String str,
int len)
Trim a String to the specified length. |
static boolean |
verifyEmail(java.lang.String email)
Verify that the given string is a valid email address. |
static boolean |
verifyUrl(java.lang.String url)
Verify That the given String is in valid URL format. |
static java.lang.String |
wrapParagraph(java.lang.String s)
Wrap paragraphs in html <p> tags. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String[] SINGLE_TAGS
Constructor Detail |
public TextUtils()
Method Detail |
public static final java.lang.String br(java.lang.String s)
<br>
tag.
s
- the String to convert
public static final java.lang.String closeTags(java.lang.String str)
str
- A string possibly containing unclosed HTML tags
public static final java.lang.String colorToHex(java.awt.Color c)
c
- the Color to convert
public static final byte[] decodeBytes(java.lang.String str) throws java.io.IOException
java.io.IOException
encodeBytes(byte[])
public static final java.lang.Object decodeObject(java.lang.String str) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException
encodeObject(java.lang.Object)
public static final java.lang.String encodeBytes(byte[] data) throws java.io.IOException
java.io.IOException
decodeBytes(java.lang.String)
public static final java.lang.String encodeObject(java.lang.Object o) throws java.io.IOException
java.io.IOException
decodeObject(java.lang.String)
public static final java.lang.String extractNumber(java.lang.String in)
" 12345" -> "12345" "hello123bye" -> "123" "a2b4c6 8 " -> "2468" " -22" -> "-22" "5.512" -> "5.512" "1.2.3.4" -> "1.234" ".2" -> "0.2" "-555.7" -> "-555.7" "-..6" -> "-0.6" "abc- dx.97 9" -> "-0.979" "?1,000,000.00 per year" -> "1000000.00" "" -> "0" "asdsf" -> "0" "123." -> "123" null -> "0"
in
- Original String containing number to be extracted.
parseInt(String)
,
parseLong(String)
public static final java.awt.Color hexToColor(java.lang.String color)
Color.black
is returned.
Only the first six hexadecimal characters are considered; any
extraneous values are discarded. Also, a leading "#", if any, is allowed
(and ignored).
color
- the String (in RGB hexadecimal format) to convert
public static final java.lang.String html(java.lang.String s)
public static final java.lang.String htmlEncode(java.lang.String s)
s
- the String to escape.
public static final java.lang.String hyperlink(java.lang.String text)
text
- The block of text to hyperlink.
hyperlink(String, String)
public static final java.lang.String hyperlink(java.lang.String text, java.lang.String target)
text
- The block of text to hyperlink.target
- The target attribute to use for href (optional).
linkEmail(String)
,
linkURL(String)
public static final java.lang.String indent(java.lang.String string, int indentSize, boolean initialLine)
string
- String to indent.indentSize
- Number of spaces to indent by. 0 will indent using a tab.initialLine
- Whether to indent initial line.
public static final java.lang.String innerTrim(java.lang.String s)
public static final java.lang.String join(java.lang.String glue, java.util.Iterator pieces)
// get Iterator of Strings ("abc","def","123"); Iterator i = getIterator(); out.print( TextUtils.join(", ",i) ); // prints: "abc, def, 123"
glue
- Token to place between Strings.pieces
- Iteration of Strings to join.
public static final java.lang.String join(java.lang.String glue, java.lang.String[] pieces)
glue
- Token to place between Strings.pieces
- Array of Strings to join.
join(String, java.util.Iterator)
public static final java.lang.String join(java.lang.String glue, java.util.Collection pieces)
glue
- Token to place between Strings.pieces
- Collection of Strings to join.
join(String, java.util.Iterator)
public static final java.lang.String leadingSpaces(java.lang.String s)
s
- string containing text to replaced with
public static final java.lang.String left(java.lang.String s, int n)
s
- - the string to operate on.n
- - the number of chars to return.public static final java.lang.String linkEmail(java.lang.String str)
str
- The block of text to check.
public static final java.lang.String linkURL(java.lang.String str)
str
- The block of text to check.
public static final java.lang.String linkURL(java.lang.String str, java.lang.String target)
str
- The block of text to check.target
- The target to use for the href (optional).
public static final java.lang.String list(java.lang.String str)
str
- A string, possibly containing a plaintext "list"
public static final java.lang.String noNull(java.lang.String string, java.lang.String defaultString)
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");
string
- the String to check.defaultString
- The default string to return if string
is null
or ""
string
if string
is non-empty, and defaultString
otherwisestringSet(java.lang.String)
public static final java.lang.String noNull(java.lang.String string)
string
, or ""
if string
is null
. Never returns null
.
Examples:
// prints 0 String s=null; System.out.println(TextUtils.noNull(s).length()); // prints 1 s="a"; System.out.println(TextUtils.noNull(s).length());
string
- the String to check
public static final boolean parseBoolean(java.lang.String in)
false
is returned.
in
- String to be parsed.
public static final java.util.Date parseDate(java.lang.String year, java.lang.String month, java.lang.String day)
If the day cannot be determined, 1st will be used. If the month cannot be determined, Jan will be used.
year
- Year : 4 digitmonth
- Month : 1 or 2 digit (1=jan, 2=feb, ...) or name (jan, JAN, January, etc). If null, default is Jan.day
- Day of month : 1 or 2 digit, prefix will be stripped (1, 30, 05, 3rd). If null, default is 1st.public static final double parseDouble(java.lang.String in)
in
- String containing number to be parsed.
extractNumber(String)
public static final float parseFloat(java.lang.String in)
in
- String containing number to be parsed.
extractNumber(String)
public static final int parseInt(java.lang.String in)
in
- String containing number to be parsed.
extractNumber(String)
public static final long parseLong(java.lang.String in)
in
- String containing number to be parsed.
extractNumber(String)
public static final java.lang.String plainTextToHtml(java.lang.String str)
str
- - String containing the plain text.
public static final java.lang.String plainTextToHtml(java.lang.String str, java.lang.String target)
str
- - String containing the plain text.target
- - Target for href tags (optional).
public static final java.lang.String removeAndInsert(java.lang.String str, int removeAndInsertStart, int removeEnd, java.lang.String insertStr)
str
- - the original string.removeAndInsertStart
- - the index within the original string at which removal is to start.removeEnd
- - the index within the original string at which removal is to end (exclusive - ie. does not
remove the character at that index).insertStr
- - the string to be inserted.public static final java.lang.String slashes(java.lang.String s)
s
- the String to add escape characters to
public static final boolean stringSet(java.lang.String string)
string
has been set to
something other than ""
or null
.
string
- the String
to check
public static final java.lang.String trimToEndingChar(java.lang.String str, int len)
str
- - String to trim.len
- - length to which string is to be trimmed.
public static final boolean verifyEmail(java.lang.String email)
email
- The email address to verify.
public static final boolean verifyUrl(java.lang.String url)
url
- The url string to verify.
public static final java.lang.String wrapParagraph(java.lang.String s)
<p>
tags.
Paragraphs are seperated by blank lines.
s
- the String to reformat
|
See www.opensymphony.com for more information. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |