org.exparity.stub.random

Class RandomBuilder

java.lang.Object

org.exparity.stub.random.RandomBuilder

public abstract class RandomBuilder
extends Object

Builder object for instantiating and populating random instances of Java types.

Author:

Stewart Bissett

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RandomBuilder.RandomRestriction Interface to be implemented by all classes which can restrict the behaviour of the random builder and how it assigns values to properties, which types, it creates, etc

Constructor Summary

Constructors

Constructor and Description
RandomBuilder()

Method Summary

Modifier and Type	Method and Description
static <T> T[]	aRandomArrayOf(Class<T> type) Build an array of randomly populated instances of the supplied type.
static <T> T[]	aRandomArrayOf(Class<T> type, int min, int max) Build an array of randomly populated instances of the supplied type if a given size.
static <E extends Enum<E>> E[]	aRandomArrayOfEnum(Class<E> enumType) Build an array of random values from the supplied enumeration.
static <E extends Enum<E>> E[]	aRandomArrayOfEnum(Class<E> enumType, int min, int max) Build an array of random values from the supplied enumeration of a given size.
static Boolean	aRandomBoolean() Build a random Boolean.
static Byte	aRandomByte() Build a random Byte.
static byte[]	aRandomByteArray() Build a random array of bytes.
static Character	aRandomChar() Build a random Character.
static <T> Collection<T>	aRandomCollectionOf(Class<T> type) Build a collection of randomly populated instances of the supplied type.
static <T> Collection<T>	aRandomCollectionOf(Class<T> type, int min, int max) Build a collection of randomly populated instances of the supplied type if a given size.
static Date	aRandomDate() Build a random Date with an year either side of today.
static BigDecimal	aRandomDecimal() Build a random BigDecimal.
static Double	aRandomDouble() Build a random Double.
static <E extends Enum<E>> E	aRandomEnum(Class<E> enumType) Build a random instance of the supplied enumeration.
static Float	aRandomFloat() Build a random Float.
static <T> T	aRandomInstanceOf(Class<T> type) Build a random instance of the supplied type.
static <T> T	aRandomInstanceOf(Class<T> type, List<RandomBuilder.RandomRestriction> restrictions) Build a random instance of the supplied type.
static <T> T	aRandomInstanceOf(Class<T> type, RandomBuilder.RandomRestriction... restrictions) Build a random instance of the supplied type.
static Instant	aRandomInstant() Build a random ZonedDateTime with an year either side of today.
static Integer	aRandomInteger() Build a random Integer.
static Integer	aRandomInteger(int min, int max) Build a random Integer within the supplied minumum and maximum range.
static <T> List<T>	aRandomListOf(Class<T> type) Build a list of randomly populated instances of the supplied type.
static <T> List<T>	aRandomListOf(Class<T> type, int min, int max) Build a random list of randomly populated instances of the supplied type if a given size.
static LocalDate	aRandomLocalDate() Build a random LocalDate with an year either side of today.
static LocalDateTime	aRandomLocalDateTime() Build a random LocalDateTime with an year either side of today.
static LocalTime	aRandomLocalTime() Build a random LocalTime within 12 hours either side of now.
static Long	aRandomLong() Build a random Long.
static Long	aRandomLong(int min, int max) Build a random Long within the supplied minumum and maximum range.
static Short	aRandomShort() Build a random Short.
static Short	aRandomShort(short min, short max) Build a random Short within the supplied minumum and maximum range.
static String	aRandomString() Build a random String containing alphanumeric characters.
static String	aRandomString(int length) Build a random String containing alphanumeric characters of the specfied size.
static ZonedDateTime	aRandomZonedDateTime() Build a random ZonedDateTime with an year either side of today.
static <P> RandomBuilder.RandomRestriction	collectionSize(int size) Build and instance of a RandomBuilder.RandomRestriction which will limit the size of all collections to the specified size
static <P> RandomBuilder.RandomRestriction	collectionSize(int min, int max) Build and instance of a RandomBuilder.RandomRestriction which will limit the size of all collections to within the specified range
static <P> RandomBuilder.RandomRestriction	collectionSizeForPath(String path, int size) Build and instance of a RandomBuilder.RandomRestriction which will set the size of the collection at the specified path
static <P> RandomBuilder.RandomRestriction	collectionSizeForPath(String path, int min, int max) Build and instance of a RandomBuilder.RandomRestriction which will limit the size of the collection at the specifed path
static <P> RandomBuilder.RandomRestriction	collectionSizeForProperty(String property, int size) Build and instance of a RandomBuilder.RandomRestriction which will set the size of the collection at the specified property
static <P> RandomBuilder.RandomRestriction	collectionSizeForProperty(String property, int min, int max) Build and instance of a RandomBuilder.RandomRestriction which will limit the size of the collection at the specifed property
static RandomBuilder.RandomRestriction	excludePath(String path) Build and instance of a RandomBuilder.RandomRestriction which will prevent the value at the path being assigned any value
static RandomBuilder.RandomRestriction	excludeProperty(String property) Build and instance of a RandomBuilder.RandomRestriction which will prevent the property being assigned any value
static <T> RandomBuilder.RandomRestriction	factory(Class<T> type, ValueFactory<T> factory) Build and instance of a RandomBuilder.RandomRestriction which uses the ValueFactory to create instances of the specified type.
static <T> T	oneOf(T... rangeOfValues) Return one of the specified range of values.
static RandomBuilder.RandomRestriction	path(String path, Object value) Build and instance of a RandomBuilder.RandomRestriction which assigns the value to the specific path
static RandomBuilder.RandomRestriction	path(String path, ValueFactory<?> factory) Build and instance of a RandomBuilder.RandomRestriction which assigns an ValueFactory derived value to the specific path
static RandomBuilder.RandomRestriction	property(String property, Object value) Build and instance of a RandomBuilder.RandomRestriction which assigns the value to the specific property.
static RandomBuilder.RandomRestriction	property(String property, ValueFactory<?> factory) Build and instance of a RandomBuilder.RandomRestriction which assigns an ValueFactory derived value to the specific property.
static <P> RandomBuilder.RandomRestriction	subtype(Class<P> superType, Class<? extends P>... subTypes) Build and instance of a RandomBuilder.RandomRestriction which will use any of the given sub types of a super type when instantiating the super type.
static <P> RandomBuilder.RandomRestriction	subtype(Class<P> superType, Class<? extends P> subType) Build and instance of a RandomBuilder.RandomRestriction which will use the given subtype of a super type when instantiating the subtype.

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomBuilder

