Package com.io7m.jregions.core.unparameterized.areas

Class AreaF

java.lang.Object
com.io7m.jregions.core.unparameterized.areas.AreaF
All Implemented Interfaces:
AreaFType, AreaValuesFType, AreaSizeValuesFType
public final class AreaF
extends java.lang.Object
implements AreaFType

An area with float coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y axis.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  AreaF.Builder
    Builds instances of type AreaF.

  • Method Summary

    Modifier and Type Method Description
    static AreaF.Builder builder()
    Creates a builder for AreaF.
    static AreaF copyOf​(AreaFType instance)
    Creates an immutable copy of a AreaFType value.
    boolean equals​(java.lang.Object another)
    This instance is equal to all instances of AreaF that have equal attribute values.
    int hashCode()
    Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY.
    float height()
    Deprecated.
    Use AreaValuesFType.sizeY()
    float maximumX()  
    float maximumY()  
    float minimumX()  
    float minimumY()  
    static AreaF of​(float minimumX, float maximumX, float minimumY, float maximumY)
    Construct a new immutable AreaF instance.
    java.lang.String toString()
    Prints the immutable value AreaF with attribute values.
    float width()
    Deprecated.
    Use AreaValuesFType.sizeX()
    AreaF withMaximumX​(float value)
    Copy the current immutable object by setting a value for the maximumX attribute.
    AreaF withMaximumY​(float value)
    Copy the current immutable object by setting a value for the maximumY attribute.
    AreaF withMinimumX​(float value)
    Copy the current immutable object by setting a value for the minimumX attribute.
    AreaF withMinimumY​(float value)
    Copy the current immutable object by setting a value for the minimumY attribute.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaFType

    checkPreconditions

    Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesFType

    sizeX, sizeY

  • Method Details

    • width

      @Deprecated public float width()
      Deprecated.
      Use AreaValuesFType.sizeX()
      Specified by:
      width in interface AreaSizeValuesFType
      Returns:
      The width of the area

    • height

      @Deprecated public float height()
      Deprecated.
      Use AreaValuesFType.sizeY()
      Specified by:
      height in interface AreaSizeValuesFType
      Returns:
      The height of the area

    • minimumX

      public float minimumX()
      Specified by:
      minimumX in interface AreaFType
      Specified by:
      minimumX in interface AreaValuesFType
      Returns:
      The value of the minimumX attribute

    • maximumX

      public float maximumX()
      Specified by:
      maximumX in interface AreaFType
      Specified by:
      maximumX in interface AreaValuesFType
      Returns:
      The value of the maximumX attribute

    • minimumY

      public float minimumY()
      Specified by:
      minimumY in interface AreaFType
      Specified by:
      minimumY in interface AreaValuesFType
      Returns:
      The value of the minimumY attribute

    • maximumY

      public float maximumY()
      Specified by:
      maximumY in interface AreaFType
      Specified by:
      maximumY in interface AreaValuesFType
      Returns:
      The value of the maximumY attribute

    • withMinimumX

      public final AreaF withMinimumX​(float value)
      Copy the current immutable object by setting a value for the minimumX attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for minimumX
      Returns:
      A modified copy of the this object

    • withMaximumX

      public final AreaF withMaximumX​(float value)
      Copy the current immutable object by setting a value for the maximumX attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maximumX
      Returns:
      A modified copy of the this object

    • withMinimumY

      public final AreaF withMinimumY​(float value)
      Copy the current immutable object by setting a value for the minimumY attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for minimumY
      Returns:
      A modified copy of the this object

    • withMaximumY

      public final AreaF withMaximumY​(float value)
      Copy the current immutable object by setting a value for the maximumY attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maximumY
      Returns:
      A modified copy of the this object

    • equals

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

    • toString

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

    • of

      public static AreaF of​(float minimumX, float maximumX, float minimumY, float maximumY)
      Construct a new immutable AreaF instance.
      Parameters:
      minimumX - The value for the minimumX attribute
      maximumX - The value for the maximumX attribute
      minimumY - The value for the minimumY attribute
      maximumY - The value for the maximumY attribute
      Returns:
      An immutable AreaF instance

    • copyOf

      public static AreaF copyOf​(AreaFType instance)
      Creates an immutable copy of a AreaFType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable AreaF instance

    • builder

      public static AreaF.Builder builder()
      Creates a builder for AreaF. 
       AreaF.builder()
    .setMinimumX(float) // required minimumX
    .setMaximumX(float) // required maximumX
    .setMinimumY(float) // required minimumY
    .setMaximumY(float) // required maximumY
    .build();
      Returns:
      A new AreaF builder