Package com.io7m.waxmill.machines

# Interface WXMMemoryType

All Known Implementing Classes:
  `WXMMemory`

    @Immutable
    public interface WXMMemoryType

The specification of the size of a virtual machine's memory. This is specified as a number of megabytes `m` plus a number of gigabytes `g`, where `m >= 0 ∧ g >= 0`.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `default void` | `checkPreconditions()` | Check preconditions for the type.
  `default java.lang.String` | `comment()` |
  `default java.math.BigInteger` | `gigabytes()` |
  `default java.math.BigInteger` | `megabytes()` |
  `default java.math.BigInteger` | `totalBytes()` |
  `default java.math.BigInteger` | `totalMegabytes()` |

- ## Method Details

  - ### megabytes

    @Default default java.math.BigInteger megabytes()
    Returns:
      The number of megabytes

  - ### gigabytes

    @Default default java.math.BigInteger gigabytes()
    Returns:
      The number of gigabytes

  - ### comment

    @Default default java.lang.String comment()
    Returns:
      A descriptive comment

  - ### checkPreconditions

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

  - ### totalBytes

    default java.math.BigInteger totalBytes()
    Returns:
      The total size of the memory in bytes

  - ### totalMegabytes

    default java.math.BigInteger totalMegabytes()
    Returns:
      The total size of the memory in megabytes