com.pholser.junit.quickcheck.generator.java.util

Class MapGenerator<T extends Map>

java.lang.Object

com.pholser.junit.quickcheck.generator.Generator<T>

com.pholser.junit.quickcheck.generator.ComponentizedGenerator<T>

com.pholser.junit.quickcheck.generator.java.util.MapGenerator<T>

Type Parameters:

T - the type of map generated

All Implemented Interfaces:

Gen<T>, Shrink<T>

Direct Known Subclasses:

HashMapGenerator, HashtableGenerator, IdentityHashMapGenerator, LinkedHashMapGenerator

public abstract class MapGenerator<T extends Map>
extends ComponentizedGenerator<T>

Base class for generators of Maps.

The generated map has a number of entries limited by GenerationStatus.size(), or else by the attributes of a Size marking. The individual keys and values will have types corresponding to the property parameter's type arguments.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapGenerator(Class<T> type)

Method Summary

Modifier and Type	Method and Description
void	addComponentGenerators(List<Generator<?>> newComponents)
void	configure(Distinct distinct) Tells this generator to add entries whose keys are distinct from each other.
void	configure(Size size) Tells this generator to add key-value pairs to the generated map a number of times within a specified minimum and/or maximum, inclusive, chosen with uniform distribution.
List<T>	doShrink(SourceOfRandomness random, T larger)
protected T	empty()
T	generate(SourceOfRandomness random, GenerationStatus status)
BigDecimal	magnitude(Object value)
int	numberOfNeededComponents()
protected boolean	okToAdd(Object key, Object value)

Methods inherited from class com.pholser.junit.quickcheck.generator.ComponentizedGenerator

canGenerateForParametersOfTypes, canRegisterAsType, componentGenerators, configure, hasComponents, provide

Methods inherited from class com.pholser.junit.quickcheck.generator.Generator

canShrink, compatibleWithTypeParameter, configurationAnnotationsOn, configure, copy, gen, gen, narrow, shrink, types

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pholser.junit.quickcheck.generator.Gen

_gen, filter, filterOptional, flatMap, freq, frequency, map, oneOf, oneOf, pure, times

Constructor Detail

MapGenerator

protected MapGenerator(Class<T> type)

Method Detail

addComponentGenerators

public void addComponentGenerators(List<Generator<?>> newComponents)

Overrides:

addComponentGenerators in class ComponentizedGenerator<T extends Map>

configure

public void configure(Size size)

Tells this generator to add key-value pairs to the generated map a number of times within a specified minimum and/or maximum, inclusive, chosen with uniform distribution.

Note that maps disallow duplicate keys, so the number of pairs added may not be equal to the map's Map.size().

Parameters:

size - annotation that gives the size constraints

configure

public void configure(Distinct distinct)

Tells this generator to add entries whose keys are distinct from each other.

Parameters:

distinct - Keys of generated entries will be distinct if this param is not null

generate

public T generate(SourceOfRandomness random,
                  GenerationStatus status)

doShrink

public List<T> doShrink(SourceOfRandomness random,
                        T larger)

Overrides:

doShrink in class Generator<T extends Map>

numberOfNeededComponents

public int numberOfNeededComponents()

Overrides:

numberOfNeededComponents in class Generator<T extends Map>

magnitude

public BigDecimal magnitude(Object value)

Overrides:

magnitude in class Generator<T extends Map>

empty

protected final T empty()

okToAdd

protected boolean okToAdd(Object key,
                          Object value)