The default string length produced by this builder: .

The default maximum code point allowed: Character#MAX_CODE_POINT ().

The default minimum code point allowed: .

Implements org.apache.commons.text.Builder.build.

Builds a new RandomStringGenerator.

Returns:RandomStringGenerator

A new RandomStringGenerator

Annotations

@Deprecated

@Override

Limits the characters in the generated string to those that match at least one of the predicates supplied.

Passing null or an empty array to this method will revert to the default behavior of allowing any character. Multiple calls to this method will replace the previously stored predicates.

Parameters

predicates:CharacterPredicate[]

the predicates, may be null or empty.

Returns:RandomStringGenerator.Builder

this instance.

Implements java.util.function.Supplier.get.

Builds a new RandomStringGenerator.

Returns:RandomStringGenerator

A new RandomStringGenerator.

Annotations

@Override

Since

1.12.0

Limits the characters in the generated string to those who match at supplied list of Character.

Passing null or an empty array to this method will revert to the default behavior of allowing any character. Multiple calls to this method will replace the previously stored Character.

Parameters

chars:char[]

set of predefined Characters for random string generation the Character can be, may be null or empty.

Returns:RandomStringGenerator.Builder

this instance.

Since

1.2

Sets whether calls accumulates the source of provided characters. The default is false.

RandomStringGenerator gen = RandomStringGenerator.builder()
        .setAccumulate(true)
        .withinRange(new char[][] { { 'a', 'z' }, { 'A', 'Z' }, { '0', '9' } })
        .selectFrom('!', '"', '#', '$', '&', '\'', '(', ')', ',', '.', ':', ';', '?', '@', '[',
                    '\\', ']', '^', '_', '`', '{', '|', '}', '~') // punctuation
        // additional builder calls as needed
        .build();

Parameters

accumulate:boolean

whether calls accumulates the source of provided characters. The default is false.

Returns:RandomStringGenerator.Builder

this instance.

Since

1.14.0

Overrides the default source of randomness. It is highly recommended that a random number generator library like Apache Commons RNG be used to provide the random number generation.

TextRandomProvider is a functional interface and need not be explicitly implemented:

UniformRandomProvider rng = RandomSource.create(...);
    RandomStringGenerator gen = RandomStringGenerator.builder()
        .usingRandom(rng::nextInt)
        // additional builder calls as needed
        .build();

Passing null to this method will revert to the default source of randomness.

Parameters

random:IntUnaryOperator

the source of randomness, may be null.

Returns:RandomStringGenerator.Builder

this instance.

Since

1.14.0

Overrides the default source of randomness. It is highly recommended that a random number generator library like Apache Commons RNG be used to provide the random number generation.

TextRandomProvider is a functional interface and need not be explicitly implemented:

UniformRandomProvider rng = RandomSource.create(...);
    RandomStringGenerator gen = RandomStringGenerator.builder()
        .usingRandom(rng::nextInt)
        // additional builder calls as needed
        .build();

Passing null to this method will revert to the default source of randomness.

Parameters

random:TextRandomProvider

the source of randomness, may be null.

Returns:RandomStringGenerator.Builder

this instance.

Sets the array of minimum and maximum char allowed in the generated string. For example:

char[][] pairs = { { '0', '9' } };
char[][] pairs = { { 'a', 'z' } };
char[][] pairs = { { 'a', 'z' }, { '0', '9' } };

Parameters

pairs:char[][]

array of characters array, expected is to pass min, max pairs through this arg.

Returns:RandomStringGenerator.Builder

this instance.

Sets the minimum and maximum code points allowed in the generated string.

Parameters

minimumCodePoint:int

the smallest code point allowed (inclusive).

maximumCodePoint:int

the largest code point allowed (inclusive).

Returns:RandomStringGenerator.Builder

this instance.

Exceptions

IllegalArgumentException:

• if maximumCodePoint > Character#MAX_CODE_POINT.
• if minimumCodePoint < 0.
• if minimumCodePoint > maximumCodePoint.