com.pholser.junit.quickcheck.internal.generator

Class PropertyParameterGenerationContext

java.lang.Object

com.pholser.junit.quickcheck.internal.generator.PropertyParameterGenerationContext

All Implemented Interfaces:

GenerationStatus

public class PropertyParameterGenerationContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyParameterGenerationContext.DiscardRatioExceededException

Nested classes/interfaces inherited from interface com.pholser.junit.quickcheck.generator.GenerationStatus

GenerationStatus.Key<T>

Constructor Summary

Constructors

Constructor and Description
PropertyParameterGenerationContext(PropertyParameterContext parameter, GeneratorRepository repository, GeometricDistribution distro, SourceOfRandomness random, ParameterSampler sampler)

Method Summary

Modifier and Type	Method and Description
int	attempts()
long	effectiveSeed()
Object	generate()
BigDecimal	magnitude(Object value)
String	name()
protected SourceOfRandomness	random()
int	sampleSize()
void	semiAttempt() Signals part of an attempt to generate a value.
<T> GenerationStatus	setValue(GenerationStatus.Key<T> key, T value) Associates the given value with the given key for the duration of the generation of a value for a property parameter, or until overwritten.
List<Object>	shrink(Object larger)
int	size()
<T> Optional<T>	valueOf(GenerationStatus.Key<T> key) Retrieves the value associated with the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyParameterGenerationContext

public PropertyParameterGenerationContext(PropertyParameterContext parameter,
                                          GeneratorRepository repository,
                                          GeometricDistribution distro,
                                          SourceOfRandomness random,
                                          ParameterSampler sampler)

Method Detail

generate

public Object generate()

shrink

public List<Object> shrink(Object larger)

size

public int size()

Specified by:

size in interface GenerationStatus

Returns:

an arbitrary "size" parameter; this value (probabilistically) increases for every successful generation

attempts

public int attempts()

Returns:

how many attempts have been made to generate a value for a property parameter

semiAttempt

public void semiAttempt()

Description copied from interface: GenerationStatus

Signals part of an attempt to generate a value.

Mostly for use by junit-quickcheck itself; generators can call this to convince the framework that it's doing work to generate a complex value, but doing so is not strictly necessary.

effectiveSeed

public long effectiveSeed()

sampleSize

public int sampleSize()

name

public String name()

magnitude

public BigDecimal magnitude(Object value)

setValue

public <T> GenerationStatus setValue(GenerationStatus.Key<T> key,
                                     T value)

Description copied from interface: GenerationStatus

Associates the given value with the given key for the duration of the generation of a value for a property parameter, or until overwritten.

Specified by:

setValue in interface GenerationStatus

Type Parameters:

T - type of the value

Parameters:

key - a key to associate with a value

value - the associated value

Returns:

self, so that calls to this method can be chained

valueOf

public <T> Optional<T> valueOf(GenerationStatus.Key<T> key)

Description copied from interface: GenerationStatus

Retrieves the value associated with the given key.

Specified by:

valueOf in interface GenerationStatus

Type Parameters:

T - type of the value associated with the key

Parameters:

key - key to look up

Returns:

the (optional) associated value

random

protected final SourceOfRandomness random()