public RandomBuilder()

Method Detail

aRandomString

public static String aRandomString()

Build a random String containing alphanumeric characters. For example

String aRandomName = RandomBuilder.aRandomString();

Returns:

a random String.

aRandomString

public static String aRandomString(int length)

Build a random String containing alphanumeric characters of the specfied size. For example

String aRandomName = RandomBuilder.aRandomString(10);

Returns:

a random String.

aRandomInteger

public static Integer aRandomInteger()

Build a random Integer. For example

Integer aRandomAge = RandomBuilder.aRandomInteger();

Returns:

a random Integer.

aRandomInteger

public static Integer aRandomInteger(int min,
                                     int max)

Build a random Integer within the supplied minumum and maximum range. For example

Integer aRandomAge = RandomBuilder.aRandomInteger(1,100);

Parameters:

min - the minimum value can be

max - the maximum value can be

Returns:

a random Integer within the supplied minumum and maximum range.

aRandomShort

public static Short aRandomShort()

Build a random Short. For example

Short aRandomAge = RandomBuilder.aRandomShort(); .

Returns:

a random Short.

aRandomShort

public static Short aRandomShort(short min,
                                 short max)

Build a random Short within the supplied minumum and maximum range. For example

Short aRandomAge = RandomBuilder.aRandomShort(1,100);

Parameters:

min - the minimum value can be

max - the maximum value can be

Returns:

a random Short within the supplied minumum and maximum range.

aRandomLong

public static Long aRandomLong()

Build a random Long. For example

Long aRandomAge = RandomBuilder.aRandomLong(1,100);

Returns:

a random Long.

aRandomLong

public static Long aRandomLong(int min,
                               int max)

Build a random Long within the supplied minumum and maximum range. For example

Long aRandomAge = RandomBuilder.aRandomLong(1,100L);

Parameters:

min - the minimum value can be

max - the maximum value can be

Returns:

a random Long within the supplied minumum and maximum range.

aRandomDouble

public static Double aRandomDouble()

Build a random Double. For example

Double aRandomHeight = RandomBuilder.aRandomDouble();

Returns:

a random Double.

aRandomFloat

public static Float aRandomFloat()

Build a random Float. For example

Float aRandomHeight = RandomBuilder.aRandomFloat();

Returns:

a random Float.

oneOf

public static <T> T oneOf(T... rangeOfValues)

