This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 5d3c26919 Javadoc
5d3c26919 is described below
commit 5d3c269193614161daae75946b3f632c65a6d8a8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Aug 22 15:50:24 2024 -0400
Javadoc
---
.../org/apache/commons/lang3/RandomStringUtils.java | 18 +++++++++++++-----
.../java/org/apache/commons/lang3/RandomUtils.java | 18 +++++++++++++-----
2 files changed, 26 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
index ec10f3581..ca2f4a107 100644
--- a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
@@ -25,15 +25,17 @@ import java.util.function.Supplier;
/**
* Generates random {@link String}s.
* <p>
- * Use {@link #secure()} to get the singleton instance based on {@link
SecureRandom#SecureRandom()} which uses a secure random number generator (RNG)
- * implementing the default random number algorithm.
+ * Use {@link #secure()} to get the singleton instance based on {@link
SecureRandom#SecureRandom()} which uses a secure random number generator
implementing the
+ * default random number algorithm.
* </p>
* <p>
- * Use {@link #secureStrong()} to get the singleton instance based on {@link
SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified
in
- * the {@code securerandom.strongAlgorithms} {@link Security} property.
+ * Use {@link #secureStrong()} to get the singleton instance based on {@link
SecureRandom#getInstanceStrong()} which uses an instance that was selected by
using
+ * the algorithms/providers specified in the {@code
securerandom.strongAlgorithms} {@link Security} property.
* </p>
* <p>
- * Use {@link #insecure()} to get the singleton instance based on {@link
ThreadLocalRandom#current()}; <b>which is not cryptographically secure</b>.
+ * Use {@link #insecure()} to get the singleton instance based on {@link
ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In
addition,
+ * instances do not use a cryptographically random seed unless the {@linkplain
System#getProperty system property} {@code java.util.secureRandomSeed} is set to
+ * {@code true}.
* </p>
* <p>
* Starting in version 3.17.0, the method {@link #secure()} uses {@link
SecureRandom#SecureRandom()} instead of {@link
SecureRandom#getInstanceStrong()}, and
@@ -67,6 +69,12 @@ import java.util.function.Supplier;
* #ThreadSafe#
* </p>
*
+ * @see #secure()
+ * @see #secureStrong()
+ * @see #insecure()
+ * @see SecureRandom#SecureRandom()
+ * @see SecureRandom#getInstanceStrong()
+ * @see ThreadLocalRandom#current()
* @see RandomUtils
* @since 1.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java
b/src/main/java/org/apache/commons/lang3/RandomUtils.java
index 554748362..570831a3b 100644
--- a/src/main/java/org/apache/commons/lang3/RandomUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java
@@ -28,15 +28,17 @@ import
org.apache.commons.lang3.exception.UncheckedException;
/**
* Supplements the standard {@link Random} class.
* <p>
- * Use {@link #secure()} to get the singleton instance based on {@link
SecureRandom#SecureRandom()} which uses a secure random number generator (RNG)
- * implementing the default random number algorithm.
+ * Use {@link #secure()} to get the singleton instance based on {@link
SecureRandom#SecureRandom()} which uses a secure random number generator
implementing the
+ * default random number algorithm.
* </p>
* <p>
- * Use {@link #secureStrong()} to get the singleton instance based on {@link
SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified
in
- * the {@code securerandom.strongAlgorithms} {@link Security} property.
+ * Use {@link #secureStrong()} to get the singleton instance based on {@link
SecureRandom#getInstanceStrong()} which uses an instance that was selected by
using
+ * the algorithms/providers specified in the {@code
securerandom.strongAlgorithms} {@link Security} property.
* </p>
* <p>
- * Use {@link #insecure()} to get the singleton instance based on {@link
ThreadLocalRandom#current()}; <b>which is not cryptographically secure</b>.
+ * Use {@link #insecure()} to get the singleton instance based on {@link
ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In
addition,
+ * instances do not use a cryptographically random seed unless the {@linkplain
System#getProperty system property} {@code java.util.secureRandomSeed} is set to
+ * {@code true}.
* </p>
* <p>
* Starting in version 3.17.0, the method {@link #secure()} uses {@link
SecureRandom#SecureRandom()} instead of {@link
SecureRandom#getInstanceStrong()}, and
@@ -57,6 +59,12 @@ import org.apache.commons.lang3.exception.UncheckedException;
* (performance and/or correctness).
* </p>
*
+ * @see #secure()
+ * @see #secureStrong()
+ * @see #insecure()
+ * @see SecureRandom#SecureRandom()
+ * @see SecureRandom#getInstanceStrong()
+ * @see ThreadLocalRandom#current()
* @see RandomStringUtils
* @since 3.3
*/
