Package org.instancio.generator.hints

Class CollectionHint.Builder

java.lang.Object

org.instancio.generator.hints.CollectionHint.Builder

Enclosing class:

CollectionHint

public static final class CollectionHint.Builder
extends Object

Builder class for this hint.

Method Summary

Modifier and Type	Method	Description
CollectionHint	build()	Builds the object.
CollectionHint.Builder	generateElements(int generateElements)	Indicates how many elements the engine should generate and insert into the collection.
CollectionHint.Builder	nullableElements(boolean nullableElements)	Indicates whether null elements are allowed to be generated.
CollectionHint.Builder	shuffle(boolean shuffle)	Indicates whether collection elements, once populated, should be randomly shuffled.
CollectionHint.Builder	unique(boolean unique)	Indicates that a collection containing unique elements should be generated.
<T> CollectionHint.Builder	withElements(List<? extends T> elements)	Additional elements to be inserted into the collection by the engine during the population process.

Methods inherited from class java.lang.Object

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

Method Details

generateElements

public CollectionHint.Builder generateElements(int generateElements)

Indicates how many elements the engine should generate and insert into the collection.

Parameters:

generateElements - number of elements to generate

Returns:

builder instance

Since:

2.0.0

nullableElements

public CollectionHint.Builder nullableElements(boolean nullableElements)

Indicates whether null elements are allowed to be generated.

Parameters:

nullableElements - if true, null elements allowed

Returns:

builder instance

Since:

2.0.0

shuffle

public CollectionHint.Builder shuffle(boolean shuffle)

Indicates whether collection elements, once populated, should be randomly shuffled. The shuffle implementation ensures that results are reproducible per given seed.

Parameters:

shuffle - if true, elements will be shuffled

Returns:

builder instance

Since:

2.0.0

unique

public CollectionHint.Builder unique(boolean unique)

Indicates that a collection containing unique elements should be generated.

Parameters:

unique - if true, unique elements will be unique

Returns:

builder instance

Since:

2.8.0

withElements

public <T> CollectionHint.Builder withElements(List<? extends T> elements)

Additional elements to be inserted into the collection by the engine during the population process. This method can be invoked more than once.

Type Parameters:

T - element type

Parameters:

elements - elements to be inserted into the collection in addition to the random elements generated by the engine

Returns:

builder instance

Since:

2.0.0

build

public CollectionHint build()

Builds the object.

Returns:

the built instance.