io.github.benas.randombeans.api

Class EnhancedRandom

java.lang.Object

java.util.Random

io.github.benas.randombeans.api.EnhancedRandom

All Implemented Interfaces:

java.io.Serializable

public abstract class EnhancedRandom
extends java.util.Random

Abstract class for random object generator. Static methods in this class use default parameters and do not take into account configuration parameters set with EnhancedRandomBuilder.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnhancedRandom()

Method Summary

Modifier and Type	Method and Description
abstract <T> T	nextObject(java.lang.Class<T> type, java.lang.String... excludedFields) Generate a random instance of the given type.
abstract <T> java.util.stream.Stream<T>	objects(java.lang.Class<T> type, int amount, java.lang.String... excludedFields) Generate a stream of random instances of the given type.
static <T> T	random(java.lang.Class<T> type, java.lang.String... excludedFields) Deprecated. will be removed in v4. Use nextObject(java.lang.Class, java.lang.String...) instead
static <T> java.util.Collection<T>	randomCollectionOf(int amount, java.lang.Class<T> type, java.lang.String... excludedFields) Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead
static <T> java.util.List<T>	randomListOf(int amount, java.lang.Class<T> type, java.lang.String... excludedFields) Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead
static <T> java.util.Set<T>	randomSetOf(int amount, java.lang.Class<T> type, java.lang.String... excludedFields) Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead
static <T> java.util.stream.Stream<T>	randomStreamOf(int amount, java.lang.Class<T> type, java.lang.String... excludedFields) Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead

Methods inherited from class java.util.Random

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, next, nextBoolean, nextBytes, nextDouble, nextFloat, nextGaussian, nextInt, nextInt, nextLong, setSeed

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancedRandom

public EnhancedRandom()

Method Detail

random

@Deprecated
public static <T> T random(java.lang.Class<T> type,
                                       java.lang.String... excludedFields)

Deprecated. will be removed in v4. Use nextObject(java.lang.Class, java.lang.String...) instead

Generate a random instance of the given type. This method uses default parameters and does not take into account configuration parameters set with EnhancedRandomBuilder.

Type Parameters:

T - the target type

Parameters:

type - the target class type

excludedFields - the name of fields to exclude

Returns:

a random instance of the given type

randomStreamOf

@Deprecated
public static <T> java.util.stream.Stream<T> randomStreamOf(int amount,
                                                                        java.lang.Class<T> type,
                                                                        java.lang.String... excludedFields)

Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead

Generate a stream of random instances of the given type. This method uses default parameters and does not take into account configuration parameters set with EnhancedRandomBuilder.

Type Parameters:

T - the actual type of the target objects

Parameters:

amount - the number of instances to generate

type - the type for which instances will be generated

excludedFields - the name of fields to exclude

Returns:

a stream of random instances of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type

randomListOf

@Deprecated
public static <T> java.util.List<T> randomListOf(int amount,
                                                             java.lang.Class<T> type,
                                                             java.lang.String... excludedFields)

Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead

Generate a List of random instances of the given type. This method uses default parameters and does not take into account configuration parameters set with EnhancedRandomBuilder.

Type Parameters:

T - the actual type of the target objects

Parameters:

amount - the number of instances to generate

type - the type for which instances will be generated

excludedFields - the name of fields to exclude

Returns:

a list of random instances of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type

randomSetOf

@Deprecated
public static <T> java.util.Set<T> randomSetOf(int amount,
                                                           java.lang.Class<T> type,
                                                           java.lang.String... excludedFields)

Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead

Generate a Set of random instances of the given type. This method uses default parameters and does not take into account configuration parameters set with EnhancedRandomBuilder.

Type Parameters:

T - the actual type of the target objects

Parameters:

amount - the number of instances to generate

type - the type for which instances will be generated

excludedFields - the name of fields to exclude

Returns:

a set of random instances of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type

randomCollectionOf

@Deprecated
public static <T> java.util.Collection<T> randomCollectionOf(int amount,
                                                                         java.lang.Class<T> type,
                                                                         java.lang.String... excludedFields)

Deprecated. will be removed in v4. Use objects(java.lang.Class, int, java.lang.String...) instead

Generate a Collection of random instances of the given type. This method uses default parameters and does not take into account configuration parameters set with EnhancedRandomBuilder.

Type Parameters:

T - the actual type of the target objects

Parameters:

amount - the number of instances to generate

type - the type for which instances will be generated

excludedFields - the name of fields to exclude

Returns:

a collection of random instances of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type

nextObject

public abstract <T> T nextObject(java.lang.Class<T> type,
                                 java.lang.String... excludedFields)

Generate a random instance of the given type.

Type Parameters:

T - the actual type of the target object

Parameters:

type - the type for which an instance will be generated

excludedFields - the name of fields to exclude

Returns:

a random instance of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type

objects

public abstract <T> java.util.stream.Stream<T> objects(java.lang.Class<T> type,
                                                       int amount,
                                                       java.lang.String... excludedFields)

Generate a stream of random instances of the given type.

Type Parameters:

T - the actual type of the target objects

Parameters:

type - the type for which instances will be generated

amount - the number of instances to generate

excludedFields - the name of fields to exclude

Returns:

a stream of random instances of the given type

Throws:

ObjectGenerationException - when unable to populate an instance of the given type