Return one of the specified range of values. For exampl

String aRandomName = RandomBuilder.oneOf("Bob", "Alice", "Jane");

Type Parameters:

T - the type of the value

Parameters:

rangeOfValues - the range of values to pick a value from

Returns:

one of supplied arguments

aRandomBoolean

public static Boolean aRandomBoolean()

Build a random Boolean. For example

Boolean aRandomHasSibilings = RandomBuilder.aRandomBoolean();

Returns:

a random Boolean.

aRandomDate

public static Date aRandomDate()

Build a random Date with an year either side of today. For example

Date aRandomBirthday = RandomBuilder.aRandomDate();

Returns:

a random Date with an year either side of today.

aRandomLocalDate

public static LocalDate aRandomLocalDate()

Build a random LocalDate with an year either side of today. For example

LocalDate aRandomBirthday = RandomBuilder.aRandomLocalDate();

Returns:

a random LocalDate with an year either side of today.

aRandomLocalDateTime

public static LocalDateTime aRandomLocalDateTime()

Build a random LocalDateTime with an year either side of today. For example

LocalDateTime aRandomBirthday = RandomBuilder.aRandomLocalDateTime();

Returns:

a random LocalDateTime with an year either side of today.

aRandomLocalTime

public static LocalTime aRandomLocalTime()

Build a random LocalTime within 12 hours either side of now. For example

LocalTime aRandomTime = RandomBuilder.aRandomLocalTime();

Returns:

a random aRandomLocalTime within 12 hours either side of now.

aRandomZonedDateTime

public static ZonedDateTime aRandomZonedDateTime()

Build a random ZonedDateTime with an year either side of today. For example

ZonedDateTime aRandomBirthday = RandomBuilder.aRandomZonedDateTime();

Returns:

a random ZonedDateTime with an year either side of today.

aRandomInstant

public static Instant aRandomInstant()

Build a random ZonedDateTime with an year either side of today. For example

ZonedDateTime aRandomBirthday = RandomBuilder.aRandomZonedDateTime();

Returns:

a random ZonedDateTime with an year either side of today.

aRandomDecimal

public static BigDecimal aRandomDecimal()

Build a random BigDecimal. For example

BigDecimal aRandomWeight = RandomBuilder.aRandomDecimal();

Returns:

a random BigDecimal.

aRandomByte

public static Byte aRandomByte()

Build a random Byte. For example

BigDecimal aRandomByte = RandomBuilder.aRandomByte();

Returns:

a random Byte.

aRandomByteArray

public static byte[] aRandomByteArray()

Build a random array of bytes. For example

byte [] aRandomID = RandomBuilder.aRandomByteArray();

Returns:

a random array of bytes

aRandomChar

public static Character aRandomChar()

Build a random Character. For example

Character aRandomInitial = RandomBuilder.aRandomCharacter();

Returns:

a random Character.

aRandomEnum

public static <E extends Enum<E>> E aRandomEnum(Class<E> enumType)

Build a random instance of the supplied enumeration. For example

Gender aRandomGender = RandomBuilder.aRandomEnum(Gender.class);

Parameters:

enumType - the enumeration to create a random instance of

Returns:

a random instance of the supplied enumeration.

aRandomArrayOfEnum

public static <E extends Enum<E>> E[] aRandomArrayOfEnum(Class<E> enumType)

Build an array of random values from the supplied enumeration. For example

EyeColour [] eyeColours = RandomBuilder.aRandomArrayOfEnum(EyeColour.class);

Parameters:

enumType - the enumeration to create an array of

Returns:

an array of random values from the supplied enumeration.

aRandomArrayOfEnum

public static <E extends Enum<E>> E[] aRandomArrayOfEnum(Class<E> enumType,
                                                         int min,
                                                         int max)

Build an array of random values from the supplied enumeration of a given size. For example

EyeColour [] eyeColours = RandomBuilder.aRandomArrayOfEnum(EyeColour.class, 2, 5);

Parameters:

enumType - the enumeration to create an array of

min - the minimum size the array can be

max - the maxiumum size the array can be

Returns:

an array of random values from the supplied enumeration.

aRandomArrayOf

public static <T> T[] aRandomArrayOf(Class<T> type)

Build an array of randomly populated instances of the supplied type. For example

Person [] aRandomCrowd = RandomBuilder.aRandomArrayOf(Person.class);

Parameters:

type - the type to create an array of

Returns:

an array of randomly populated instances of the supplied type

