CharSetUtils¶

public class org.apache.commons.lang3.CharSetUtils[source]¶

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#

See also:: CharSet
Since:: 1.0

Constructors¶

CharSetUtils()

Deprecated. CharSetUtils instances should NOT be constructed in standard programming.

@Deprecated public CharSetUtils()[source]¶

Deprecated: TODO Make private in 4.0.

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.

Methods¶

`containsAny(String, String[])`	Takes an argument in set-syntax, see evaluateSet, and identifies whether any of the characters are present in the specified string.
`count(String, String[])`	Takes an argument in set-syntax, see evaluateSet, and returns the number of characters present in the specified string.
`delete(String, String[])`	Takes an argument in set-syntax, see evaluateSet, and deletes any of characters present in the specified string.
`keep(String, String[])`	Takes an argument in set-syntax, see evaluateSet, and keeps any of characters present in the specified string.
`squeeze(String, String[])`	Squeezes any repetitions of a character that is mentioned in the supplied set.

public static boolean containsAny(String str, String... set)[source]¶

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

See also:

CharSet#getInstance(String...)for set-syntax.

Parameters:

str – String to look for characters in, may be null
set – 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

public static int count(String str, String... set)[source]¶

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

See also:

CharSet#getInstance(String...)for set-syntax.

Parameters:

str – String to count characters in, may be null
set – String[] set of characters to count, may be null

Returns:

The character count, zero if null string input

public static String delete(String str, String... set)[source]¶

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"

See also:

CharSet#getInstance(String...)for set-syntax.

Parameters:

str – String to delete characters from, may be null
set – String[] set of characters to delete, may be null

Returns:

The modified String, null if null string input

public static String keep(String str, String... set)[source]¶

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"

See also:

CharSet#getInstance(String...)for set-syntax.

Parameters:

str – String to keep characters from, may be null
set – String[] set of characters to keep, may be null

Returns:

The modified String, null if null string input

Since:

2.0

public static String squeeze(String str, String... set)[source]¶

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"

See also:

CharSet#getInstance(String...)for set-syntax.

Parameters:

str – The string to squeeze, may be null
set – The character set to use for manipulation, may be null

Returns:

The modified String, null if null string input