io.github.benas.randombeans

Class EnhancedRandomBuilder

java.lang.Object

io.github.benas.randombeans.EnhancedRandomBuilder

public class EnhancedRandomBuilder
extends java.lang.Object

Builder to create EnhancedRandom instances.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Constructor Summary

Constructors

Constructor and Description
EnhancedRandomBuilder() Create a new EnhancedRandomBuilder.

Method Summary

Modifier and Type	Method and Description
static EnhancedRandom	aNewEnhancedRandom() Create a new EnhancedRandom instance with default parameters.
static EnhancedRandomBuilder	aNewEnhancedRandomBuilder() Create a new EnhancedRandomBuilder.
EnhancedRandom	build() Build a EnhancedRandom instance.
EnhancedRandomBuilder	charset(java.nio.charset.Charset charset) Set the charset to use for character based fields.
EnhancedRandomBuilder	collectionSizeRange(int minCollectionSize, int maxCollectionSize) Set the collection size range.
EnhancedRandomBuilder	dateRange(java.time.LocalDate min, java.time.LocalDate max) Set the date range.
EnhancedRandomBuilder	exclude(java.lang.Class<?>... types) Exclude types from being populated.
<T,F> EnhancedRandomBuilder	exclude(FieldDefinition<T,F> fieldDefinition) Exclude a field from being populated.
EnhancedRandomBuilder	maxCollectionSize(int maxCollectionSize) Deprecated. use collectionSizeRange(int, int) instead
EnhancedRandomBuilder	maxObjectPoolSize(int maxObjectPoolSize) Deprecated. use objectPoolSize(int) instead
EnhancedRandomBuilder	maxRandomizationDepth(int maxRandomizationDepth) Deprecated. use randomizationDepth(int) instead
EnhancedRandomBuilder	maxStringLength(int maxStringLength) Deprecated. use stringLengthRange(int, int) instead
EnhancedRandomBuilder	minCollectionSize(int minCollectionSize) Deprecated. use collectionSizeRange(int, int) instead
EnhancedRandomBuilder	minStringLength(int minStringLength) Deprecated. use stringLengthRange(int, int) instead
EnhancedRandomBuilder	objectPoolSize(int objectPoolSize) Set the number of different objects to generate for a type.
EnhancedRandomBuilder	overrideDefaultInitialization(boolean overrideDefaultInitialization) Should default initialization of field values be overridden? E.g.
EnhancedRandomBuilder	randomizationDepth(int randomizationDepth) Set the randomization depth for objects tree.
<T,R> EnhancedRandomBuilder	randomize(java.lang.Class<T> type, Randomizer<R> randomizer) Register a custom randomizer for a given type.
<T,R> EnhancedRandomBuilder	randomize(java.lang.Class<T> type, java.util.function.Supplier<R> supplier) Register a supplier as randomizer for a given type.
<T,F,R> EnhancedRandomBuilder	randomize(FieldDefinition<T,F> fieldDefinition, Randomizer<R> randomizer) Register a custom randomizer for a given field.
<T,F,R> EnhancedRandomBuilder	randomize(FieldDefinition<T,F> fieldDefinition, java.util.function.Supplier<R> supplier) Register a supplier as 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.
EnhancedRandomBuilder	stringLengthRange(int minStringLength, int maxStringLength) Set the string length range.
EnhancedRandomBuilder	timeRange(java.time.LocalTime min, java.time.LocalTime max) Set the time range.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancedRandomBuilder

public EnhancedRandomBuilder()

Create a new EnhancedRandomBuilder.

Method Detail

aNewEnhancedRandomBuilder

public static EnhancedRandomBuilder aNewEnhancedRandomBuilder()

Create a new EnhancedRandomBuilder.

Returns:

a new EnhancedRandomBuilder

aNewEnhancedRandom

public static EnhancedRandom aNewEnhancedRandom()

Create a new EnhancedRandom instance with default parameters.

Returns:

a new EnhancedRandom

randomize

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

Register a custom randomizer for a given field. The field type MUST be provided in the field definition

Type Parameters:

T - The target class type

F - The target field type

R - The type generated by the randomizer

Parameters:

fieldDefinition - definition of the field to randomize

randomizer - the custom Randomizer to use

Returns:

a pre configured EnhancedRandomBuilder instance

randomize

public <T,F,R> EnhancedRandomBuilder randomize(FieldDefinition<T,F> fieldDefinition,
                                               java.util.function.Supplier<R> supplier)

Register a supplier as randomizer for a given field. The field type MUST be provided in the field definition

Type Parameters:

T - The target class type

F - The target field type

R - The type generated by the supplier

Parameters:

fieldDefinition - definition of the field to randomize

supplier - the custom Supplier to use

Returns:

a pre configured EnhancedRandomBuilder instance

randomize

public <T,R> EnhancedRandomBuilder randomize(java.lang.Class<T> type,
                                             Randomizer<R> randomizer)

Register a custom randomizer for a given type.

Type Parameters:

T - The field type

R - The type generated by the randomizer

Parameters:

type - class of the type to randomize

randomizer - the custom Randomizer to use

Returns:

a pre configured EnhancedRandomBuilder instance

randomize

