Package org.instancio.generators

Interface CommonGeneratorSpecs

All Known Subinterfaces:

Generators, InstancioGenApi, ValueSpecs

interface CommonGeneratorSpecs

Defines specs that are available via both:

• InstancioApi.generate(TargetSelector, GeneratorSpecProvider)
• Instancio.gen()

Since:

5.0.0

Method Summary

Modifier and Type	Method	Description
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.
NumberGeneratorSpec<Double>	doubles()	Generator for Double values.
<E extends Enum<E>> EnumGeneratorSpec<E>	enumOf(Class<E> enumClass)	Generator for enum values.
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.
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.
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.

Returns:

API builder reference

Since:

5.0.0

booleans

BooleanGeneratorSpec booleans()

Generator for Boolean values.

Returns:

API builder reference

Since:

5.0.0

chars

CharacterGeneratorSpec chars()

Generator for Character values.

Returns:

API builder reference

Since:

5.0.0

bytes

NumberGeneratorSpec<Byte> bytes()

Generator for Byte values.

Returns:

API builder reference

Since:

5.0.0

shorts

NumberGeneratorSpec<Short> shorts()

Generator for Short values.

Returns:

API builder reference

Since:

5.0.0

ints

NumberGeneratorSpec<Integer> ints()

Generator for Integer values.

Returns:

API builder reference

Since:

5.0.0

intSeq

NumericSequenceGeneratorSpec<Integer> intSeq()

An Integer sequence generator.

Returns:

API builder reference

Since:

5.0.0

longs

NumberGeneratorSpec<Long> longs()

Generator for Long values.

Returns:

API builder reference

Since:

5.0.0

longSeq

NumericSequenceGeneratorSpec<Long> longSeq()

A Long sequence generator.

Returns:

API builder reference

Since:

5.0.0

floats

NumberGeneratorSpec<Float> floats()

Generator for Float values.

Returns:

API builder reference

Since:

5.0.0

doubles

NumberGeneratorSpec<Double> doubles()

Generator for Double values.

Returns:

API builder reference

Since:

5.0.0

enumOf

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

Generator for enum values.

Type Parameters:

E - enum type

Parameters:

enumClass - type of enum to generate

Returns:

API builder reference

Since:

5.0.0

math

MathGenerators math()

Provides generators for java.math classes.

Returns:

API builder reference

Since:

5.0.0

net

NetGenerators net()

Provides generators for java.net classes.

Returns:

API builder reference

Since:

5.0.0

oneOf

<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:

API builder reference

Since:

5.0.0

oneOf

<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:

API builder reference

Since:

5.0.0

checksum

ChecksumGenerators checksum()

Provides access to checksum generators.

Returns:

API builder reference

Since:

5.0.0

io

IoGenerators io()

Provides access to IO generators.

Returns:

API builder reference

Since:

5.0.0

nio

NioGenerators nio()

Provides access to NIO generators.

Returns:

API builder reference

Since:

5.0.0

temporal

TemporalGenerators temporal()

Provides access to temporal generators.

Returns:

API builder reference

Since:

5.0.0

text

TextGenerators text()

Provides access to text generators.

Returns:

API builder reference

Since:

5.0.0

id

IdGenerators id()

Provides access to identifier generators.

Returns:

API builder reference

Since:

5.0.0

hash

HashGeneratorSpec hash()

Generator for various types of hashes.

Returns:

API builder reference

Since:

5.0.0

finance

FinanceGenerators finance()

Provides access to finance-related generators.

Returns:

API builder reference

Since:

5.0.0

spatial

SpatialGenerators spatial()

Provides access to spatial data type related generators.

Returns:

API builder reference

Since:

5.0.0