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

# Interface PAreaSizeBIType<S>

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

All Superinterfaces:
  `AreaSizeValuesBIType`

All Known Implementing Classes:
  `PAreaSizeBI`

    @Immutable
    public interface PAreaSizeBIType<S>
    extends AreaSizeValuesBIType

The size of an area with `BigInteger` coordinates.

- ## Nested Class Summary

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

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `default void` | `checkPreconditions()` | Check preconditions for the type.
  `java.math.BigInteger` | `sizeX()` |
  `java.math.BigInteger` | `sizeY()` |

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

  `height, width`

- ## Method Details

  - ### sizeX

    @Parameter(order=0) java.math.BigInteger sizeX()
    Specified by:
      `sizeX` in interface `AreaSizeValuesBIType`
    Returns:
      The size of the area on the X axis

  - ### sizeY

    @Parameter(order=1) java.math.BigInteger sizeY()
    Specified by:
      `sizeY` in interface `AreaSizeValuesBIType`
    Returns:
      The size of the area on the Y axis

  - ### checkPreconditions

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