Skip to content

Commit 8d36cab

Browse files
garydgregorygarydgregory
committed
Add org.apache.commons.lang3.StringUtils.indexOfAny(CharSequence, int,
char...)
1 parent 3e99482 commit 8d36cab

File tree

3 files changed

+68
-3
lines changed

3 files changed

+68
-3
lines changed

‎src/changes/changes.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The <action> type attribute can be add,update,fix,remove.
6464
<action type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.SystemUtils.IS_OS_NETWARE.</action>
6565
<action type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.reflect.MethodUtils.getAccessibleMethod(Class, Method).</action>
6666
<action type="add" dev="ggregory" due-to="Gary Gregory">Add documentation to site for CVE-2025-48924 ClassUtils.getClass(...) can throw a StackOverflowError on very long inputs.</action>
67+
<action type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.StringUtils.indexOfAny(CharSequence, int, char...).</action>
6768
<!-- UPDATE -->
6869
<action type="update" dev="ggregory" due-to="Gary Gregory">[test] Bump org.apache.commons:commons-text from 1.13.1 to 1.14.0.</action>
6970
</release>

‎src/main/java/org/apache/commons/lang3/StringUtils.java‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2705,14 +2705,44 @@ public static int indexOf(final CharSequence seq, final int searchChar, final in
27052705
* @since 3.0 Changed signature from indexOfAny(String, char[]) to indexOfAny(CharSequence, char...)
27062706
*/
27072707
public static int indexOfAny(final CharSequence cs, final char... searchChars) {
2708+
return indexOfAny(cs, 0, searchChars);
2709+
}
2710+
2711+
/**
2712+
* Search a CharSequence to find the first index of any character in the given set of characters.
2713+
*
2714+
* <p>
2715+
* A {@code null} String will return {@code -1}. A {@code null} or zero length search array will return {@code -1}.
2716+
* </p>
2717+
* <p>
2718+
* The following is the same as {@code indexOfAny(cs, 0, searchChars)}.
2719+
* </p>
2720+
* <pre>
2721+
* StringUtils.indexOfAny(null, 0, *) = -1
2722+
* StringUtils.indexOfAny("", 0, *) = -1
2723+
* StringUtils.indexOfAny(*, 0, null) = -1
2724+
* StringUtils.indexOfAny(*, 0, []) = -1
2725+
* StringUtils.indexOfAny("zzabyycdxx", 0, ['z', 'a']) = 0
2726+
* StringUtils.indexOfAny("zzabyycdxx", 0, ['b', 'y']) = 3
2727+
* StringUtils.indexOfAny("aba", 0, ['z']) = -1
2728+
* </pre>
2729+
*
2730+
* @param cs the CharSequence to check, may be null.
2731+
* @param csStart Start searching the input {@code cs} at this index.
2732+
* @param searchChars the chars to search for, may be null.
2733+
* @return the index of any of the chars, -1 if no match or null input.
2734+
* @since 2.0
2735+
* @since 3.0 Changed signature from indexOfAny(String, char[]) to indexOfAny(CharSequence, char...)
2736+
*/
2737+
public static int indexOfAny(final CharSequence cs, final int csStart, final char... searchChars) {
27082738
if (isEmpty(cs) || ArrayUtils.isEmpty(searchChars)) {
27092739
return INDEX_NOT_FOUND;
27102740
}
27112741
final int csLen = cs.length();
27122742
final int csLast = csLen - 1;
27132743
final int searchLen = searchChars.length;
27142744
final int searchLast = searchLen - 1;
2715-
for (int i = 0; i < csLen; i++) {
2745+
for (int i = csStart; i < csLen; i++) {
27162746
final char ch = cs.charAt(i);
27172747
for (int j = 0; j < searchLen; j++) {
27182748
if (searchChars[j] == ch) {

‎src/test/java/org/apache/commons/lang3/StringUtilsEqualsIndexOfTest.java‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,11 +388,9 @@ void testIndexOfAny_StringCharArray() {
388388
assertEquals(-1, StringUtils.indexOfAny(null, (char[]) null));
389389
assertEquals(-1, StringUtils.indexOfAny(null, new char[0]));
390390
assertEquals(-1, StringUtils.indexOfAny(null, 'a', 'b'));
391-
392391
assertEquals(-1, StringUtils.indexOfAny("", (char[]) null));
393392
assertEquals(-1, StringUtils.indexOfAny("", new char[0]));
394393
assertEquals(-1, StringUtils.indexOfAny("", 'a', 'b'));
395-
396394
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", (char[]) null));
397395
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", new char[0]));
398396
assertEquals(0, StringUtils.indexOfAny("zzabyycdxx", 'z', 'a'));
@@ -404,6 +402,42 @@ void testIndexOfAny_StringCharArray() {
404402
assertEquals(0, StringUtils.indexOfAny("cbda", 'a', 'b', 'c', 'd'));
405403
}
406404

405+
@Test
406+
void testIndexOfAny_StringIntCharArray() {
407+
// default cases
408+
assertEquals(-1, StringUtils.indexOfAny(null, 0, (char[]) null));
409+
assertEquals(-1, StringUtils.indexOfAny(null, 0, new char[0]));
410+
assertEquals(-1, StringUtils.indexOfAny(null, 0, 'a', 'b'));
411+
assertEquals(-1, StringUtils.indexOfAny("", 0, (char[]) null));
412+
assertEquals(-1, StringUtils.indexOfAny("", 0, new char[0]));
413+
assertEquals(-1, StringUtils.indexOfAny("", 0, 'a', 'b'));
414+
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", 0, (char[]) null));
415+
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", 0, new char[0]));
416+
assertEquals(0, StringUtils.indexOfAny("zzabyycdxx", 0, 'z', 'a'));
417+
assertEquals(3, StringUtils.indexOfAny("zzabyycdxx", 0, 'b', 'y'));
418+
assertEquals(-1, StringUtils.indexOfAny("ab", 0, 'z'));
419+
// if more than one search char is present, the order of the search chars matters:
420+
assertEquals(0, StringUtils.indexOfAny("abcd", 0, 'a', 'b', 'c', 'd'));
421+
assertEquals(0, StringUtils.indexOfAny("bcda", 0, 'a', 'b', 'c', 'd'));
422+
assertEquals(0, StringUtils.indexOfAny("cbda", 0, 'a', 'b', 'c', 'd'));
423+
// Actually use the index
424+
assertEquals(-1, StringUtils.indexOfAny(null, 1, (char[]) null));
425+
assertEquals(-1, StringUtils.indexOfAny(null, 1, new char[0]));
426+
assertEquals(-1, StringUtils.indexOfAny(null, 1, 'a', 'b'));
427+
assertEquals(-1, StringUtils.indexOfAny("", 1, (char[]) null));
428+
assertEquals(-1, StringUtils.indexOfAny("", 1, new char[0]));
429+
assertEquals(-1, StringUtils.indexOfAny("", 1, 'a', 'b'));
430+
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", 1, (char[]) null));
431+
assertEquals(-1, StringUtils.indexOfAny("zzabyycdxx", 1, new char[0]));
432+
assertEquals(1, StringUtils.indexOfAny("zzabyycdxx", 1, 'z', 'a'));
433+
assertEquals(3, StringUtils.indexOfAny("zzabyycdxx", 1, 'b', 'y'));
434+
assertEquals(-1, StringUtils.indexOfAny("ab", 1, 'z'));
435+
// if more than one search char is present, the order of the search chars matters:
436+
assertEquals(1, StringUtils.indexOfAny("abcd", 1, 'a', 'b', 'c', 'd'));
437+
assertEquals(1, StringUtils.indexOfAny("bcda", 1, 'a', 'b', 'c', 'd'));
438+
assertEquals(1, StringUtils.indexOfAny("cbda", 1, 'a', 'b', 'c', 'd'));
439+
}
440+
407441
/**
408442
* See https://www.oracle.com/technical-resources/articles/javase/supplementary.html
409443
*/

0 commit comments

Comments
 (0)