aRandomArrayOf

public static <T> T[] aRandomArrayOf(Class<T> type,
                                     int min,
                                     int max)

Build an array of randomly populated instances of the supplied type if a given size. For example

Person [] aRandomCrowd = RandomBuilder.aRandomArrayOf(Person.class,10,50);

Parameters:

type - the type to create an array of

min - the minimum size the array can be

max - the maxiumum size the array can be

Returns:

an array of randomly populated instances of the supplied type

aRandomCollectionOf

public static <T> Collection<T> aRandomCollectionOf(Class<T> type)

Build a collection of randomly populated instances of the supplied type. For example

Collection aRandomCrowd = RandomBuilder.aRandomCollectionOf(Person.class);

Parameters:

type - the type to create a collection of

Returns:

a collection of randomly populated instances of the supplied type

aRandomCollectionOf

public static <T> Collection<T> aRandomCollectionOf(Class<T> type,
                                                    int min,
                                                    int max)

Build a collection of randomly populated instances of the supplied type if a given size. For example

Collection aRandomCrowd = RandomBuilder.aRandomCollectionOf(Person.class,10,50);

Parameters:

type - the type to create a collection of

min - the minimum size the collection can be

max - the maxiumum size the collection can be

Returns:

a collection of randomly populated instances of the supplied type if a given size

aRandomListOf

public static <T> List<T> aRandomListOf(Class<T> type)

Build a list of randomly populated instances of the supplied type. For example

List aRandomCrowd = RandomBuilder.aRandomListOf(Person.class);

Parameters:

type - the type to create a list of

Returns:

a list of randomly populated instances of the supplied type

aRandomListOf

public static <T> List<T> aRandomListOf(Class<T> type,
                                        int min,
                                        int max)

Build a random list of randomly populated instances of the supplied type if a given size. For example

List aRandomCrowd = RandomBuilder.aRandomListOf(Person.class);

Parameters:

type - the type to create a random list of

min - the minimum size the list can be

max - the maxiumum size the list can be

Returns:

a random list of randomly populated instances of the supplied type

aRandomInstanceOf

public static <T> T aRandomInstanceOf(Class<T> type)

Build a random instance of the supplied type. For example

Person aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class);

Parameters:

type - the type to create a random instance of

restrictions - an array of restrictions which control how the random instance is built

Returns:

a random instance of the supplied type

aRandomInstanceOf

public static <T> T aRandomInstanceOf(Class<T> type,
                                      RandomBuilder.RandomRestriction... restrictions)

Build a random instance of the supplied type. An array of restrictions can be supplied as arguments if control is required over how some of the properties are populated. For example

Person aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class);

For examples on how to use restrictions to define the random object See:

 path(String, Object)
 property(String, Object)
 excludePath(String)
 excludeProperty(String)
 subtype(Class, Class)
 subtype(Class, Class...)
 collectionSize(int)
 collectionSize(int, int)
 collectionSizeForPath(String, int)
 collectionSizeForProperty(String, int)
 collectionSizeForProperty(String, int, int)
 

Parameters:

type - the type to create a random instance of

restrictions - an array of restrictions which control how the random instance is built

Returns:

a random instance of the supplied type

aRandomInstanceOf

public static <T> T aRandomInstanceOf(Class<T> type,
                                      List<RandomBuilder.RandomRestriction> restrictions)

Build a random instance of the supplied type. A list of restrictions can be supplied as arguments if control is required over how some of the properties are populated. For example

List restrictions = new ArrayList();
restrictions.add(RandomBuilder.path("person.surname","Smith"));
restrictions.add(RandomBuilder.property("age",25));
Person aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class, restrictions);

For examples on how to use restrictions to define the random object See:

 path(String, Object)
 property(String, Object)
 excludePath(String)
 excludeProperty(String)
 subtype(Class, Class)
 subtype(Class, Class...)
 collectionSize(int)
 collectionSize(int, int)
 collectionSizeForPath(String, int)
 collectionSizeForProperty(String, int)
 collectionSizeForProperty(String, int, int)
 

Parameters:

type - the type to create a random instance of

restrictions - an array of restrictions which control how the random instance is built

Returns:

a random instance of the supplied type

property

public static RandomBuilder.RandomRestriction property(String property,
                                                       Object value)

Build and instance of a RandomBuilder.RandomRestriction which assigns the value to the specific property. For example

Person aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class, RandomBuilder.property("surname", "Smith"));

Parameters:

property - the property to assign e.g. "name"

