Module com.io7m.jregions.core
Package com.io7m.jregions.core.unparameterized.sizes

## Interface AreaSizeBIType

- All Superinterfaces:
    `AreaSizeValuesBIType`
  All Known Implementing Classes:
    `AreaSizeBI`

      @Immutable
      public interface AreaSizeBIType
      extends AreaSizeValuesBIType

  The size of an area with `BigInteger` coordinates.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface | Description
    --- | --- | ---
    `static class` | `AreaSizeBIType.Builder` | A builder for size values.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    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 Detail

    - #### 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.

Copyright © 2017 <code@io7m.com> http://io7m.com