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

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 theory parameter's type arguments.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canRegisterAsType(Class<?> type)
void	configure(Size sizeRange) 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.
protected abstract T	emptyMap()
T	generate(SourceOfRandomness random, GenerationStatus status)
int	numberOfNeededComponents()
protected boolean	okToAdd(Object key, Object value)

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

addComponentGenerators, canGenerateForParametersOfTypes, componentGenerators, configure, hasComponents, provideRepository

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

compatibleWithTypeParameter, types

Methods inherited from class java.lang.Object

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

Constructor Detail

MapGenerator

protected MapGenerator(Class<T> type)

Method Detail

configure

public void configure(Size sizeRange)

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:

sizeRange - annotation that gives the size constraints

generate

public T generate(SourceOfRandomness random,
                  GenerationStatus status)

Specified by:

generate in class Generator<T extends Map>

numberOfNeededComponents

public int numberOfNeededComponents()

Overrides:

numberOfNeededComponents in class Generator<T extends Map>

canRegisterAsType

public boolean canRegisterAsType(Class<?> type)

Overrides:

canRegisterAsType in class Generator<T extends Map>

emptyMap

protected abstract T emptyMap()

okToAdd

protected boolean okToAdd(Object key,
                          Object value)