Package org.instancio.generator.specs

Interface FloatSpec

All Superinterfaces:

GeneratorSpec<Float>, NullableGeneratorSpec<Float>, NumberGeneratorSpec<Float>, NumberSpec<Float>, ValueSpec<Float>

All Known Implementing Classes:

FloatGenerator

public interface FloatSpec
extends NumberSpec<Float>

Spec for generating Float values.

Since:

2.6.0

Method Summary

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

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

min

FloatSpec min(Float min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<Float>

Specified by:

min in interface NumberSpec<Float>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

FloatSpec max(Float max)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<Float>

Specified by:

max in interface NumberSpec<Float>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

FloatSpec range(Float min,
 Float 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 NumberGeneratorSpec<Float>

Specified by:

range in interface NumberSpec<Float>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

FloatSpec nullable()

Description copied from interface: ValueSpec

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<Float>

Specified by:

nullable in interface NumberGeneratorSpec<Float>

Specified by:

nullable in interface NumberSpec<Float>

Specified by:

nullable in interface ValueSpec<Float>

Returns:

spec builder reference