Package com.io7m.jregions.core.parameterized.sizes

# Interface PAreaSizeBDType<S>

Type Parameters:
  `S` - A phantom type parameter indicating the coordinate space of the area

All Superinterfaces:
  `AreaSizeValuesBDType`

All Known Implementing Classes:
  `PAreaSizeBD`

@Immutable public interface PAreaSizeBDType<S> extends AreaSizeValuesBDType
The size of an area with `BigDecimal` coordinates.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Interface
  Description
  `static class`
  `PAreaSizeBDType.Builder<S>`
  A builder for size values.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `default void`
  `checkPreconditions()`
  Check preconditions for the type.
  `BigDecimal`
  `sizeX()`
  `BigDecimal`
  `sizeY()`

  ### Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeValuesBDType

  `height, width`

- ## Method Details

  - ### sizeX

    @Parameter(order=0) BigDecimal sizeX()
    Specified by:
      `sizeX` in interface `AreaSizeValuesBDType`
    Returns:
      The size of the area on the X axis

  - ### sizeY

    @Parameter(order=1) BigDecimal sizeY()
    Specified by:
      `sizeY` in interface `AreaSizeValuesBDType`
    Returns:
      The size of the area on the Y axis

  - ### checkPreconditions

    @Check default void checkPreconditions()
    Check preconditions for the type.