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
Modifier and TypeFieldDescriptionprotected int
protected int
protected boolean
protected boolean
protected Class<?>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongenerate
(RandomProvider random) Returns a generated value.getHints()
Returns hints, including collection sizes and whether values are nullable.maxSize
(int size) Maximum size of collection to generate.minSize
(int size) Minimum size of collection to generate.nullable()
Indicates thatnull
value can be generated for the collection.Indicates thatnull
values can be generated for collection elements.size
(int size) Size of collection to generate.Specifies the type of collection that should be generated.Adds given elements to the generated collection.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
-
withElements
-
-
Constructor Details
-
CollectionGenerator
-
-
Method Details
-
size
Description copied from interface:CollectionGeneratorSpec
Size of collection to generate.- Specified by:
size
in interfaceCollectionGeneratorSpec<T>
- Parameters:
size
- of collection- Returns:
- spec builder
-
minSize
Description copied from interface:CollectionGeneratorSpec
Minimum size of collection to generate.- Specified by:
minSize
in interfaceCollectionGeneratorSpec<T>
- Parameters:
size
- minimum size (inclusive)- Returns:
- spec builder
-
maxSize
Description copied from interface:CollectionGeneratorSpec
Maximum size of collection to generate.- Specified by:
maxSize
in interfaceCollectionGeneratorSpec<T>
- Parameters:
size
- maximum size (inclusive)- Returns:
- spec builder
-
nullable
Description copied from interface:CollectionGeneratorSpec
Indicates thatnull
value can be generated for the collection.- Specified by:
nullable
in interfaceCollectionGeneratorSpec<T>
- Returns:
- spec builder
-
nullableElements
Description copied from interface:CollectionGeneratorSpec
Indicates thatnull
values can be generated for collection elements.- Specified by:
nullableElements
in interfaceCollectionGeneratorSpec<T>
- Returns:
- spec builder
-
type
Description copied from interface:CollectionGeneratorSpec
Specifies the type of collection that should be generated.- Specified by:
type
in interfaceCollectionGeneratorSpec<T>
- Parameters:
type
- of collection to generate- Returns:
- spec builder
-
with
Description copied from interface:CollectionGeneratorSpec
Adds given elements to the generated collection.If the collection is a List, elements will be added at random positions; otherwise elements will be added via
Collection.addAll(Collection)
after the collection has been generated.- Specified by:
with
in interfaceCollectionGeneratorSpec<T>
- Parameters:
elements
- to add- Returns:
- spec builder
-
generate
Description copied from interface:Generator
Returns a generated value.If the generated value is random, it needs to be generated using the given
RandomProvider
instance. This ensures the data is generated with the same seed value and allows random data to be reproduced by specifying the seed value. -
getHints
Description copied from interface:Generator
Returns hints, including collection sizes and whether values are nullable.
-