Package org.instancio.generator.specs

Interface ShortSpec

All Superinterfaces:

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

public interface ShortSpec
extends NumberSpec<Short>

Spec for generating Short values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
ShortSpec	max(Short max)	Specifies the upper bound.
ShortSpec	min(Short min)	Specifies the lower bound.
ShortSpec	nullable()	Specifies that a null value can be generated
ShortSpec	range(Short min, Short 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

ShortSpec min(Short min)

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<Short>

Specified by:

min in interface NumberSpec<Short>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

2.6.0

max

ShortSpec max(Short max)

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<Short>

Specified by:

max in interface NumberSpec<Short>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

2.6.0

range

ShortSpec range(Short min,
 Short 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<Short>

Specified by:

range in interface NumberSpec<Short>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

Since:

2.6.0

nullable

ShortSpec nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<Short>

Specified by:

nullable in interface NumberGeneratorSpec<Short>

Specified by:

nullable in interface NumberSpec<Short>

Specified by:

nullable in interface ValueSpec<Short>

Returns:

spec builder reference

Since:

2.6.0