Package com.io7m.jregions.core.parameterized.volumes

Class PVolumeXYZSplitBI<S,​T extends PVolumeBIType<S>>

java.lang.Object
com.io7m.jregions.core.parameterized.volumes.PVolumeXYZSplitBI<S,​T>
Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
T - The precise type of volume
All Implemented Interfaces:
PVolumeXYZSplitBIType<S,​T>
public final class PVolumeXYZSplitBI<S,​T extends PVolumeBIType<S>>
extends java.lang.Object
implements PVolumeXYZSplitBIType<S,​T>
A volume that has been split into octants via an X, Y, and Z axis.

  • Method Details

    • x0y0z0

      public T x0y0z0()
      Specified by:
      x0y0z0 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The minimum X, minimum Y, minimum Z octant

    • x1y0z0

      public T x1y0z0()
      Specified by:
      x1y0z0 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The maximum X, minimum Y, minimum Z octant

    • x0y1z0

      public T x0y1z0()
      Specified by:
      x0y1z0 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The minimum X, maximum Y, minimum Z octant

    • x1y1z0

      public T x1y1z0()
      Specified by:
      x1y1z0 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The maximum X, maximum Y, minimum Z octant

    • x0y0z1

      public T x0y0z1()
      Specified by:
      x0y0z1 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The minimum X, minimum Y, maximum Z octant

    • x1y0z1

      public T x1y0z1()
      Specified by:
      x1y0z1 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The maximum X, minimum Y, maximum Z octant

    • x0y1z1

      public T x0y1z1()
      Specified by:
      x0y1z1 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The minimum X, maximum Y, maximum Z octant

    • x1y1z1

      public T x1y1z1()
      Specified by:
      x1y1z1 in interface PVolumeXYZSplitBIType<S,​T extends PVolumeBIType<S>>
      Returns:
      The maximum X, maximum Y, maximum Z octant

    • withX0y0z0

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

    • withX1y0z0

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

    • withX0y1z0

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

    • withX1y1z0

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

    • withX0y0z1

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

    • withX1y0z1

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

    • withX0y1z1

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

    • withX1y1z1

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

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of PVolumeXYZSplitBI 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: x0y0z0, x1y0z0, x0y1z0, x1y1z0, x0y0z1, x1y0z1, x0y1z1, x1y1z1.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static <S,​ T extends PVolumeBIType<S>> PVolumeXYZSplitBI<S,​T> of​(T x0y0z0, T x1y0z0, T x0y1z0, T x1y1z0, T x0y0z1, T x1y0z1, T x0y1z1, T x1y1z1)
      Construct a new immutable PVolumeXYZSplitBI instance.
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Parameters:
      x0y0z0 - The value for the x0y0z0 attribute
      x1y0z0 - The value for the x1y0z0 attribute
      x0y1z0 - The value for the x0y1z0 attribute
      x1y1z0 - The value for the x1y1z0 attribute
      x0y0z1 - The value for the x0y0z1 attribute
      x1y0z1 - The value for the x1y0z1 attribute
      x0y1z1 - The value for the x0y1z1 attribute
      x1y1z1 - The value for the x1y1z1 attribute
      Returns:
      An immutable PVolumeXYZSplitBI instance

    • copyOf

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

    • builder

      public static <S,​ T extends PVolumeBIType<S>> PVolumeXYZSplitBI.Builder<S,​T> builder()
      Creates a builder for PVolumeXYZSplitBI. 
       PVolumeXYZSplitBI.&lt;S, T&gt;builder()
    .setX0y0z0(T) // required x0y0z0
    .setX1y0z0(T) // required x1y0z0
    .setX0y1z0(T) // required x0y1z0
    .setX1y1z0(T) // required x1y1z0
    .setX0y0z1(T) // required x0y0z1
    .setX1y0z1(T) // required x1y0z1
    .setX0y1z1(T) // required x0y1z1
    .setX1y1z1(T) // required x1y1z1
    .build();
      Type Parameters:
      S - generic parameter S
      T - generic parameter T
      Returns:
      A new PVolumeXYZSplitBI builder