com.pholser.junit.quickcheck.generator

Class DecimalGenerator<T extends Number>

java.lang.Object

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

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

Type Parameters:

T - type of values this generator produces

All Implemented Interfaces:

Gen<T>, Shrink<T>

Direct Known Subclasses:

BigDecimalGenerator, DoubleGenerator, FloatGenerator

public abstract class DecimalGenerator<T extends Number>
extends Generator<T>

Base class for generators of decimal types, such as double and BigDecimal. All numbers are converted to/from BigDecimal for processing.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DecimalGenerator(Class<T> type)
protected	DecimalGenerator(List<Class<T>> types)

Method Summary

Modifier and Type	Method and Description
List<T>	doShrink(SourceOfRandomness random, T largestGeneric)
protected abstract Predicate<T>	inRange()
protected abstract T	leastMagnitude()
protected abstract Function<BigDecimal,T>	narrow()
protected abstract T	negate(T target) Used when shrinking negative numbers to add the positive equivalent value at the top of shrinks list.
protected abstract boolean	negative(T target)
protected abstract Function<T,BigDecimal>	widen()

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

addComponentGenerators, canGenerateForParametersOfTypes, canRegisterAsType, canShrink, compatibleWithTypeParameter, configurationAnnotationsOn, configure, configure, copy, gen, gen, hasComponents, magnitude, 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, freq, frequency, generate, map, oneOf, oneOf, pure, times

Constructor Detail

DecimalGenerator

protected DecimalGenerator(Class<T> type)

DecimalGenerator

protected DecimalGenerator(List<Class<T>> types)

Method Detail

doShrink

public List<T> doShrink(SourceOfRandomness random,
                        T largestGeneric)

Overrides:

doShrink in class Generator<T extends Number>

widen

protected abstract Function<T,BigDecimal> widen()

Returns:

a function converting a value of the base type into a BigDecimal.

narrow

protected abstract Function<BigDecimal,T> narrow()

Returns:

a function converting a BigDecimal into the equivalent value in the base type.

inRange

protected abstract Predicate<T> inRange()

Returns:

a predicate checking whether its input is in the configured range.

leastMagnitude

protected abstract T leastMagnitude()

Returns:

the lowest magnitude number, respecting the configured range. The ideal shrink value is always this value (i.e. this value cannot be shrunk any further).

negative

protected abstract boolean negative(T target)

Returns:

whether the given number is negative or not.

negate

protected abstract T negate(T target)

Used when shrinking negative numbers to add the positive equivalent value at the top of shrinks list.

Parameters:

target - always a negative number

Returns:

the positive equivalent to target