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

Class PAreaYSplitF<S,T extends PAreaFType<S>>

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

  • Method Details

    • lower

      public T lower()
      Specified by:
      lower in interface PAreaYSplitFType<S,T extends PAreaFType<S>>
      Returns:
      The lower half

    • upper

      public T upper()
      Specified by:
      upper in interface PAreaYSplitFType<S,T extends PAreaFType<S>>
      Returns:
      The upper half

    • withLower

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

    • toString

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

    • of

      public static <S, T extends PAreaFType<S>> PAreaYSplitF<S,T> of(T lower, T upper)
      Construct a new immutable PAreaYSplitF 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 PAreaYSplitF instance

    • copyOf

      public static <S, T extends PAreaFType<S>> PAreaYSplitF<S,T> copyOf(PAreaYSplitFType<S,T> instance)
      Creates an immutable copy of a PAreaYSplitFType 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 PAreaYSplitF instance

    • builder

      public static <S, T extends PAreaFType<S>> PAreaYSplitF.Builder<S,T> builder()
      Creates a builder for PAreaYSplitF. 
       PAreaYSplitF.&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 PAreaYSplitF builder