Package org.instancio.generators

Interface Generators

All Superinterfaces:

CommonGeneratorSpecs

public interface Generators
extends CommonGeneratorSpecs

Defines all built-in generators available via the InstancioApi.generate(TargetSelector, GeneratorSpecProvider).

Since:

1.0.1

Method Summary

Modifier and Type	Method	Description
<T> ArrayGeneratorSpec<T>	array()	Generator for arrays.
AtomicGenerators	atomic()	Provides access to atomic generators.
BooleanGeneratorSpec	booleans()	Generator for Boolean values.
NumberGeneratorSpec<Byte>	bytes()	Generator for Byte values.
CharacterGeneratorSpec	chars()	Generator for Character values.
ChecksumGenerators	checksum()	Provides access to checksum generators.
<T> CollectionGeneratorSpec<T>	collection()	Generator for collections.
NumberGeneratorSpec<Double>	doubles()	Generator for Double values.
<T> EmitGeneratorSpec<T>	emit()	Emits provided items to a selector's target.
<E extends Enum<E>> EnumGeneratorSpec<E>	enumOf(Class<E> enumClass)	Generator for enum values.
<E extends Enum<E>> EnumSetGeneratorSpec<E>	enumSet(Class<E> enumClass)	Generator for EnumSet.
FinanceGenerators	finance()	Provides access to finance-related generators.
NumberGeneratorSpec<Float>	floats()	Generator for Float values.
HashGeneratorSpec	hash()	Generator for various types of hashes.
IdGenerators	id()	Provides access to identifier generators.
NumberGeneratorSpec<Integer>	ints()	Generator for Integer values.
NumericSequenceGeneratorSpec<Integer>	intSeq()	An Integer sequence generator.
IoGenerators	io()	Provides access to IO generators.
NumberGeneratorSpec<Long>	longs()	Generator for Long values.
NumericSequenceGeneratorSpec<Long>	longSeq()	A Long sequence generator.
<K, V> MapGeneratorSpec<K,V>	map()	Generator for maps.
MathGenerators	math()	Provides generators for java.math classes.
NetGenerators	net()	Provides generators for java.net classes.
NioGenerators	nio()	Provides access to NIO generators.
<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.
<T> OptionalGeneratorSpec<T>	optional()	Generator for Optional.
NumberGeneratorSpec<Short>	shorts()	Generator for Short values.
SpatialGenerators	spatial()	Provides access to spatial data type related generators.
StringGeneratorSpec	string()	Generator for String values.
TemporalGenerators	temporal()	Provides access to temporal generators.
TextGenerators	text()	Provides access to text generators.

Method Details

string

StringGeneratorSpec string()

Generator for String values.

Specified by:

string in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

booleans

BooleanGeneratorSpec booleans()

Generator for Boolean values.

Specified by:

booleans in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.0.0

chars

CharacterGeneratorSpec chars()

Generator for Character values.

Specified by:

chars in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.0.0

bytes

NumberGeneratorSpec<Byte> bytes()

Generator for Byte values.

Specified by:

bytes in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

shorts

NumberGeneratorSpec<Short> shorts()

Generator for Short values.

Specified by:

shorts in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

ints

NumberGeneratorSpec<Integer> ints()

Generator for Integer values.

Specified by:

ints in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

intSeq

NumericSequenceGeneratorSpec<Integer> intSeq()

An Integer sequence generator.

Specified by:

intSeq in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.13.0

longs

NumberGeneratorSpec<Long> longs()

Generator for Long values.

Specified by:

longs in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

longSeq

NumericSequenceGeneratorSpec<Long> longSeq()

A Long sequence generator.

Specified by:

longSeq in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.13.0

floats

NumberGeneratorSpec<Float> floats()

Generator for Float values.

Specified by:

floats in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

doubles

NumberGeneratorSpec<Double> doubles()

Generator for Double values.

Specified by:

doubles in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

1.0.1

enumOf

<E extends Enum<E>> EnumGeneratorSpec<E> enumOf(Class<E> enumClass)

Generator for enum values.

Specified by:

enumOf in interface CommonGeneratorSpecs

Type Parameters:

E - enum type

Parameters:

enumClass - type of enum to generate

Returns:

API builder reference

math

MathGenerators math()

Provides generators for java.math classes.

Specified by:

math in interface CommonGeneratorSpecs

Returns:

API builder reference

net

NetGenerators net()

Provides generators for java.net classes.

Specified by:

net in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.3.0

oneOf

