Package org.instancio.generator.util

Class CollectionGenerator<T>

java.lang.Object

org.instancio.generator.AbstractGenerator<Collection<T>>

org.instancio.generator.util.CollectionGenerator<T>

All Implemented Interfaces:

Generator<Collection<T>>, GeneratorSpec<Collection<T>>, CollectionGeneratorSpec<T>

Direct Known Subclasses:

CollectionGeneratorSpecImpl, HashSetGenerator, TreeSetGenerator

public class CollectionGenerator<T>
extends AbstractGenerator<Collection<T>>
implements CollectionGeneratorSpec<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxSize
protected int	minSize
protected boolean	nullable
protected boolean	nullableElements
protected Class<?>	type
protected List<Object>	withElements

Constructor Summary

Constructors

Constructor	Description
CollectionGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
Collection<T>	generate(Random random)	Returns a generated value.
GeneratedHints	getHints()	Returns hints, including collection sizes and whether values are nullable.
CollectionGeneratorSpec<T>	maxSize(int size)	Maximum size of collection to generate.
CollectionGeneratorSpec<T>	minSize(int size)	Minimum size of collection to generate.
CollectionGeneratorSpec<T>	nullable()	Indicates that null value can be generated for the collection.
CollectionGeneratorSpec<T>	nullableElements()	Indicates that null values can be generated for collection elements.
CollectionGeneratorSpec<T>	size(int size)	Size of collection to generate.
CollectionGeneratorSpec<T>	subtype(Class<?> type)	Specifies the type of collection that should be generated.
final CollectionGeneratorSpec<T>	with(T... elements)	Adds given elements to the generated collection at random positions.

Methods inherited from class org.instancio.generator.AbstractGenerator

getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.instancio.Generator

apiMethodName, isDelegating, setDelegate, supports, targetClass

Field Details

minSize

protected int minSize

maxSize

protected int maxSize

nullable

protected boolean nullable

nullableElements

protected boolean nullableElements

type

protected Class<?> type

withElements

protected List<Object> withElements

Constructor Details

CollectionGenerator

public CollectionGenerator(GeneratorContext context)

Method Details

size

public CollectionGeneratorSpec<T> size(int size)

Description copied from interface: CollectionGeneratorSpec

Size of collection to generate.

Specified by:

size in interface CollectionGeneratorSpec<T>

Parameters:

size - of collection

Returns:

spec builder

minSize

public CollectionGeneratorSpec<T> minSize(int size)

Description copied from interface: CollectionGeneratorSpec

Minimum size of collection to generate.

Specified by:

minSize in interface CollectionGeneratorSpec<T>

Parameters:

size - minimum size (inclusive)

Returns:

spec builder

maxSize

public CollectionGeneratorSpec<T> maxSize(int size)

Description copied from interface: CollectionGeneratorSpec

Maximum size of collection to generate.

Specified by:

maxSize in interface CollectionGeneratorSpec<T>

Parameters:

size - maximum size (inclusive)

Returns:

spec builder

nullable

public CollectionGeneratorSpec<T> nullable()

Description copied from interface: CollectionGeneratorSpec

Indicates that null value can be generated for the collection.

Specified by:

nullable in interface CollectionGeneratorSpec<T>

Returns:

spec builder

nullableElements

public CollectionGeneratorSpec<T> nullableElements()

Description copied from interface: CollectionGeneratorSpec

Indicates that null values can be generated for collection elements.

Specified by:

nullableElements in interface CollectionGeneratorSpec<T>

Returns:

spec builder

subtype

public CollectionGeneratorSpec<T> subtype(Class<?> type)

Description copied from interface: CollectionGeneratorSpec

Specifies the type of collection that should be generated.

Specified by:

subtype in interface CollectionGeneratorSpec<T>

Parameters:

type - of collection to generate

Returns:

spec builder

with

@SafeVarargs
public final CollectionGeneratorSpec<T> with(T... elements)

Description copied from interface: CollectionGeneratorSpec

Adds given elements to the generated collection at random positions.

Specified by:

with in interface CollectionGeneratorSpec<T>

Parameters:

elements - to add

Returns:

spec builder

generate

public Collection<T> generate(Random random)

Description copied from interface: Generator

Returns a generated value.

If the generated value is random, it needs to be generated using the given Random instance. This ensures the data is generated with the same seed value and allows random data to be reproduced by specifying the seed value.

Specified by:

generate in interface Generator<T>

Parameters:

random - provider for random values

Returns:

generated value

getHints

public GeneratedHints getHints()

Description copied from interface: Generator

Returns hints, including collection sizes and whether values are nullable.

Specified by:

getHints in interface Generator<T>

Returns:

generated hints