Interface BigDecimalArbitrary

All Superinterfaces:
Arbitrary<BigDecimal>, NumericalArbitrary<BigDecimal,BigDecimalArbitrary>

@API(status=MAINTAINED, since="1.0") public interface BigDecimalArbitrary extends NumericalArbitrary<BigDecimal,BigDecimalArbitrary>
Fluent interface to configure the generation of BigDecimal values.
  • Method Details

    • between

      default BigDecimalArbitrary between(BigDecimal min, BigDecimal max)
      Set the allowed lower min (included) and upper max (included) border of generated numbers.
      Parameters:
      min - The lower border of possible values
      max - The upper border of possible values
      Returns:
      new instance of arbitrary
    • between

      @API(status=MAINTAINED, since="1.2.7") BigDecimalArbitrary between(BigDecimal min, boolean minIncluded, BigDecimal max, boolean maxIncluded)
      Set the allowed lower min (included) and upper max (included) border of generated numbers. Specify if borders should be included in allowed values or not.
      Parameters:
      min - The lower border of possible values
      minIncluded - Should the lower border be included
      max - The upper border of possible values
      maxIncluded - Should the upper border be included
      Returns:
      new instance of arbitrary
    • greaterOrEqual

      BigDecimalArbitrary greaterOrEqual(BigDecimal min)
      Set the allowed lower min (included) border of generated numbers.
      Parameters:
      min - The lower border of possible values
      Returns:
      new instance of arbitrary
    • greaterThan

      @API(status=MAINTAINED, since="1.2.7") BigDecimalArbitrary greaterThan(BigDecimal min)
      Set the allowed lower min (excluded) border of generated numbers.
      Parameters:
      min - The lower border of possible values
      Returns:
      new instance of arbitrary
    • lessOrEqual

      BigDecimalArbitrary lessOrEqual(BigDecimal max)
      Set the allowed upper max (included) bounder of generated numbers.
      Parameters:
      max - The upper border of possible values
      Returns:
      new instance of arbitrary
    • lessThan

      @API(status=MAINTAINED, since="1.2.7") BigDecimalArbitrary lessThan(BigDecimal max)
      Set the allowed upper max (excluded) border of generated numbers.
      Parameters:
      max - The upper border of possible values
      Returns:
      new instance of arbitrary
    • ofScale

      BigDecimalArbitrary ofScale(int scale)
      Set the scale (maximum number of decimal places) to scale.
      Parameters:
      scale - number of decimal places
      Returns:
      new instance of arbitrary
    • shrinkTowards

      @API(status=MAINTAINED, since="1.4.0") BigDecimalArbitrary shrinkTowards(BigDecimal target)
      Set shrinking target to target which must be between the allowed bounds.
      Parameters:
      target - The value which is considered to be the most simple value for shrinking
      Returns:
      new instance of arbitrary