com.io7m.jregions.core.unparameterized.sizes

## Class AreaSizeI

- java.lang.Object
- - com.io7m.jregions.core.unparameterized.sizes.AreaSizeI

- All Implemented Interfaces:
    AreaSizeIType, AreaSizeValuesIType

      @Generated(value={"Immutables.generator","AreaSizeIType"})
      public final class AreaSizeI
      extends Object
      implements AreaSizeIType

  The size of an area with `int` coordinates.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AreaSizeI.Builder` Builds instances of type `AreaSizeI`.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static AreaSizeI.Builder` | `builder()` Creates a builder for `AreaSizeI`.
    `boolean` | `equals(Object another)` This instance is equal to all instances of `AreaSizeI` that have equal attribute values.
    `int` | `hashCode()` Computes a hash code from attributes: `width`, `height`.
    `int` | `height()`
    `static AreaSizeI` | `of(int width, int height)` Construct a new immutable `AreaSizeI` instance.
    `String` | `toString()` Prints the immutable value `AreaSizeI` with attribute values.
    `int` | `width()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Method Detail

    - #### width

          public int width()

      Specified by:
        `width` in interface `AreaSizeIType`
      Specified by:
        `width` in interface `AreaSizeValuesIType`
      Returns:
        The value of the `width` attribute

    - #### height

          public int height()

      Specified by:
        `height` in interface `AreaSizeIType`
      Specified by:
        `height` in interface `AreaSizeValuesIType`
      Returns:
        The value of the `height` attribute

    - #### equals

          public boolean equals(Object another)

      This instance is equal to all instances of `AreaSizeI` that have equal attribute values.
      Overrides:
        `equals` in class `Object`
      Returns:
        `true` if `this` is equal to `another` instance

    - #### hashCode

          public int hashCode()

      Computes a hash code from attributes: `width`, `height`.
      Overrides:
        `hashCode` in class `Object`
      Returns:
        hashCode value

    - #### toString

          public String toString()

      Prints the immutable value `AreaSizeI` with attribute values.
      Overrides:
        `toString` in class `Object`
      Returns:
        A string representation of the value

    - #### of

          public static AreaSizeI of(int width,
                                     int height)

      Construct a new immutable `AreaSizeI` instance.
      Parameters:
        `width` - The value for the `width` attribute
        `height` - The value for the `height` attribute
      Returns:
        An immutable AreaSizeI instance

    - #### builder

          public static AreaSizeI.Builder builder()

      Creates a builder for `AreaSizeI`.
      Returns:
        A new AreaSizeI builder

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