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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> ArrayGeneratorSpec<T>
array()
Customises generated arrays.NumberGeneratorSpec<BigDecimal>
bigDecimal()
Customises generatedBigDecimal
values.NumberGeneratorSpec<BigInteger>
bigInteger()
Customises generatedBigInteger
values.NumberGeneratorSpec<Byte>
bytes()
Customises generatedByte
values.<T> CollectionGeneratorSpec<T>
collection()
Customises generated collections.NumberGeneratorSpec<Double>
doubles()
Customises generatedDouble
values.NumberGeneratorSpec<Float>
floats()
Customises generatedFloat
values.NumberGeneratorSpec<Integer>
ints()
Customises generatedInteger
values.TemporalGeneratorSpec<LocalDate>
localDate()
Customises generatedLocalDate
values.TemporalGeneratorSpec<LocalDateTime>
localDateTime()
Customises generatedLocalDateTime
values.TemporalGeneratorSpec<LocalTime>
localTime()
Customises generatedLocalTime
values.NumberGeneratorSpec<Long>
longs()
Customises generatedLong
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 generatedShort
values.StringGeneratorSpec
string()
Customises generatedString
values.TextGenerators
text()
Provides access to text generators.TemporalGeneratorSpec<Year>
year()
Customises generatedYear
values.TemporalGeneratorSpec<YearMonth>
yearMonth()
Customises generatedYearMonth
values.TemporalGeneratorSpec<ZonedDateTime>
zonedDateTime()
Customises generatedZonedDateTimeGenerator
values.
-
-
-
Constructor Detail
-
Generators
public Generators(GeneratorContext context)
-
-
Method Detail
-
string
public StringGeneratorSpec string()
Customises generatedString
values.- Returns:
- customised generator
-
text
public TextGenerators text()
Provides access to text generators.- Returns:
- available text generators
-
bytes
public NumberGeneratorSpec<Byte> bytes()
Customises generatedByte
values.- Returns:
- customised generator
-
shorts
public NumberGeneratorSpec<Short> shorts()
Customises generatedShort
values.- Returns:
- customised generator
-
ints
public NumberGeneratorSpec<Integer> ints()
Customises generatedInteger
values.- Returns:
- customised generator
-
longs
public NumberGeneratorSpec<Long> longs()
Customises generatedLong
values.- Returns:
- customised generator
-
floats
public NumberGeneratorSpec<Float> floats()
Customises generatedFloat
values.- Returns:
- customised generator
-
doubles
public NumberGeneratorSpec<Double> doubles()
Customises generatedDouble
values.- Returns:
- customised generator
-
bigInteger
public NumberGeneratorSpec<BigInteger> bigInteger()
Customises generatedBigInteger
values.- Returns:
- customised generator
-
bigDecimal
public NumberGeneratorSpec<BigDecimal> bigDecimal()
Customises generatedBigDecimal
values.- Returns:
- customised generator
-
localDate
public TemporalGeneratorSpec<LocalDate> localDate()
Customises generatedLocalDate
values.- Returns:
- customised generator
-
localTime
public TemporalGeneratorSpec<LocalTime> localTime()
Customises generatedLocalTime
values.- Returns:
- customised generator
-
localDateTime
public TemporalGeneratorSpec<LocalDateTime> localDateTime()
Customises generatedLocalDateTime
values.- Returns:
- customised generator
-
zonedDateTime
public TemporalGeneratorSpec<ZonedDateTime> zonedDateTime()
Customises generatedZonedDateTimeGenerator
values.- Returns:
- customised generator
-
yearMonth
public TemporalGeneratorSpec<YearMonth> yearMonth()
Customises generatedYearMonth
values.- Returns:
- customised generator
-
year
public TemporalGeneratorSpec<Year> year()
Customises generatedYear
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 typeV
- value type- Returns:
- customised generator
-
-