[jira] [Created] (LANG-1182) javadoc correction, clarification on 2 variants of StringUtils.containsAny()

["Larry West (JIRA)" <ji...@apache.org>]

Larry West created LANG-1182:
--------------------------------

             Summary: javadoc correction, clarification on 2 variants of StringUtils.containsAny()
                 Key: LANG-1182
                 URL: https://issues.apache.org/jira/browse/LANG-1182
             Project: Commons Lang
          Issue Type: Bug
          Components: lang.*
    Affects Versions: 3.4
            Reporter: Larry West
            Priority: Minor


(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





--
This message was sent by Atlassian JIRA
(v6.3.4#6332)