|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.lang.CharSetUtils
public class CharSetUtils
Operations on CharSet
s.
This class handles null
input gracefully.
An exception will not be thrown for a null
input.
Each method documents its behaviour in more detail.
CharSet
Constructor Summary | |
---|---|
CharSetUtils()
CharSetUtils instances should NOT be constructed in standard programming. |
Method Summary | |
---|---|
static int |
count(String str,
String set)
Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string. |
static int |
count(String str,
String[] set)
Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string. |
static String |
delete(String str,
String set)
Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string. |
static String |
delete(String str,
String[] set)
Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string. |
static CharSet |
evaluateSet(String[] set)
Deprecated. Use CharSet.getInstance(String) .
Method will be removed in Commons Lang 3.0. |
static String |
keep(String str,
String set)
Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string. |
static String |
keep(String str,
String[] set)
Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string. |
static String |
squeeze(String str,
String set)
Squeezes any repetitions of a character that is mentioned in the supplied set. |
static String |
squeeze(String str,
String[] set)
Squeezes any repetitions of a character that is mentioned in the supplied set. |
static String |
translate(String str,
String searchChars,
String replaceChars)
Deprecated. Use StringUtils.replaceChars(String, String, String) .
Method will be removed in Commons Lang 3.0.
NOTE: StringUtils#replaceChars behaves differently when 'searchChars' is longer
than 'replaceChars'. CharSetUtils#translate will use the last char of the replacement
string whereas StringUtils#replaceChars will delete |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CharSetUtils()
CharSetUtils instances should NOT be constructed in standard programming.
Instead, the class should be used as CharSetUtils.evaluateSet(null);
.
This constructor is public to permit tools that require a JavaBean instance to operate.
Method Detail |
---|
public static CharSet evaluateSet(String[] set)
CharSet.getInstance(String)
.
Method will be removed in Commons Lang 3.0.
Creates a CharSet
instance which allows a certain amount of
set logic to be performed.
The syntax is:
CharSetUtils.evaluateSet(null) = null CharSetUtils.evaluateSet([]) = CharSet matching nothing CharSetUtils.evaluateSet(["a-e"]) = CharSet matching a,b,c,d,e
set
- the set, may be null
null
if null inputpublic static String squeeze(String str, String set)
Squeezes any repetitions of a character that is mentioned in the supplied set.
CharSetUtils.squeeze(null, *) = null CharSetUtils.squeeze("", *) = "" CharSetUtils.squeeze(*, null) = * CharSetUtils.squeeze(*, "") = * CharSetUtils.squeeze("hello", "k-p") = "helo" CharSetUtils.squeeze("hello", "a-e") = "hello"
str
- the string to squeeze, may be nullset
- the character set to use for manipulation, may be null
null
if null string inputfor set-syntax.
public static String squeeze(String str, String[] set)
Squeezes any repetitions of a character that is mentioned in the supplied set.
An example is:
str
- the string to squeeze, may be nullset
- the character set to use for manipulation, may be null
null
if null string inputfor set-syntax.
public static int count(String str, String set)
Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string.
CharSetUtils.count(null, *) = 0 CharSetUtils.count("", *) = 0 CharSetUtils.count(*, null) = 0 CharSetUtils.count(*, "") = 0 CharSetUtils.count("hello", "k-p") = 3 CharSetUtils.count("hello", "a-e") = 1
str
- String to count characters in, may be nullset
- String set of characters to count, may be null
for set-syntax.
public static int count(String str, String[] set)
Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string.
An example would be:
str
- String to count characters in, may be nullset
- String[] set of characters to count, may be null
for set-syntax.
public static String keep(String str, String set)
Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string.
CharSetUtils.keep(null, *) = null CharSetUtils.keep("", *) = "" CharSetUtils.keep(*, null) = "" CharSetUtils.keep(*, "") = "" CharSetUtils.keep("hello", "hl") = "hll" CharSetUtils.keep("hello", "le") = "ell"
str
- String to keep characters from, may be nullset
- String set of characters to keep, may be null
null
if null string inputfor set-syntax.
public static String keep(String str, String[] set)
Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string.
An example would be:
str
- String to keep characters from, may be nullset
- String[] set of characters to keep, may be null
null
if null string inputfor set-syntax.
public static String delete(String str, String set)
Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string.
CharSetUtils.delete(null, *) = null CharSetUtils.delete("", *) = "" CharSetUtils.delete(*, null) = * CharSetUtils.delete(*, "") = * CharSetUtils.delete("hello", "hl") = "eo" CharSetUtils.delete("hello", "le") = "ho"
str
- String to delete characters from, may be nullset
- String set of characters to delete, may be null
null
if null string inputfor set-syntax.
public static String delete(String str, String[] set)
Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string.
An example would be:
str
- String to delete characters from, may be nullset
- String[] set of characters to delete, may be null
null
if null string inputfor set-syntax.
public static String translate(String str, String searchChars, String replaceChars)
StringUtils.replaceChars(String, String, String)
.
Method will be removed in Commons Lang 3.0.
NOTE: StringUtils#replaceChars behaves differently when 'searchChars' is longer
than 'replaceChars'. CharSetUtils#translate will use the last char of the replacement
string whereas StringUtils#replaceChars will delete
Translate characters in a String. This is a multi character search and replace routine.
An example is:
If the length of characters to search for is greater than the length of characters to replace, then the last character is used.
CharSetUtils.translate(null, *, *) = null CharSetUtils.translate("", *, *) = ""
str
- String to replace characters in, may be nullsearchChars
- a set of characters to search for, must not be nullreplaceChars
- a set of characters to replace, must not be null or empty ("")
null
if null string input
NullPointerException
- if searchChars
or replaceChars
is null
ArrayIndexOutOfBoundsException
- if replaceChars
is empty ("")
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |