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

Class PAreaSizeL<S>

java.lang.Object
com.io7m.jregions.core.parameterized.sizes.PAreaSizeL<S>
Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
All Implemented Interfaces:
PAreaSizeLType<S>, AreaSizeValuesLType
public final class PAreaSizeL<S>
extends java.lang.Object
implements PAreaSizeLType<S>
The size of an area with long coordinates.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  PAreaSizeL.Builder<S>
    Builds instances of type PAreaSizeL.

  • Method Summary

    Modifier and Type Method Description
    static <S> PAreaSizeL.Builder<S> builder()
    Creates a builder for PAreaSizeL.
    static <S> PAreaSizeL<S> copyOf​(PAreaSizeLType<S> instance)
    Creates an immutable copy of a PAreaSizeLType value.
    boolean equals​(java.lang.Object another)
    This instance is equal to all instances of PAreaSizeL that have equal attribute values.
    int hashCode()
    Computes a hash code from attributes: sizeX, sizeY.
    long height()
    Deprecated.
    Use sizeY()
    static <S> PAreaSizeL<S> of​(long sizeX, long sizeY)
    Construct a new immutable PAreaSizeL instance.
    long sizeX()  
    long sizeY()  
    java.lang.String toString()
    Prints the immutable value PAreaSizeL with attribute values.
    long width()
    Deprecated.
    Use sizeX()
    PAreaSizeL<S> withSizeX​(long value)
    Copy the current immutable object by setting a value for the sizeX attribute.
    PAreaSizeL<S> withSizeY​(long value)
    Copy the current immutable object by setting a value for the sizeY attribute.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • width

      @Deprecated public long width()
      Deprecated.
      Use sizeX()
      Specified by:
      width in interface AreaSizeValuesLType
      Returns:
      The width of the area

    • height

      @Deprecated public long height()
      Deprecated.
      Use sizeY()
      Specified by:
      height in interface AreaSizeValuesLType
      Returns:
      The height of the area

    • sizeX

      public long sizeX()
      Specified by:
      sizeX in interface AreaSizeValuesLType
      Specified by:
      sizeX in interface PAreaSizeLType<S>
      Returns:
      The value of the sizeX attribute

    • sizeY

      public long sizeY()
      Specified by:
      sizeY in interface AreaSizeValuesLType
      Specified by:
      sizeY in interface PAreaSizeLType<S>
      Returns:
      The value of the sizeY attribute

    • withSizeX

      public final PAreaSizeL<S> withSizeX​(long value)
      Copy the current immutable object by setting a value for the sizeX attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for sizeX
      Returns:
      A modified copy of the this object

    • withSizeY

      public final PAreaSizeL<S> withSizeY​(long value)
      Copy the current immutable object by setting a value for the sizeY attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for sizeY
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of PAreaSizeL that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: sizeX, sizeY.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

      public java.lang.String toString()
      Prints the immutable value PAreaSizeL with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

      public static <S> PAreaSizeL<S> of​(long sizeX, long sizeY)
      Construct a new immutable PAreaSizeL instance.
      Type Parameters:
      S - generic parameter S
      Parameters:
      sizeX - The value for the sizeX attribute
      sizeY - The value for the sizeY attribute
      Returns:
      An immutable PAreaSizeL instance

    • copyOf

      public static <S> PAreaSizeL<S> copyOf​(PAreaSizeLType<S> instance)
      Creates an immutable copy of a PAreaSizeLType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Type Parameters:
      S - generic parameter S
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable PAreaSizeL instance

    • builder

      public static <S> PAreaSizeL.Builder<S> builder()
      Creates a builder for PAreaSizeL. 
       PAreaSizeL.&lt;S&gt;builder()
    .setSizeX(long) // required sizeX
    .setSizeY(long) // required sizeY
    .build();
      Type Parameters:
      S - generic parameter S
      Returns:
      A new PAreaSizeL builder