Package dev.orne.test.rnd.params

Interface NumberParameters

All Superinterfaces:
GenerationParameters
All Known Subinterfaces:
NumberParameters.Builder
All Known Implementing Classes:
NumberParametersImpl
@API(status=EXPERIMENTAL, since="0.1") public interface NumberParameters extends GenerationParameters
Interface for number generation parameters.

Depending of the target number type to be generated the minimum of the parameters minimum value and the number type's minimum value will be used. Same way the maximum of the parameters maximum value and the number type's maximum value will be used.

Since:
0.1
Version:
1.0, 2022-11
Author:
(w) Iker Hernaez

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    NumberParameters.Builder
    Interface for NumberParameters builders.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Number
    DEFAULT_MAX
    The default maximum value.
    static final Number
    DEFAULT_MIN
    The default minimum value.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Number
    getMax()
    Returns the maximum (inclusive) value.
    @NotNull Number
    getMin()
    Returns the minimum (inclusive) value.
    void
    setMax(@NotNull Number value)
    Sets the maximum (inclusive) value.
    void
    setMin(@NotNull Number value)
    Sets the minimum (inclusive) value.

  • Field Details

    • DEFAULT_MIN

      static final Number DEFAULT_MIN
      The default minimum value.

    • DEFAULT_MAX

      static final Number DEFAULT_MAX
      The default maximum value.

  • Method Details

    • getMin

      @NotNull @NotNull Number getMin()
      Returns the minimum (inclusive) value.
      Returns:
      The minimum value.

    • setMin

      void setMin(@NotNull @NotNull Number value)
      Sets the minimum (inclusive) value.
      Parameters:
      value - The minimum value.

    • getMax

      @NotNull @NotNull Number getMax()
      Returns the maximum (inclusive) value.
      Returns:
      The maximum value.

    • setMax

      void setMax(@NotNull @NotNull Number value)
      Sets the maximum (inclusive) value.
      Parameters:
      value - The maximum value.