com.pholser.junit.quickcheck.internal.generator

Class CompositeGenerator

java.lang.Object

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

com.pholser.junit.quickcheck.internal.generator.CompositeGenerator

All Implemented Interfaces:

Shrink<Object>

public class CompositeGenerator
extends Generator<Object>

Constructor Summary

Constructors

Constructor and Description
CompositeGenerator(List<Weighted<Generator<?>>> composed)

Method Summary

Modifier and Type	Method and Description
boolean	canShrink(Object larger) Tells whether this generator is allowed to participate in the Shrink process for the given "larger" value.
Generator<?>	composed(int index)
void	configure(AnnotatedElement element)
void	configure(AnnotatedType annotatedType) Configures this generator using annotations from a given annotated type.
List<Object>	doShrink(SourceOfRandomness random, Object larger) Gives some objects that are "smaller" than a given "larger" object.
Object	generate(SourceOfRandomness random, GenerationStatus status) Produces a value for a property parameter.
int	numberOfComposedGenerators()
void	provideRepository(GeneratorRepository provided) Used to supply the available generators to this one.

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

addComponentGenerators, canGenerateForParametersOfTypes, canRegisterAsType, compatibleWithTypeParameter, configurationAnnotationsOn, hasComponents, narrow, numberOfNeededComponents, shrink, types

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeGenerator

public CompositeGenerator(List<Weighted<Generator<?>>> composed)

Method Detail

generate

public Object generate(SourceOfRandomness random,
                       GenerationStatus status)

Description copied from class: Generator

Produces a value for a property parameter.

A generator may raise an unchecked exception if some condition exists which would lead to a confusing generation -- for example, if a generator honored a "range" configuration, and the endpoints were transposed.

Specified by:

generate in class Generator<Object>

Parameters:

random - source of randomness to be used when generating the value

status - an object that the generator can use to influence the value it produces. For example, a generator for lists can use the size method to generate lists with a given number of elements.

Returns:

the generated value

canShrink

public boolean canShrink(Object larger)

Description copied from class: Generator

Tells whether this generator is allowed to participate in the Shrink process for the given "larger" value.

Unless overridden, the only criterion for whether a generator is allowed to participate in shrinking a value is if the value can be safely cast to the type of values the generator produces.

Overrides:

canShrink in class Generator<Object>

Parameters:

larger - the "larger" value

Returns:

whether this generator can participate in "shrinking" the larger value

doShrink

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

Description copied from class: Generator

Gives some objects that are "smaller" than a given "larger" object.

Unless overridden, a generator will produce an empty list of "smaller" values.

Overrides:

doShrink in class Generator<Object>

Parameters:

random - source of randomness to use in shrinking, if desired

larger - the larger object

Returns:

objects that are "smaller" than the larger object

composed

public Generator<?> composed(int index)

numberOfComposedGenerators

public int numberOfComposedGenerators()

provideRepository

public void provideRepository(GeneratorRepository provided)

Description copied from class: Generator

Used to supply the available generators to this one.

Overrides:

provideRepository in class Generator<Object>

Parameters:

provided - repository of available generators

configure

public void configure(AnnotatedType annotatedType)

Description copied from class: Generator

Configures this generator using annotations from a given annotated type.

This method considers only annotations that are themselves marked with GeneratorConfiguration.

By default, the generator will configure itself using this procedure:

• For each of the given annotations:
  • Find a public method on the generator named configure, that accepts a single parameter of the annotation type
  • Invoke the configure method reflectively, passing the annotation as the argument

Overrides:

configure in class Generator<Object>

Parameters:

annotatedType - a type usage

configure

public void configure(AnnotatedElement element)

Overrides:

configure in class Generator<Object>

Parameters:

element - an annotated program element

See Also:

this issue