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

Class PropertiesGenerator

java.lang.Object

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

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

All Implemented Interfaces:

Gen<Properties>, Shrink<Properties>

public class PropertiesGenerator
extends Generator<Properties>

Produces values of type Properties.

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractStringGenerator	stringGenerator

Constructor Summary

Constructors

Constructor	Description
PropertiesGenerator()

Method Summary

Modifier and Type	Method	Description
boolean	canRegisterAsType(Class<?> type)	Tells whether this generator is allowed to be used for property parameters of the given type.
void	configure(Encoded.InCharset charset)
Properties	generate(SourceOfRandomness random, GenerationStatus status)	Generates a value, possibly influenced by a source of randomness and metadata about the generation.
BigDecimal	magnitude(Object value)	Gives a hint to the shrinking process as to the magnitude of the given value.

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

addComponentGenerators, canGenerateForParametersOfTypes, canShrink, compatibleWithTypeParameter, configurationAnnotationsOn, configure, configure, copy, doShrink, gen, gen, hasComponents, narrow, numberOfNeededComponents, provide, 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, map, times

Field Details

stringGenerator

private AbstractStringGenerator stringGenerator

Constructor Details

PropertiesGenerator

public PropertiesGenerator()

Method Details

configure

public void configure(Encoded.InCharset charset)

generate

public Properties 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

canRegisterAsType

public boolean canRegisterAsType(Class<?> type)

Description copied from class: Generator

Tells whether this generator is allowed to be used for property parameters of the given type.

Overrides:

canRegisterAsType in class Generator<Properties>

Parameters:

type - type against which to test this generator

Returns:

true if the generator is allowed to participate in generating values for property parameters of type

magnitude

public BigDecimal magnitude(Object value)

Description copied from class: Generator

Gives a hint to the shrinking process as to the magnitude of the given value. The shrinking process will prefer trying values of greater magnitude before values of lesser magnitude. If not overridden, this implementation returns "one".

Note to generator writers: Do not worry about normalizing a magnitude to a positive value; the shrinking mechanism will take care of it.

Overrides:

magnitude in class Generator<Properties>

Parameters:

value - the value to assess

Returns:

a measure of the given value's magnitude

See Also:

• Generator.narrow(Object)