<T> OneOfArrayGeneratorSpec<T> oneOf(T... choices)

Picks a random value from the given choices.

Specified by:

oneOf in interface CommonGeneratorSpecs

Type Parameters:

T - element type

Parameters:

choices - to choose from

Returns:

API builder reference

Since:

1.0.1

oneOf

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

Picks a random value from the given choices.

Specified by:

oneOf in interface CommonGeneratorSpecs

Type Parameters:

T - element type

Parameters:

choices - to choose from

Returns:

API builder reference

Since:

1.0.1

optional

<T> OptionalGeneratorSpec<T> optional()

Generator for Optional.

Type Parameters:

T - the type of value

Returns:

API builder reference

Since:

2.14.0

array

<T> ArrayGeneratorSpec<T> array()

Generator for arrays.

Type Parameters:

T - array component type

Returns:

API builder reference

Since:

1.0.1

collection

<T> CollectionGeneratorSpec<T> collection()

Generator for collections.

Type Parameters:

T - element type

Returns:

API builder reference

Since:

1.0.1

map

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

Generator for maps.

Type Parameters:

K - key type

V - value type

Returns:

API builder reference

Since:

1.0.1

enumSet

<E extends Enum<E>> EnumSetGeneratorSpec<E> enumSet(Class<E> enumClass)

Generator for EnumSet.

Type Parameters:

E - enum type

Parameters:

enumClass - contained by the generated enum set

Returns:

API builder reference

Since:

2.0.0

emit

@ExperimentalApi
<T> EmitGeneratorSpec<T> emit()

Emits provided items to a selector's target. The main use case for this generator us to customise fields of collection elements.

For example, the snippet below generates a list of 7 orders with different statuses: 1 received, 1 shipped, 3 completed, and 2 cancelled.

   List<Order> orders = Instancio.ofList(Order.class)
     .size(7)
     .generate(field(Order::getStatus), gen -> gen.emit()
              .items(OrderStatus.RECEIVED, OrderStatus.SHIPPED)
              .item(OrderStatus.COMPLETED, 3)
              .item(OrderStatus.CANCELLED, 2))
     .create();
 

Note that the number of items being emitted is equal to the collection size. If there are not enough items to emit for a given collection size, then by default, random values will be generated. This behaviour can be customised using the following methods:

• EmitGeneratorSpec.whenEmptyEmitNull()
• EmitGeneratorSpec.whenEmptyEmitRandom() (default behaviour)
• EmitGeneratorSpec.whenEmptyRecycle() (reuse items)
• EmitGeneratorSpec.whenEmptyThrowException()

If the selector target is a group, then each selector will have its own copy of items, for example:

 // Given
 record FooBar(String foo, String bar) {}

 TargetSelector selectorGroup = Select.all(
     field(FooBar::foo),
     field(FooBar::bar)
 );

 // When
 FooBar result = Instancio.of(FooBar.class)
     .generate(selectorGroup, gen -> gen.emit().items("BAZ"))
     .create();

 // Output: FooBar[foo=BAZ, bar=BAZ]
 

Warning: special care must be taken to ensure that the selector associated with emit() matches only the expected target and nothing else. Failure to do so may produce unexpected results.

Type Parameters:

T - the type to emit

Returns:

emitting generator

Since:

2.12.0

atomic

AtomicGenerators atomic()

Provides access to atomic generators.

Returns:

API builder reference

checksum

ChecksumGenerators checksum()

Provides access to checksum generators.

Specified by:

checksum in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.16.0

io

IoGenerators io()

Provides access to IO generators.

Specified by:

io in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.2.0

nio

NioGenerators nio()

Provides access to NIO generators.

Specified by:

nio in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.1.0

temporal

TemporalGenerators temporal()

Provides access to temporal generators.

Specified by:

temporal in interface CommonGeneratorSpecs

Returns:

API builder reference

text

TextGenerators text()

Provides access to text generators.

Specified by:

text in interface CommonGeneratorSpecs

Returns:

API builder reference

id

IdGenerators id()

Provides access to identifier generators.

Specified by:

id in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.11.0

hash

HashGeneratorSpec hash()

Generator for various types of hashes.

Specified by:

hash in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.11.0

finance

FinanceGenerators finance()

Provides access to finance-related generators.

Specified by:

finance in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

2.11.0

spatial

SpatialGenerators spatial()

Provides access to spatial data type related generators.

Specified by:

spatial in interface CommonGeneratorSpecs

Returns:

API builder reference

Since:

4.4.0