io.github.benas.randombeans

Class EnhancedRandomBuilder

java.lang.Object

io.github.benas.randombeans.EnhancedRandomBuilder

public class EnhancedRandomBuilder
extends Object

Builder to create EnhancedRandom instances.

Author:

Mahmoud Ben Hassine ([email protected])

Method Summary

Modifier and Type	Method and Description
static EnhancedRandomBuilder	aNewEnhancedRandomBuilder() Create a new EnhancedRandomBuilder.
EnhancedRandom	build() Build a EnhancedRandom instance.
<T,F> EnhancedRandomBuilder	exclude(FieldDefinition<T,F> fieldDefinition) Exclude a field from being populated.
<T,F,R> EnhancedRandomBuilder	randomize(FieldDefinition<T,F> fieldDefinition, Randomizer<R> randomizer) Register a custom randomizer for a given field.
EnhancedRandomBuilder	registerRandomizerRegistry(RandomizerRegistry registry) Register a RandomizerRegistry.
EnhancedRandomBuilder	scanClasspathForConcreteTypes(boolean scanClasspathForConcreteTypes) Should the classpath be scanned for concrete types when a field with an interface or abstract class type is encountered? Deactivated by default.
EnhancedRandomBuilder	seed(long seed) Set the initial random seed.

Methods inherited from class java.lang.Object

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

Method Detail

aNewEnhancedRandomBuilder

public static EnhancedRandomBuilder aNewEnhancedRandomBuilder()

Create a new EnhancedRandomBuilder.

Returns:

a new EnhancedRandomBuilder

randomize

public <T,F,R> EnhancedRandomBuilder randomize(FieldDefinition<T,F> fieldDefinition,
                                               Randomizer<R> randomizer)

Register a custom randomizer for a given field.

Parameters:

fieldDefinition - definition of the field to randomize

randomizer - the custom Randomizer to use

Returns:

a pre configured EnhancedRandomBuilder instance

exclude

public <T,F> EnhancedRandomBuilder exclude(FieldDefinition<T,F> fieldDefinition)

Exclude a field from being populated.

Parameters:

fieldDefinition - definition of the field to exclude

Returns:

a pre configured EnhancedRandomBuilder instance

seed

public EnhancedRandomBuilder seed(long seed)

Set the initial random seed.

Parameters:

seed - the initial seed

Returns:

a pre configured EnhancedRandomBuilder instance

registerRandomizerRegistry

public EnhancedRandomBuilder registerRandomizerRegistry(RandomizerRegistry registry)

Register a RandomizerRegistry.

Parameters:

registry - the RandomizerRegistry to register

Returns:

a pre configured EnhancedRandomBuilder instance

scanClasspathForConcreteTypes

public EnhancedRandomBuilder scanClasspathForConcreteTypes(boolean scanClasspathForConcreteTypes)

Should the classpath be scanned for concrete types when a field with an interface or abstract class type is encountered? Deactivated by default.

Parameters:

scanClasspathForConcreteTypes - whether to scan the classpath or not

Returns:

a pre configured EnhancedRandomBuilder instance

build

public EnhancedRandom build()

Build a EnhancedRandom instance.

Returns:

a configured EnhancedRandom instance