value - the value to assign the property e.g. "Jane Doe"

property

public static RandomBuilder.RandomRestriction property(String property,
                                                       ValueFactory<?> factory)

Build and instance of a RandomBuilder.RandomRestriction which assigns an ValueFactory derived value to the specific property. For example

Person aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class, RandomBuilder.property("surname", ValueFactories.oneOf("Smith","Brown"));

Parameters:

property - the property to assign

value - the value to assign the property

factory

public static <T> RandomBuilder.RandomRestriction factory(Class<T> type,
                                                          ValueFactory<T> factory)

Build and instance of a RandomBuilder.RandomRestriction which uses the ValueFactory to create instances of the specified type. For example

Shape aRandomPerson = RandomBuilder.aRandomInstanceOf(Person.class, RandomBuilder.factory(Email.class, new EmailFactory());

Parameters:

type - the type to use the instance factory for

factory - the instance factory to use

excludeProperty

public static RandomBuilder.RandomRestriction excludeProperty(String property)

Build and instance of a RandomBuilder.RandomRestriction which will prevent the property being assigned any value

Parameters:

property - the path to assign e.g. "name"

path

public static RandomBuilder.RandomRestriction path(String path,
                                                   Object value)

Build and instance of a RandomBuilder.RandomRestriction which assigns the value to the specific path

Parameters:

path - the path to assign e.g. "person.name"

value - the value to assign the path e.g. "Jane Doe"

path

public static RandomBuilder.RandomRestriction path(String path,
                                                   ValueFactory<?> factory)

Build and instance of a RandomBuilder.RandomRestriction which assigns an ValueFactory derived value to the specific path

Parameters:

path - the path to assign e.g. "person.name"

value - the value to assign the path

excludePath

public static RandomBuilder.RandomRestriction excludePath(String path)

Build and instance of a RandomBuilder.RandomRestriction which will prevent the value at the path being assigned any value

Parameters:

path - the path to assign e.g. "person.name"

subtype

public static <P> RandomBuilder.RandomRestriction subtype(Class<P> superType,
                                                          Class<? extends P> subType)

Build and instance of a RandomBuilder.RandomRestriction which will use the given subtype of a super type when instantiating the subtype.

Parameters:

superType - the super type

subType - the sub type to use when creating an instance of the super type

subtype

public static <P> RandomBuilder.RandomRestriction subtype(Class<P> superType,
                                                          Class<? extends P>... subTypes)

Build and instance of a RandomBuilder.RandomRestriction which will use any of the given sub types of a super type when instantiating the super type.

Parameters:

superType - the super type

subType - the sub types to use when creating an instance of the super type

collectionSize

public static <P> RandomBuilder.RandomRestriction collectionSize(int size)

Build and instance of a RandomBuilder.RandomRestriction which will limit the size of all collections to the specified size

Parameters:

size - the size of the collection

collectionSize

public static <P> RandomBuilder.RandomRestriction collectionSize(int min,
                                                                 int max)

Build and instance of a RandomBuilder.RandomRestriction which will limit the size of all collections to within the specified range

Parameters:

min - the minimum size the collections can be

max - the maximum size the collections can be

collectionSizeForPath

public static <P> RandomBuilder.RandomRestriction collectionSizeForPath(String path,
                                                                        int size)

Build and instance of a RandomBuilder.RandomRestriction which will set the size of the collection at the specified path

Parameters:

path - the path to assign the collection size of e.g. "person.siblings"

size - the size of the collection

collectionSizeForPath

public static <P> RandomBuilder.RandomRestriction collectionSizeForPath(String path,
                                                                        int min,
                                                                        int max)

Build and instance of a RandomBuilder.RandomRestriction which will limit the size of the collection at the specifed path

Parameters:

min - the minimum size the collections can be

max - the maximum size the collections can be

collectionSizeForProperty

public static <P> RandomBuilder.RandomRestriction collectionSizeForProperty(String property,
                                                                            int size)

Build and instance of a RandomBuilder.RandomRestriction which will set the size of the collection at the specified property

Parameters:

property - the property to assign the collection size of e.g. "person.siblings"

size - the size of the collection

collectionSizeForProperty

public static <P> RandomBuilder.RandomRestriction collectionSizeForProperty(String property,
                                                                            int min,
                                                                            int max)

Build and instance of a RandomBuilder.RandomRestriction which will limit the size of the collection at the specifed property

Parameters:

min - the minimum size the collections can be

max - the maximum size the collections can be