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

Class PAreaXYSplitBI<S,T extends PAreaBIType<S>>

java.lang.Object
com.io7m.jregions.core.parameterized.areas.PAreaXYSplitBI<S,T>
Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
T - The precise type of area
All Implemented Interfaces:
PAreaXYSplitBIType<S,T>
public final class PAreaXYSplitBI<S,T extends PAreaBIType<S>> extends Object implements PAreaXYSplitBIType<S,T>
An area that has been split into quadrants via an X and Y axis.

  • Method Details

    • x0y0

      public T x0y0()
      Specified by:
      x0y0 in interface PAreaXYSplitBIType<S,T extends PAreaBIType<S>>
      Returns:
      The minimum X, minimum Y quadrant

    • x1y0

      public T x1y0()
      Specified by:
      x1y0 in interface PAreaXYSplitBIType<S,T extends PAreaBIType<S>>
      Returns:
      The maximum X, minimum Y quadrant

    • x0y1

      public T x0y1()
      Specified by:
      x0y1 in interface PAreaXYSplitBIType<S,T extends PAreaBIType<S>>
      Returns:
      The minimum X, maximum Y quadrant

    • x1y1

      public T x1y1()
      Specified by:
      x1y1 in interface PAreaXYSplitBIType<S,T extends PAreaBIType<S>>
      Returns:
      The maximum X, maximum Y quadrant

    • withX0y0

      public final PAreaXYSplitBI<S,T> withX0y0(T value)
      Copy the current immutable object by setting a value for the x0y0 attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x0y0
      Returns:
      A modified copy of the this object

    • withX1y0

      public final PAreaXYSplitBI<S,T> withX1y0(T value)
      Copy the current immutable object by setting a value for the x1y0 attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x1y0
      Returns:
      A modified copy of the this object

    • withX0y1

      public final PAreaXYSplitBI<S,T> withX0y1(T value)
      Copy the current immutable object by setting a value for the x0y1 attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x0y1
      Returns:
      A modified copy of the this object

    • withX1y1

      public final PAreaXYSplitBI<S,T> withX1y1(T value)
      Copy the current immutable object by setting a value for the x1y1 attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x1y1
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of PAreaXYSplitBI 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: x0y0, x1y0, x0y1, x1y1.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static <S, T extends PAreaBIType<S>> PAreaXYSplitBI<S,T> of(T x0y0, T x1y0, T x0y1, T x1y1)
      Construct a new immutable PAreaXYSplitBI instance.
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Parameters:
      x0y0 - The value for the x0y0 attribute
      x1y0 - The value for the x1y0 attribute
      x0y1 - The value for the x0y1 attribute
      x1y1 - The value for the x1y1 attribute
      Returns:
      An immutable PAreaXYSplitBI instance

    • copyOf

      public static <S, T extends PAreaBIType<S>> PAreaXYSplitBI<S,T> copyOf(PAreaXYSplitBIType<S,T> instance)
      Creates an immutable copy of a PAreaXYSplitBIType 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
      T - generic parameter T
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable PAreaXYSplitBI instance

    • builder

      public static <S, T extends PAreaBIType<S>> PAreaXYSplitBI.Builder<S,T> builder()
      Creates a builder for PAreaXYSplitBI. 
       PAreaXYSplitBI.&lt;S, T&gt;builder()
    .setX0y0(T) // required x0y0
    .setX1y0(T) // required x1y0
    .setX0y1(T) // required x0y1
    .setX1y1(T) // required x1y1
    .build();
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Returns:
      A new PAreaXYSplitBI builder