[LANG-1182] Clarify JavaDoc of StringUtils.containsAny()

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.4
• Fix Version/s: 3.5
• Component/s: lang.*
• Assignee: Benedikt Ritter
• Reporter: Larry West
• Created: 31/Oct/15 00:13
• Updated: 19/Oct/16 07:00
• Resolved: 16/Nov/15 19:19

Description

(1) The javadoc for StringUtils.containsAny(CharSequence cs, CharSequence... searchCharSequences) confusingly says

• StringUtils.containsAny("abcd", "ab", "cd") = false

You can verify this actually returns true by running this:

if (!StringUtils.containsAny("abcd", "ab", "cd"))
throw new AssertionError("Third sample from StringUtils 3.4 javadoc");

(2) The javadoc for containsAny(final CharSequence cs, final CharSequence searchChars) is inadequate, and could easily mislead naive readers to believe this containsAny() looks for a matching sequence (substring) rather than characters in a set:

• StringUtils.containsAny("zzabyycdxx", "za") = true
• StringUtils.containsAny("zzabyycdxx", "by") = true

In other words, both examples would be equally true for StringUtils.contains(). I suggest adding clarifying examples, like:

• StringUtils.containsAny("zzabyycdxx", "\tx") = true
• StringUtils.containsAny("zzabyycdxx", "$.#yF") = true