Interface TextRandomProvider extends IntUnaryOperator

Author: garydgregory

src/changes/changes.xml

@@ -49,6 +49,7 @@ The <action> type attribute can be add,update,fix,remove.
     <!-- FIX -->
     <!-- ADD -->
     <action type="add" dev="ggregory" due-to="Gary Gregory">Interface StringLookup now extends UnaryOperator&lt;String&gt;.</action>
+    <action type="add" dev="ggregory" due-to="Gary Gregory">Interface TextRandomProvider extends IntUnaryOperator.</action>
     <!-- UPDATE -->
     <action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump org.apache.commons:commons-parent from 81 to 84 #668.</action>
     <action type="update" dev="ggregory" due-to="Gary Gregory">Bump commons-io:commons-io from 2.18.0 to 2.19.0.</action>

src/main/java/org/apache/commons/text/RandomStringGenerator.java

@@ -459,7 +459,7 @@ public String generate(final int minLengthInclusive, final int maxLengthInclusiv
      */
     private int generateRandomNumber(final int minInclusive, final int maxInclusive) {
         if (random != null) {
-            return random.nextInt(maxInclusive - minInclusive + 1) + minInclusive;
+            return random.applyAsInt(maxInclusive - minInclusive + 1) + minInclusive;
         }
         return ThreadLocalRandom.current().nextInt(minInclusive, maxInclusive + 1);
     }
@@ -474,7 +474,7 @@ private int generateRandomNumber(final int minInclusive, final int maxInclusive)
     private int generateRandomNumber(final List<Character> characterList) {
         final int listSize = characterList.size();
         if (random != null) {
-            return String.valueOf(characterList.get(random.nextInt(listSize))).codePointAt(0);
+            return String.valueOf(characterList.get(random.applyAsInt(listSize))).codePointAt(0);
         }
         return String.valueOf(characterList.get(ThreadLocalRandom.current().nextInt(0, listSize))).codePointAt(0);
     }

src/main/java/org/apache/commons/text/TextRandomProvider.java

@@ -16,34 +16,52 @@
  */
 package org.apache.commons.text;
 
+import java.util.function.IntUnaryOperator;
+
 /**
  * TextRandomProvider implementations are used by {@link RandomStringGenerator}
  * as a source of randomness.  It is highly recommended that the
  * <a href="https://commons.apache.org/proper/commons-rng/">Apache Commons RNG</a>
  * library be used to provide the random number generation.
  *
  * <p>
- * When using Java 8 or later, TextRandomProvider is a functional interface and
- * need not be explicitly implemented.  For example:
+ * {@code TextRandomProvider} is a functional interface and need not be explicitly implemented.
+ * </p>
+ * <p>
+ * For example:
  * </p>
  * <pre>
  * {@code
  * UniformRandomProvider rng = RandomSource.create(...);
  * RandomStringGenerator gen = RandomStringGenerator.builder()
- *     .usingRandom(rng::nextInt)
+ *     .usingRandom(rng::applyAsInt)
  *     // additional builder calls as needed
  *     .build();
  * }
  * </pre>
  * @since 1.1
  */
-public interface TextRandomProvider {
+public interface TextRandomProvider extends IntUnaryOperator {
+
+    /**
+     * Generates an int value between 0 (inclusive) and the specified value (exclusive).
+     *
+     * @param max Bound on the random number to be returned. Must be positive.
+     * @return a random int value between 0 (inclusive) and max (exclusive).
+     * @since 1.14.0
+     */
+    @Override
+    default int applyAsInt(final int max) {
+        return nextInt(max);
+    }
 
     /**
-     * Generates an int value between 0 (inclusive) and the specified value
-     * (exclusive).
-     * @param max  Bound on the random number to be returned. Must be positive.
-     * @return a random int value between 0 (inclusive) and n (exclusive).
+     * Generates an int value between 0 (inclusive) and the specified value (exclusive).
+     *
+     * @param max Bound on the random number to be returned. Must be positive.
+     * @return a random int value between 0 (inclusive) and max (exclusive).
+     * @deprecated Use {@link #applyAsInt(int)}.
      */
+    @Deprecated
     int nextInt(int max);
 }