Package com.io7m.jregions.core.parameterized.areas

Class PAreaL<S>

java.lang.Object
com.io7m.jregions.core.parameterized.areas.PAreaL<S>
Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
All Implemented Interfaces:
PAreaLType<S>, AreaValuesLType, AreaSizeValuesLType
public final class PAreaL<S>
extends java.lang.Object
implements PAreaLType<S>

An area with long coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y axis.

  • Nested Class Summary

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

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.io7m.jregions.core.parameterized.areas.PAreaLType

    checkPreconditions

  • 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 AreaValuesLType
      Returns:
      The computed-at-construction value of the sizeX attribute

    • sizeY

      public long sizeY()
      Specified by:
      sizeY in interface AreaSizeValuesLType
      Specified by:
      sizeY in interface AreaValuesLType
      Returns:
      The computed-at-construction value of the sizeY attribute

    • minimumX

      public long minimumX()
      Specified by:
      minimumX in interface AreaValuesLType
      Specified by:
      minimumX in interface PAreaLType<S>
      Returns:
      The value of the minimumX attribute

    • maximumX

      public long maximumX()
      Specified by:
      maximumX in interface AreaValuesLType
      Specified by:
      maximumX in interface PAreaLType<S>
      Returns:
      The value of the maximumX attribute

    • minimumY

      public long minimumY()
      Specified by:
      minimumY in interface AreaValuesLType
      Specified by:
      minimumY in interface PAreaLType<S>
      Returns:
      The value of the minimumY attribute

    • maximumY

      public long maximumY()
      Specified by:
      maximumY in interface AreaValuesLType
      Specified by:
      maximumY in interface PAreaLType<S>
      Returns:
      The value of the maximumY attribute

    • withMinimumX

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

    • withMaximumX

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

    • withMinimumY

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

    • withMaximumY

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

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of PAreaL 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: minimumX, maximumX, minimumY, maximumY.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static <S> PAreaL<S> of​(long minimumX, long maximumX, long minimumY, long maximumY)
      Construct a new immutable PAreaL instance.
      Type Parameters:
      S - generic parameter S
      Parameters:
      minimumX - The value for the minimumX attribute
      maximumX - The value for the maximumX attribute
      minimumY - The value for the minimumY attribute
      maximumY - The value for the maximumY attribute
      Returns:
      An immutable PAreaL instance

    • copyOf

      public static <S> PAreaL<S> copyOf​(PAreaLType<S> instance)
      Creates an immutable copy of a PAreaLType 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 PAreaL instance

    • builder

      public static <S> PAreaL.Builder<S> builder()
      Creates a builder for PAreaL. 
       PAreaL.&lt;S&gt;builder()
    .setMinimumX(long) // required minimumX
    .setMaximumX(long) // required maximumX
    .setMinimumY(long) // required minimumY
    .setMaximumY(long) // required maximumY
    .build();
      Type Parameters:
      S - generic parameter S
      Returns:
      A new PAreaL builder