Package org.instancio.internal.generator.lang

Class AbstractRandomComparableNumberGeneratorSpec<T extends Number & Comparable<T>>

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<T>

org.instancio.internal.generator.lang.AbstractRandomNumberGeneratorSpec<T>

org.instancio.internal.generator.lang.AbstractRandomComparableNumberGeneratorSpec<T>

All Implemented Interfaces:

AsStringGeneratorSpec<T>, Generator<T>, GeneratorSpec<T>, AsGeneratorSpec<T>, NullableGeneratorSpec<T>, NumberAsGeneratorSpec<T>, NumberGeneratorSpec<T>

Direct Known Subclasses:

BigDecimalGenerator, BigIntegerGenerator, ByteGenerator, DoubleGenerator, FloatGenerator, IntegerGenerator, LongGenerator, ShortGenerator

public abstract class AbstractRandomComparableNumberGeneratorSpec<T extends Number & Comparable<T>>
extends AbstractRandomNumberGeneratorSpec<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRandomComparableNumberGeneratorSpec(GeneratorContext context, T min, T max, boolean nullable)

Method Summary

Modifier and Type	Method	Description
NumberAsGeneratorSpec<T>	max(T max)	Specifies the upper bound.
NumberAsGeneratorSpec<T>	min(T min)	Specifies the lower bound.
NumberAsGeneratorSpec<T>	range(T min, T max)	Specifies the range for the generated number.

Methods inherited from class org.instancio.internal.generator.lang.AbstractRandomNumberGeneratorSpec

generate, getMax, getMin, nullable, nullable

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

apiMethod, getContext, hints, isNullable, tryGenerateNonNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Constructor Details

AbstractRandomComparableNumberGeneratorSpec

protected AbstractRandomComparableNumberGeneratorSpec(GeneratorContext context,
 T min,
 T max,
 boolean nullable)

Method Details

min

public NumberAsGeneratorSpec<T> min(T min)

Specifies the lower bound.

If the specified min value is greater than or equal to the current max value, the max value will be updated to a value higher than the given min.

Specified by:

min in interface NumberAsGeneratorSpec<T extends Number & Comparable<T>>

Specified by:

min in interface NumberGeneratorSpec<T extends Number & Comparable<T>>

Overrides:

min in class AbstractRandomNumberGeneratorSpec<T extends Number & Comparable<T>>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public NumberAsGeneratorSpec<T> max(T max)

Specifies the upper bound.

If the specified max value is less than or equal to the current min value, the min value will be updated to a value lower than the given max.

Specified by:

max in interface NumberAsGeneratorSpec<T extends Number & Comparable<T>>

Specified by:

max in interface NumberGeneratorSpec<T extends Number & Comparable<T>>

Overrides:

max in class AbstractRandomNumberGeneratorSpec<T extends Number & Comparable<T>>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

public NumberAsGeneratorSpec<T> range(T min,
 T max)

Description copied from interface: NumberGeneratorSpec

Specifies the range for the generated number.

This method can be invoked multiple times to specify several ranges, for example, the following will generate a random value within [10-15] or [20-25]:

   ints().range(10, 15).range(20, 25)
 

Note: this method has higher precedence than NumberGeneratorSpec.min(Number) and NumberGeneratorSpec.max(Number). For example, the following will generate a number within [1, 5]:

   ints().range(1, 5).min(95).max(99)
 

Specified by:

range in interface NumberAsGeneratorSpec<T extends Number & Comparable<T>>

Specified by:

range in interface NumberGeneratorSpec<T extends Number & Comparable<T>>

Overrides:

range in class AbstractRandomNumberGeneratorSpec<T extends Number & Comparable<T>>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder