Package org.instancio.generator.specs

Interface BigIntegerSpec

All Superinterfaces:

AsGeneratorSpec<BigInteger>, GeneratorSpec<BigInteger>, NullableGeneratorSpec<BigInteger>, NumberGeneratorSpec<BigInteger>, NumberSpec<BigInteger>, Supplier<BigInteger>, ValueSpec<BigInteger>

public interface BigIntegerSpec
extends NumberSpec<BigInteger>

Spec for generating BigInteger values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
BigIntegerSpec	max(BigInteger max)	Specifies the upper bound.
BigIntegerSpec	min(BigInteger min)	Specifies the lower bound.
BigIntegerSpec	nullable()	Specifies that a null value can be generated
BigIntegerSpec	range(BigInteger min, BigInteger max)	Specifies the range for generated numbers.

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

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Method Details

min

BigIntegerSpec min(BigInteger min)

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<BigInteger>

Specified by:

min in interface NumberSpec<BigInteger>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

2.6.0

max

BigIntegerSpec max(BigInteger max)

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<BigInteger>

Specified by:

max in interface NumberSpec<BigInteger>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

2.6.0

range

BigIntegerSpec range(BigInteger min,
 BigInteger max)

Specifies the range for generated numbers.

The following examples use int, however the same principle applies to all numeric types, including BigInteger and BigDecimal.

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 NumberGeneratorSpec<BigInteger>

Specified by:

range in interface NumberSpec<BigInteger>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

Since:

2.6.0

nullable

BigIntegerSpec nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<BigInteger>

Specified by:

nullable in interface NumberGeneratorSpec<BigInteger>

Specified by:

nullable in interface NumberSpec<BigInteger>

Specified by:

nullable in interface ValueSpec<BigInteger>

Returns:

spec builder reference

Since:

2.6.0