|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.util.StringUtils
public class StringUtils
Utility class to peform common String manipulation algorithms.
Field Summary | |
---|---|
static java.lang.String |
OTHER_SAFE_CHARACTERS
An array of non-alphanumeric, non-space characters which are web safe. |
Method Summary | |
---|---|
static java.lang.String |
abbreviate(java.lang.String str,
int maxWidth)
Abbreviates a string to a specified length using chop(String, int)
and then adds an ellipsis if the input is greater than the maxWidth. |
static java.lang.String |
chop(java.lang.String string,
int length)
Unintelligently chops a string at a given length. |
static java.lang.String |
chopAtWord(java.lang.String string,
int length)
Intelligently chops a String at a word boundary (whitespace) that occurs at the specified index in the argument or before. |
static java.lang.String |
chopAtWord(java.lang.String string,
int length,
int minLength)
Intelligently chops a String at a word boundary (whitespace) that occurs at the specified index in the argument or before. |
static java.lang.String |
chopAtWordsAround(java.lang.String input,
java.lang.String[] wordList,
int numChars)
Returns a substring of the given string which represents the words around the given word. |
static java.lang.String |
dateToMillis(java.util.Date date)
Formats a Date as a String. |
static long |
decodeAlphaNumeric(java.lang.String encoded)
Decodes the alphanumeric string. |
static byte[] |
decodeBase64(byte[] bytes)
Decodes a BASE64 encoded byte array. |
static java.lang.String |
decodeBase64(java.lang.String data)
Decodes a base64 String. |
static byte[] |
decodeHex(java.lang.String hex)
Turns a hex encoded string into a byte array. |
static java.lang.String |
encodeAlphaNumeric(long toEncode)
Encodes the supplied long as an alphanumeric string. |
static java.lang.String |
encodeBase64(byte[] data)
Encodes a byte array into a base64 String. |
static java.lang.String |
encodeBase64(java.lang.String data)
Encodes a String as a base64 String. |
static java.lang.String |
encodeHex(byte[] bytes)
Turns an array of bytes into a String representing each byte as an unsigned hex number. |
static java.lang.String |
escapeForSQL(java.lang.String string)
Escapes all necessary characters in the String so that it can be used in SQL |
static java.lang.String |
escapeForXML(java.lang.String string)
Escapes all necessary characters in the String so that it can be used in an XML doc. |
static java.lang.String |
escapeHTMLTags(java.lang.String in)
This method takes a string which may contain HTML tags (ie, <b>, <table>, etc) and converts the '<'' and '>' characters to their HTML escape sequences. |
static java.lang.String |
getSpacer(java.lang.String spacer,
int num)
Creates a spacing element given a spacer string and a count (num of times to repeat the spacer. |
static java.lang.String |
getValidEmailDomains()
|
static java.lang.String |
hash(java.lang.String data)
Hashes a String using the Md5 algorithm and returns the result as a String of hexadecimal numbers. |
static java.lang.String |
highlightWords(java.lang.String string,
java.lang.String[] words,
java.lang.String startHighlight,
java.lang.String endHighlight)
Highlights words in a string. |
static boolean |
isValidEmailAddress(java.lang.String addr)
Validate an email address. |
static boolean |
isWebSafeString(java.lang.String str)
Tests to make certain a string is a web safe string. |
static boolean |
isWebSafeString(java.lang.String str,
java.lang.String otherSafeCharacters)
Tests to make certain a string is a web safe string. |
static java.lang.String |
randomString(int length)
Returns a random String of numbers and letters (lower and upper case) of the specified length. |
static java.lang.String |
removeIgnorableCharacters(java.lang.String input)
Removes any character in the given input which are 'ignorable identifiers' in the Java and Unicode language character sets. |
static java.lang.String |
replace(java.lang.String string,
java.lang.String oldString,
java.lang.String newString)
Replaces all instances of oldString with newString in string. |
static java.lang.String |
replace(java.lang.String line,
java.lang.String oldString,
java.lang.String newString,
int[] count)
Replaces all instances of oldString with newString in line. |
static java.lang.String |
replaceIgnoreCase(java.lang.String line,
java.lang.String oldString,
java.lang.String newString)
Replaces all instances of oldString with newString in line with the added feature that matches of newString in oldString ignore case. |
static java.lang.String |
replaceIgnoreCase(java.lang.String line,
java.lang.String oldString,
java.lang.String newString,
int[] count)
Replaces all instances of oldString with newString in line with the added feature that matches of newString in oldString ignore case. |
static java.lang.String |
stripTags(java.lang.String in)
This method takes a string and strips out all tags except tags while still leaving the tag body intact. |
static java.lang.String |
stripTags(java.lang.String in,
boolean stripBRTag)
This method takes a string and strips out all tags while still leaving the tag body intact. |
static java.lang.String[] |
toLowerCaseWordArray(java.lang.String text)
Converts a line of text into an array of lower case words using a BreakIterator.wordInstance(). |
static java.lang.String |
unescapeFromXML(java.lang.String string)
Unescapes the String by converting XML escape sequences back into normal characters. |
static java.lang.String |
URLEncode(java.lang.String original,
java.lang.String charset)
Encodes URI string. |
static java.lang.String |
urlEncodeAndCleanSpaceChars(java.lang.String str)
Encodes a str using UTF-8 character set and the Java URLEncoder.encode() method but then replaces all '+' characters in the encoded string with '%20'. |
static java.lang.String |
wordWrap(java.lang.String input,
int width,
java.util.Locale locale)
Reformats a string where lines that are longer than width are split apart at the earliest wordbreak or at maxLength, whichever is sooner. |
static java.lang.String |
zeroPadString(java.lang.String string,
int length)
Pads the supplied String with 0's to the specified length and returns the result as a new String. |
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 OTHER_SAFE_CHARACTERS
Method Detail |
---|
public static java.lang.String getValidEmailDomains()
public static final java.lang.String replace(java.lang.String string, java.lang.String oldString, java.lang.String newString)
string
- the String to search to perform replacements onoldString
- the String that should be replaced by newStringnewString
- the String that will replace all instances of oldString
public static final java.lang.String replaceIgnoreCase(java.lang.String line, java.lang.String oldString, java.lang.String newString)
line
- the String to search to perform replacements onoldString
- the String that should be replaced by newStringnewString
- the String that will replace all instances of oldString
public static final java.lang.String replaceIgnoreCase(java.lang.String line, java.lang.String oldString, java.lang.String newString, int[] count)
line
- the String to search to perform replacements onoldString
- the String that should be replaced by newStringnewString
- the String that will replace all instances of oldStringcount
- a value that will be updated with the number of replaces
performed.
public static final java.lang.String replace(java.lang.String line, java.lang.String oldString, java.lang.String newString, int[] count)
line
- the String to search to perform replacements onoldString
- the String that should be replaced by newStringnewString
- the String that will replace all instances of oldString
public static final java.lang.String stripTags(java.lang.String in)
in
- the text to be converted.
public static final java.lang.String stripTags(java.lang.String in, boolean stripBRTag)
in
- the text to be converted.
public static final java.lang.String escapeHTMLTags(java.lang.String in)
in
- the text to be converted.
public static final java.lang.String hash(java.lang.String data)
A hash is a one-way function -- that is, given an input, an output is easily computed. However, given the output, the input is almost impossible to compute. This is useful for passwords since we can store the hash and a hacker will then have a very hard time determining the original password.
In Jive, every time a user logs in, we simply take their plain text password, compute the hash, and compare the generated hash to the stored hash. Since it is almost impossible that two passwords will generate the same hash, we know if the user gave us the correct password or not. The only negative to this system is that password recovery is basically impossible. Therefore, a reset password method is used instead.
data
- the String to compute the hash of.
public static final java.lang.String encodeHex(byte[] bytes)
bytes
- an array of bytes to convert to a hex-string
public static final byte[] decodeHex(java.lang.String hex)
hex
- a hex encoded String to transform into a byte array.
public static java.lang.String encodeBase64(java.lang.String data)
data
- a String to encode.
public static java.lang.String decodeBase64(java.lang.String data)
data
- a base64 encoded String to decode.
public static java.lang.String encodeAlphaNumeric(long toEncode)
toEncode
- the long value to encode.
public static long decodeAlphaNumeric(java.lang.String encoded)
encoded
- the alphanumeric String to decode.
public static java.lang.String encodeBase64(byte[] data)
data
- a byte array to encode.
public static final byte[] decodeBase64(byte[] bytes)
bytes
- the source array.
public static java.lang.String URLEncode(java.lang.String original, java.lang.String charset) throws java.io.UnsupportedEncodingException
original
- the original character sequencecharset
- the protocol charset
java.io.UnsupportedEncodingException
- unsupported character encodingpublic static final java.lang.String[] toLowerCaseWordArray(java.lang.String text)
This method is under the Jive Open Source Software License and was written by Mark Imbriaco.
text
- a String of text to convert into an array of words
public static final java.lang.String randomString(int length)
The specified length must be at least one. If not, the method will return null.
length
- the desired length of the random String to return.
public static final java.lang.String chop(java.lang.String string, int length)
string
- the string to chop.length
- the maximum number of characters to show.
public static final java.lang.String chopAtWord(java.lang.String string, int length, int minLength)
length
, the String will be chopped
there. If no newline or whitespace is found in string
up to
the index length
, the String will chopped at length
.
For example, chopAtWord("This is a nice String", 10, -1) will return "This is a" which is the first word boundary less than or equal to 10 characters into the original String.
string
- the String to chop.length
- the index in string
to start looking for a
whitespace boundary at.minLength
- the minimum length the word should be chopped at. This is helpful
for words with no natural boundaries, ie: "thisisareallylonglonglongword".
This must be smaller than length and can be -1 if no minLength is wanted
string
whose length is less than or
equal to length
, and that is chopped at whitespace.public static final java.lang.String chopAtWord(java.lang.String string, int length)
length
, the String will be chopped
there. If no newline or whitespace is found in string
up to
the index length
, the String will chopped at length
.
For example, chopAtWord("This is a nice String", 10) will return "This is a" which is the first word boundary less than or equal to 10 characters into the original String.
string
- the String to chop.length
- the index in string
to start looking for a
whitespace boundary at.
string
whose length is less than or
equal to length
, and that is chopped at whitespace.public static java.lang.String chopAtWordsAround(java.lang.String input, java.lang.String[] wordList, int numChars)
Note: The wordList passed in should be lowercase.
input
- The string to parse.wordList
- The words to look for - the first one found in the string is used.numChars
- The number of characters on either side to include in the chop.
public static java.lang.String wordWrap(java.lang.String input, int width, java.util.Locale locale)
Please note that this method can be lossy - trailing spaces on wrapped lines may be trimmed.
input
- the String to reformat.width
- the maximum length of any one line.
public static final java.lang.String highlightWords(java.lang.String string, java.lang.String[] words, java.lang.String startHighlight, java.lang.String endHighlight)
This method is under the Jive Open Source Software License and was written by Mark Imbriaco.
string
- the String to highlight words in.words
- an array of words that should be highlighted in the string.startHighlight
- the tag that should be inserted to start highlighting.endHighlight
- the tag that should be inserted to end highlighting.
public static final java.lang.String escapeForSQL(java.lang.String string)
string
- the string to escape.
public static final java.lang.String escapeForXML(java.lang.String string)
string
- the string to escape.
public static final java.lang.String unescapeFromXML(java.lang.String string)
string
- the string to unescape.
public static final java.lang.String zeroPadString(java.lang.String string, int length)
string
- the original String to pad.length
- the desired length of the new padded String.
public static final java.lang.String dateToMillis(java.util.Date date)
public static boolean isValidEmailAddress(java.lang.String addr)
addr
- the email address to validate
public static java.lang.String removeIgnorableCharacters(java.lang.String input)
Removes any character in the given input which are 'ignorable identifiers' in the Java and Unicode language character sets. This is helpful for things like RSS feeds which sends a message body out which might contain high-order characters. This might happen if the messages has content pasted from MS Word or other applications.
This internally calls Character.isIdentifierIgnorable(char)
to determine if
a character is ignorable. Please read the Javadocs on that method for a list of ignorable
characters.
input
- the input to test.
public static java.lang.String getSpacer(java.lang.String spacer, int num)
spacer
- a spacer string ie, " " or " ".num
- the number of times to repeat the spacer string.
public static java.lang.String abbreviate(java.lang.String str, int maxWidth)
chop(String, int)
and then adds an ellipsis if the input is greater than the maxWidth. Example input:
This is the body of a great blog post.and a maximum length of 20 characters, the abbreviate method will return:
This is the body of...
str
- the String to abbreviate.maxWidth
- the maximum size of the string, minus the ellipsis.
public static boolean isWebSafeString(java.lang.String str)
Character.SPACE_SEPARATOR
Character.LINE_SEPARATOR
Character.PARAGRAPH_SEPARATOR
str
- the string being tested.
OTHER_SAFE_CHARACTERS
public static boolean isWebSafeString(java.lang.String str, java.lang.String otherSafeCharacters)
Character.SPACE_SEPARATOR
Character.LINE_SEPARATOR
Character.PARAGRAPH_SEPARATOR
str
- the string being tested.otherSafeCharacters
- other safe characters which can be permitted in the input String.
public static java.lang.String urlEncodeAndCleanSpaceChars(java.lang.String str)
str
- the string being encoded.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |