Package org.instancio

Class Generators

java.lang.Object

org.instancio.Generators

public class Generators
extends Object

This class provides access to built-in generators.

It can be used to customise random values generated by built-in generators. This includes numbers, collection sizes, string lengths, etc.

Constructor Summary

Constructors

Constructor	Description
Generators(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
<T> ArrayGeneratorSpec<T>	array()	Customises generated arrays.
NumberGeneratorSpec<BigDecimal>	bigDecimal()	Customises generated BigDecimal values.
NumberGeneratorSpec<BigInteger>	bigInteger()	Customises generated BigInteger values.
NumberGeneratorSpec<Byte>	bytes()	Customises generated Byte values.
<T> CollectionGeneratorSpec<T>	collection()	Customises generated collections.
NumberGeneratorSpec<Double>	doubles()	Customises generated Double values.
NumberGeneratorSpec<Float>	floats()	Customises generated Float values.
NumberGeneratorSpec<Integer>	ints()	Customises generated Integer values.
TemporalGeneratorSpec<LocalDate>	localDate()	Customises generated LocalDate values.
TemporalGeneratorSpec<LocalDateTime>	localDateTime()	Customises generated LocalDateTime values.
TemporalGeneratorSpec<LocalTime>	localTime()	Customises generated LocalTime values.
NumberGeneratorSpec<Long>	longs()	Customises generated Long values.
<K,V> MapGeneratorSpec<K,V>	map()	Customises generated maps.
<T> OneOfCollectionGeneratorSpec<T>	oneOf(Collection<T> choices)	Picks a random value from the given choices.
<T> OneOfArrayGeneratorSpec<T>	oneOf(T... choices)	Picks a random value from the given choices.
NumberGeneratorSpec<Short>	shorts()	Customises generated Short values.
StringGeneratorSpec	string()	Customises generated String values.
TextGenerators	text()	Provides access to text generators.
TemporalGeneratorSpec<Year>	year()	Customises generated Year values.
TemporalGeneratorSpec<YearMonth>	yearMonth()	Customises generated YearMonth values.
TemporalGeneratorSpec<ZonedDateTime>	zonedDateTime()	Customises generated ZonedDateTimeGenerator values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Generators

public Generators(GeneratorContext context)

Method Detail

string

public StringGeneratorSpec string()

Customises generated String values.

Returns:

customised generator

text

public TextGenerators text()

Provides access to text generators.

Returns:

available text generators

bytes

public NumberGeneratorSpec<Byte> bytes()

Customises generated Byte values.

Returns:

customised generator

shorts

public NumberGeneratorSpec<Short> shorts()

Customises generated Short values.

Returns:

customised generator

ints

public NumberGeneratorSpec<Integer> ints()

Customises generated Integer values.

Returns:

customised generator

longs

public NumberGeneratorSpec<Long> longs()

Customises generated Long values.

Returns:

customised generator

floats

public NumberGeneratorSpec<Float> floats()

Customises generated Float values.

Returns:

customised generator

doubles

public NumberGeneratorSpec<Double> doubles()

Customises generated Double values.

Returns:

customised generator

bigInteger

public NumberGeneratorSpec<BigInteger> bigInteger()

Customises generated BigInteger values.

Returns:

customised generator

bigDecimal

public NumberGeneratorSpec<BigDecimal> bigDecimal()

Customises generated BigDecimal values.

Returns:

customised generator

localDate

public TemporalGeneratorSpec<LocalDate> localDate()

Customises generated LocalDate values.

Returns:

customised generator

localTime

public TemporalGeneratorSpec<LocalTime> localTime()

Customises generated LocalTime values.

Returns:

customised generator

localDateTime

public TemporalGeneratorSpec<LocalDateTime> localDateTime()

Customises generated LocalDateTime values.

Returns:

customised generator

zonedDateTime

public TemporalGeneratorSpec<ZonedDateTime> zonedDateTime()

Customises generated ZonedDateTimeGenerator values.

Returns:

customised generator

yearMonth

public TemporalGeneratorSpec<YearMonth> yearMonth()

Customises generated YearMonth values.

Returns:

customised generator

year

public TemporalGeneratorSpec<Year> year()

Customises generated Year values.

Returns:

customised generator

oneOf

@SafeVarargs
public final <T> OneOfArrayGeneratorSpec<T> oneOf(T... choices)

Picks a random value from the given choices.

Type Parameters:

T - element type

Parameters:

choices - to choose from

Returns:

generator for making a selection

oneOf

public final <T> OneOfCollectionGeneratorSpec<T> oneOf(Collection<T> choices)

Picks a random value from the given choices.

Type Parameters:

T - element type

Parameters:

choices - to choose from

Returns:

generator for making a selection

array

public <T> ArrayGeneratorSpec<T> array()

Customises generated arrays.

Type Parameters:

T - array component type

Returns:

customised generator

collection

public <T> CollectionGeneratorSpec<T> collection()

Customises generated collections.

Type Parameters:

T - element type

Returns:

customised generator

map

public <K,V> MapGeneratorSpec<K,V> map()

Customises generated maps.

Type Parameters:

K - key type

V - value type

Returns:

customised generator