Record Class FloatRange

java.lang.Object
java.lang.Record
de.Keyle.MyPet.api.gui.FloatRange
Record Components:
min - lower bound, inclusive
max - upper bound, inclusive; must not be below min

public record FloatRange(float min, float max) extends Record
Inclusive `[min, max]` float range; samples uniformly. Used for pitch/volume randomization.
  • Constructor Summary

    Constructors
    Constructor
    Description
    FloatRange(float min, float max)
    Rejects a NaN bound or an inverted range.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    float
    max()
    Returns the value of the max record component.
    float
    min()
    Returns the value of the min record component.
    static FloatRange
    of(float value)
    Creates a range that always yields the same value.
    float
    Draws a value uniformly from this range.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • FloatRange

      public FloatRange(float min, float max)
      Rejects a NaN bound or an inverted range.
  • Method Details

    • of

      public static FloatRange of(float value)
      Creates a range that always yields the same value.
      Parameters:
      value - the fixed value
      Returns:
      a range whose minimum and maximum are both value
    • sample

      public float sample(RandomGenerator r)
      Draws a value uniformly from this range.
      Parameters:
      r - the generator to draw from
      Returns:
      a value in [min, max], or the fixed value when the range is a point
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • min

      public float min()
      Returns the value of the min record component.
      Returns:
      the value of the min record component
    • max

      public float max()
      Returns the value of the max record component.
      Returns:
      the value of the max record component