public <T,R> EnhancedRandomBuilder randomize(java.lang.Class<T> type,
                                             java.util.function.Supplier<R> supplier)

Register a supplier as randomizer for a given type.

Type Parameters:

T - The field type

R - The type generated by the supplier

Parameters:

type - class of the type to randomize

supplier - the custom Supplier to use

Returns:

a pre configured EnhancedRandomBuilder instance

exclude

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

Exclude a field from being populated.

Type Parameters:

T - The target class type

F - The target field type

Parameters:

fieldDefinition - definition of the field to exclude

Returns:

a pre configured EnhancedRandomBuilder instance

exclude

public EnhancedRandomBuilder exclude(java.lang.Class<?>... types)

Exclude types from being populated.

Parameters:

types - the types 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

minCollectionSize

@Deprecated
public EnhancedRandomBuilder minCollectionSize(int minCollectionSize)

Deprecated. use collectionSizeRange(int, int) instead

Set the minimum collection size.

Parameters:

minCollectionSize - the minimum collection size

Returns:

a pre configured EnhancedRandomBuilder instance

maxCollectionSize

@Deprecated
public EnhancedRandomBuilder maxCollectionSize(int maxCollectionSize)

Deprecated. use collectionSizeRange(int, int) instead

Set the maximum collection size.

Parameters:

maxCollectionSize - the maximum collection size

Returns:

a pre configured EnhancedRandomBuilder instance

collectionSizeRange

public EnhancedRandomBuilder collectionSizeRange(int minCollectionSize,
                                                 int maxCollectionSize)

Set the collection size range.

Parameters:

minCollectionSize - the minimum collection size

maxCollectionSize - the maximum collection size

Returns:

a pre configured EnhancedRandomBuilder instance

stringLengthRange

public EnhancedRandomBuilder stringLengthRange(int minStringLength,
                                               int maxStringLength)

Set the string length range.

Parameters:

minStringLength - the minimum string length

maxStringLength - the maximum string length

Returns:

a pre configured EnhancedRandomBuilder instance

maxStringLength

@Deprecated
public EnhancedRandomBuilder maxStringLength(int maxStringLength)

Deprecated. use stringLengthRange(int, int) instead

Set the maximum string length.

Parameters:

maxStringLength - the maximum string length

Returns:

a pre configured EnhancedRandomBuilder instance

minStringLength

@Deprecated
public EnhancedRandomBuilder minStringLength(int minStringLength)

Deprecated. use stringLengthRange(int, int) instead

Set the minimum string length.

Parameters:

minStringLength - the minimum string length

Returns:

a pre configured EnhancedRandomBuilder instance

maxObjectPoolSize

@Deprecated
public EnhancedRandomBuilder maxObjectPoolSize(int maxObjectPoolSize)

Deprecated. use objectPoolSize(int) instead

Set the maximum number of different objects to generate for a type.

Parameters:

maxObjectPoolSize - the maximum number of objects

Returns:

a pre configured EnhancedRandomBuilder instance

objectPoolSize

public EnhancedRandomBuilder objectPoolSize(int objectPoolSize)

Set the number of different objects to generate for a type.

Parameters:

objectPoolSize - the number of objects to generate in the pool

Returns:

a pre configured EnhancedRandomBuilder instance

maxRandomizationDepth

@Deprecated
public EnhancedRandomBuilder maxRandomizationDepth(int maxRandomizationDepth)

Deprecated. use randomizationDepth(int) instead

Set the maximum randomization depth for objects tree.

Parameters:

maxRandomizationDepth - the maximum randomization depth

Returns:

a pre configured EnhancedRandomBuilder instance

randomizationDepth

public EnhancedRandomBuilder randomizationDepth(int randomizationDepth)

Set the randomization depth for objects tree.

Parameters:

randomizationDepth - the maximum randomization depth

Returns:

a pre configured EnhancedRandomBuilder instance

charset

public EnhancedRandomBuilder charset(java.nio.charset.Charset charset)

Set the charset to use for character based fields.

Parameters:

charset - the charset to use

Returns:

a pre configured EnhancedRandomBuilder instance

dateRange

public EnhancedRandomBuilder dateRange(java.time.LocalDate min,
                                       java.time.LocalDate max)

Set the date range.

Parameters:

min - date

max - date

Returns:

a pre configured EnhancedRandomBuilder instance

timeRange

public EnhancedRandomBuilder timeRange(java.time.LocalTime min,
                                       java.time.LocalTime max)

Set the time range.

Parameters:

min - time

max - time

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

overrideDefaultInitialization

public EnhancedRandomBuilder overrideDefaultInitialization(boolean overrideDefaultInitialization)

Should default initialization of field values be overridden? E.g. should the values of the strings and integers fields below be kept untouched or should they be randomized.

 
 public class Bean {
     Set<String> strings = new HashSet<>();
     List<Integer> integers;
 
     public Bean() {
         integers = Arrays.asList(1, 2, 3);
     }
 }
 

Deactivated by default.

Parameters:

overrideDefaultInitialization - whether to override default initialization of field values or not

Returns:

a pre configured EnhancedRandomBuilder instance

build

public EnhancedRandom build()

Build a EnhancedRandom instance.

Returns:

a configured EnhancedRandom instance