Package org.apache.commons.rng.simple.internal

Class ProviderBuilder

java.lang.Object

org.apache.commons.rng.simple.internal.ProviderBuilder

public final class ProviderBuilder
extends Object

RNG builder.

It uses reflection to find the factory method of the RNG implementation, and performs seed type conversions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProviderBuilder.RandomSourceInternal	Identifiers of the generators.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	INTERNAL_ERROR_MSG	Error message.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProviderBuilder()	Class only contains static method.

Method Summary

Modifier and Type	Method	Description
static RestorableUniformRandomProvider	create(ProviderBuilder.RandomSourceInternal source)	Creates a RNG instance.
static RestorableUniformRandomProvider	create(ProviderBuilder.RandomSourceInternal source, Object seed, Object[] args)	Creates a RNG instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INTERNAL_ERROR_MSG

private static final String INTERNAL_ERROR_MSG

Error message.

See Also:

• Constant Field Values

Constructor Details

ProviderBuilder

private ProviderBuilder()

Class only contains static method.

Method Details

create

public static RestorableUniformRandomProvider create(ProviderBuilder.RandomSourceInternal source)

Creates a RNG instance.

Parameters:

source - RNG specification.

Returns:

a new RNG instance.

Throws:

IllegalArgumentException - if argument data to initialize the generator implemented by the given source is missing.

Since:

1.3

create

public static RestorableUniformRandomProvider create(ProviderBuilder.RandomSourceInternal source,
 Object seed,
 Object[] args)

Creates a RNG instance.

Parameters:

source - RNG specification.

seed - Seed value. It can be null (in which case a random value will be used).

args - Additional arguments to the implementation's constructor.

Returns:

a new RNG instance.

Throws:

UnsupportedOperationException - if the seed type is invalid.

IllegalArgumentException - if argument data to initialize the generator implemented by the given source is invalid.