com.pholser.junit.quickcheck.generator

Class Fields<T>

java.lang.Object

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

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

Type Parameters:

T - the type of objects generated

All Implemented Interfaces:

Gen<T>, Shrink<T>

public class Fields<T>
extends Generator<T>

Produces instances of a class by reflecting the class's fields and generating random values for them.

All fields of the class and its class hierarchy are auto-generated.

In order for this generator to work, the type it is given must have an accessible zero-arg constructor.

If a field is marked with an annotation that influences the generation of a given kind of value, that annotation will be applied to the generation of values for that field.

This generator is intended to be used with From, and not to be available via the ServiceLoader mechanism.

Constructor Summary

Constructors

Constructor and Description
Fields(Class<T> type)

Method Summary

Modifier and Type	Method and Description
void	configure(AnnotatedType annotatedType) Configures this generator using annotations from a given annotated type.
Generator<T>	copy() Used by the framework to make a copy of the receiver.
T	generate(SourceOfRandomness random, GenerationStatus status) Generates a value, possibly influenced by a source of randomness and metadata about the generation.
void	provide(Generators provided) Supplies the available generators to this one.

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

addComponentGenerators, canGenerateForParametersOfTypes, canRegisterAsType, canShrink, compatibleWithTypeParameter, configurationAnnotationsOn, configure, doShrink, gen, gen, hasComponents, magnitude, narrow, numberOfNeededComponents, 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

Fields

public Fields(Class<T> type)

Parameters:

type - the type of objects to be generated

Method Detail

generate

public T generate(SourceOfRandomness random,
                  GenerationStatus status)

Description copied from interface: Gen

Generates a value, possibly influenced by a source of randomness and metadata about the generation.

Parameters:

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

status - an object that can be used to influence the generated value. For example, generating lists can use the size method to generate lists with a given number of elements.

Returns:

the generated value

provide

public void provide(Generators provided)

Description copied from class: Generator

Supplies the available generators to this one.

This is intended for use only by junit-quickcheck itself, and not by creators of custom generators.

Overrides:

provide in class Generator<T>

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<T>

Parameters:

annotatedType - a type usage

copy

public Generator<T> copy()

Description copied from class: Generator

Used by the framework to make a copy of the receiver.

Overrides:

copy in class Generator<T>

Returns:

a copy of the receiver