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

Class PAreaXSplitBI<S,​T extends PAreaBIType<S>>

java.lang.Object
com.io7m.jregions.core.parameterized.areas.PAreaXSplitBI<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:
PAreaXSplitBIType<S,​T>
public final class PAreaXSplitBI<S,​T extends PAreaBIType<S>>
extends java.lang.Object
implements PAreaXSplitBIType<S,​T>
An area that has been split via the X axis.

  • Method Details

    • lower

      public T lower()
      Specified by:
      lower in interface PAreaXSplitBIType<S,​T extends PAreaBIType<S>>
      Returns:
      The lower half

    • upper

      public T upper()
      Specified by:
      upper in interface PAreaXSplitBIType<S,​T extends PAreaBIType<S>>
      Returns:
      The upper half

    • withLower

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

    • withUpper

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

    • equals

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

    • toString

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

    • of

      public static <S,​ T extends PAreaBIType<S>> PAreaXSplitBI<S,​T> of​(T lower, T upper)
      Construct a new immutable PAreaXSplitBI instance.
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Parameters:
      lower - The value for the lower attribute
      upper - The value for the upper attribute
      Returns:
      An immutable PAreaXSplitBI instance

    • copyOf

      public static <S,​ T extends PAreaBIType<S>> PAreaXSplitBI<S,​T> copyOf​(PAreaXSplitBIType<S,​T> instance)
      Creates an immutable copy of a PAreaXSplitBIType 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 PAreaXSplitBI instance

    • builder

      public static <S,​ T extends PAreaBIType<S>> PAreaXSplitBI.Builder<S,​T> builder()
      Creates a builder for PAreaXSplitBI. 
       PAreaXSplitBI.&lt;S, T&gt;builder()
    .setLower(T) // required lower
    .setUpper(T) // required upper
    .build();
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Returns:
      A new PAreaXSplitBI builder