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

Class CollectionGenerator<T extends Collection>

java.lang.Object

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

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

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

Type Parameters:

T - the type of collection generated

All Implemented Interfaces:

Gen<T>, Shrink<T>

Direct Known Subclasses:

ListGenerator, SetGenerator

public abstract class CollectionGenerator<T extends Collection>
extends ComponentizedGenerator<T>

Base class for generators of Collections.

The generated collection has a number of elements limited by GenerationStatus.size(), or else by the attributes of a Size marking. The individual elements will have a type corresponding to the collection's type argument.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	configure(Distinct distinct) Tells this generator to add elements which are distinct from each other.
void	configure(Size size) Tells this generator to add elements to the generated collection 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()

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

addComponentGenerators, 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

CollectionGenerator

protected CollectionGenerator(Class<T> type)

Method Detail

configure

public void configure(Size size)

Tells this generator to add elements to the generated collection a number of times within a specified minimum and/or maximum, inclusive, chosen with uniform distribution.

Note that some kinds of collections disallow duplicates, so the number of elements added may not be equal to the collection's Collection.size().

Parameters:

size - annotation that gives the size constraints

configure

public void configure(Distinct distinct)

Tells this generator to add elements which are distinct from each other.

Parameters:

distinct - Generated elements 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 Collection>

numberOfNeededComponents

public int numberOfNeededComponents()

Overrides:

numberOfNeededComponents in class Generator<T extends Collection>

magnitude

public BigDecimal magnitude(Object value)

Overrides:

magnitude in class Generator<T extends Collection>

empty

protected final T empty()