Package org.apache.commons.lang3
Class CharSetUtils
java.lang.Object
org.apache.commons.lang3.CharSetUtils
Operations on
CharSet
instances.
This class handles null
input gracefully.
An exception will not be thrown for a null
input.
Each method documents its behavior in more detail.
#ThreadSafe#
- Since:
- 1.0
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
containsAny
(String str, String... set) Takes an argument in set-syntax, see evaluateSet, and identifies whether any of the characters are present in the specified string.static int
Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string.private static boolean
Determines whether or not all the Strings in an array are empty or not.static String
Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string.static String
Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string.private static String
Implements delete and keep.static String
Squeezes any repetitions of a character that is mentioned in the supplied set.
-
Constructor Details
-
CharSetUtils
Deprecated.TODO Make private in 4.0.CharSetUtils instances should NOT be constructed in standard programming. Instead, the class should be used asCharSetUtils.evaluateSet(null);
.This constructor is public to permit tools that require a JavaBean instance to operate.
-
-
Method Details
-
containsAny
Takes an argument in set-syntax, see evaluateSet, and identifies whether any of the characters are present in the specified string.CharSetUtils.containsAny(null, *) = false CharSetUtils.containsAny("", *) = false CharSetUtils.containsAny(*, null) = false CharSetUtils.containsAny(*, "") = false CharSetUtils.containsAny("hello", "k-p") = true CharSetUtils.containsAny("hello", "a-d") = false
- Parameters:
str
- String to look for characters in, may be nullset
- String[] set of characters to identify, may be null- Returns:
- whether or not the characters in the set are in the primary string
- Since:
- 3.2
- See Also:
-
count
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
- Parameters:
str
- String to count characters in, may be nullset
- String[] set of characters to count, may be null- Returns:
- the character count, zero if null string input
- See Also:
-
deepEmpty
Determines whether or not all the Strings in an array are empty or not.- Parameters:
strings
- String[] whose elements are being checked for emptiness- Returns:
- whether or not the String is empty
-
delete
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"
- Parameters:
str
- String to delete characters from, may be nullset
- String[] set of characters to delete, may be null- Returns:
- the modified String,
null
if null string input - See Also:
-
keep
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"
- Parameters:
str
- String to keep characters from, may be nullset
- String[] set of characters to keep, may be null- Returns:
- the modified String,
null
if null string input - Since:
- 2.0
- See Also:
-
modify
Implements delete and keep.- Parameters:
str
- String to modify characters withinset
- String[] set of characters to modifyexpect
- whether to evaluate on match, or non-match- Returns:
- the modified String, not null
-
squeeze
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"
- Parameters:
str
- the string to squeeze, may be nullset
- the character set to use for manipulation, may be null- Returns:
- the modified String,
null
if null string input - See Also:
-