Package org.instancio.internal.generator.util

Class MapGenerator<K,V>

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<Map<K,V>>

org.instancio.internal.generator.util.MapGenerator<K,V>

All Implemented Interfaces:

Generator<Map<K,V>>, GeneratorSpec<Map<K,V>>, MapGeneratorSpec<K,V>, NullableGeneratorSpec<Map<K,V>>, SizeGeneratorSpec<Map<K,V>>, SubtypeGeneratorSpec<Map<K,V>>

Direct Known Subclasses:

MapGeneratorSpecImpl

public class MapGenerator<K,V>
extends AbstractGenerator<Map<K,V>>
implements MapGeneratorSpec<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isDelegating
protected Class<?>	mapType
protected int	maxSize
protected int	minSize
protected boolean	nullableKeys
protected boolean	nullableValues

Constructor Summary

Constructors

Constructor	Description
MapGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Hints	hints()	Hints provided by the generator to the engine.
MapGeneratorSpec<K,V>	maxSize(int size)	Maximum size of map to generate.
MapGeneratorSpec<K,V>	minSize(int size)	Minimum size of map to generate.
MapGeneratorSpec<K,V>	nullable()	Indicates that null value can be generated.
MapGeneratorSpec<K,V>	nullable(boolean isNullable)
MapGeneratorSpec<K,V>	nullableKeys()	Indicates that null values can be generated for map keys.
MapGeneratorSpec<K,V>	nullableValues()	Indicates that null values can be generated for map values.
MapGeneratorSpec<K,V>	size(int size)	Size of map to generate.
MapGeneratorSpec<K,V>	subtype(Class<?> type)	Specifies the type of map that should be generated.
Map<K,V>	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
MapGeneratorSpec<K,V>	with(K key, V value)	Adds given key/value pair to the generated map.
final MapGeneratorSpec<K,V>	withKeys(K... keys)	Adds given keys to the map in the order they are provided.

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

generate, getContext, isNullable

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.Generator

init

Field Details

minSize

protected int minSize

maxSize

protected int maxSize

nullableKeys

protected boolean nullableKeys

nullableValues

protected boolean nullableValues

mapType

protected Class<?> mapType

isDelegating

protected boolean isDelegating

Constructor Details

MapGenerator

public MapGenerator(GeneratorContext context)

Method Details

apiMethod

public String apiMethod()

Description copied from class: AbstractGenerator

Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.

Specified by:

apiMethod in class AbstractGenerator<Map<K,V>>

Returns:

spec name if defined, or null otherwise

subtype

public MapGeneratorSpec<K,V> subtype(Class<?> type)

Description copied from interface: MapGeneratorSpec

Specifies the type of map that should be generated.

Specified by:

subtype in interface MapGeneratorSpec<K,V>

Specified by:

subtype in interface SubtypeGeneratorSpec<K>

Parameters:

type - of collection to generate

Returns:

spec builder

size

public MapGeneratorSpec<K,V> size(int size)

Description copied from interface: MapGeneratorSpec

Size of map to generate.

Specified by:

size in interface MapGeneratorSpec<K,V>

Specified by:

size in interface SizeGeneratorSpec<K>

Parameters:

size - of map

Returns:

spec builder

minSize

public MapGeneratorSpec<K,V> minSize(int size)

Description copied from interface: MapGeneratorSpec

Minimum size of map to generate.

Specified by:

minSize in interface MapGeneratorSpec<K,V>

Specified by:

minSize in interface SizeGeneratorSpec<K>

Parameters:

size - minimum size (inclusive)

Returns:

spec builder

maxSize

public MapGeneratorSpec<K,V> maxSize(int size)

Description copied from interface: MapGeneratorSpec

Maximum size of map to generate.

Specified by:

maxSize in interface MapGeneratorSpec<K,V>

Specified by:

maxSize in interface SizeGeneratorSpec<K>

Parameters:

size - maximum size (inclusive)

Returns:

spec builder

nullable

public MapGeneratorSpec<K,V> nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface MapGeneratorSpec<K,V>

Specified by:

nullable in interface NullableGeneratorSpec<K>

Overrides:

nullable in class AbstractGenerator<Map<K,V>>

Returns:

spec builder

nullable

public MapGeneratorSpec<K,V> nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<Map<K,V>>

nullableKeys

public MapGeneratorSpec<K,V> nullableKeys()

Description copied from interface: MapGeneratorSpec

Indicates that null values can be generated for map keys.

Specified by:

nullableKeys in interface MapGeneratorSpec<K,V>

Returns:

spec builder

nullableValues

public MapGeneratorSpec<K,V> nullableValues()

Description copied from interface: MapGeneratorSpec

Indicates that null values can be generated for map values.

Specified by:

nullableValues in interface MapGeneratorSpec<K,V>

Returns:

spec builder

with

public MapGeneratorSpec<K,V> with(K key,
 V value)

Description copied from interface: MapGeneratorSpec

Adds given key/value pair to the generated map. Note that the entry is added after the map has been generated.

Example:

  // will generate a map of size 5 (3 random + 2 custom entries)
  generate(field("someMap"), gen -> gen.map()
          .size(3)
          .with("key1", "value1")
          .with("key2", "value2")
 

Specified by:

with in interface MapGeneratorSpec<K,V>

Parameters:

key - to add

value - to add

Returns:

spec builder

See Also:

• MapGeneratorSpec.withKeys(Object[])

withKeys

@SafeVarargs
public final MapGeneratorSpec<K,V> withKeys(K... keys)

Description copied from interface: MapGeneratorSpec

Adds given keys to the map in the order they are provided.

If the resulting map size is equal to the number of specified keys, then the map will contain only the specified keys and no randomly generated keys.

Examples:

  // will generate a map of size 1 containing only "key1"
  generate(field("someMap"), gen -> gen.map().size(1).withKeys("key1", "key2")

  // will generate a map of size 2 containing "key1" and "key2"
  generate(field("someMap"), gen -> gen.map().size(2).withKeys("key1", "key2")

  // will generate a map of size 5 containing "key1", "key2", and 3 randomly generated keys
  generate(field("someMap"), gen -> gen.map().size(5).withKeys("key1", "key2")
 

Specified by:

withKeys in interface MapGeneratorSpec<K,V>

Parameters:

keys - to add

Returns:

spec builder

See Also:

• MapGeneratorSpec.with(Object, Object)

tryGenerateNonNull

public Map<K,V> tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Specified by:

tryGenerateNonNull in class AbstractGenerator<Map<K,V>>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null

hints

public Hints hints()

Description copied from interface: Generator

Hints provided by the generator to the engine.

The most important hint for custom generators is AfterGenerate. This hint indicates whether the object created by this generator:

• should be populated (for example, if it has null fields)
• can be modified using selectors

For example, setting the hint to AfterGenerate.POPULATE_NULLS will cause Instancio to populate null fields on the object returned by this generator:

   @Override
   public Hints hints() {
       return Hints.afterGenerate(AfterGenerate.POPULATE_NULLS);
   }
 

If the action is not specified, default behaviour will be based on the AfterGenerate value configured in the Settings using the key Keys.AFTER_GENERATE_HINT.

In addition, the following hints can be provided for populating data structures:

• ArrayHint
• CollectionHint
• MapHint

Specified by:

hints in interface Generator<K>

Overrides:

hints in class AbstractGenerator<Map<K,V>>

Returns:

hints from this generator to the engine

See Also:

• Hint
• Hints
• AfterGenerate