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

Class PAreaXSplitF<S,​T extends PAreaFType<S>>

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

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  PAreaXSplitF.Builder<S,​T extends PAreaFType<S>>
    Builds instances of type PAreaXSplitF.

  • Method Summary

    Modifier and Type Method Description
    static <S,​ T extends PAreaFType<S>>
    PAreaXSplitF.Builder<S,​T>    		 builder()
    Creates a builder for PAreaXSplitF.
    static <S,​ T extends PAreaFType<S>>
    PAreaXSplitF<S,​T>    		 copyOf​(PAreaXSplitFType<S,​T> instance)
    Creates an immutable copy of a PAreaXSplitFType value.
    boolean equals​(java.lang.Object another)
    This instance is equal to all instances of PAreaXSplitF that have equal attribute values.
    int hashCode()
    Computes a hash code from attributes: lower, upper.
    T lower()  
    static <S,​ T extends PAreaFType<S>>
    PAreaXSplitF<S,​T>    		 of​(T lower, T upper)
    Construct a new immutable PAreaXSplitF instance.
    java.lang.String toString()
    Prints the immutable value PAreaXSplitF with attribute values.
    T upper()  
    PAreaXSplitF<S,​T> withLower​(T value)
    Copy the current immutable object by setting a value for the lower attribute.
    PAreaXSplitF<S,​T> withUpper​(T value)
    Copy the current immutable object by setting a value for the upper attribute.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • lower

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

    • upper

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

    • withLower

      public final PAreaXSplitF<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 PAreaXSplitF<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 PAreaXSplitF 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 PAreaXSplitF with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

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

    • copyOf

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

    • builder

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