Package io.github.pylonmc.pylon.base.util

Record Class HslColor

java.lang.Object
java.lang.Record
io.github.pylonmc.pylon.base.util.HslColor
public record HslColor(double hue, double saturation, double lightness) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    HslColor(double hue, double saturation, double lightness)
    Creates an instance of a HslColor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @NotNull HslColor
    fromRgb(@NotNull org.bukkit.Color color)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    hue()
    Returns the value of the hue record component.
    double
    lightness()
    Returns the value of the lightness record component.
    double
    saturation()
    Returns the value of the saturation record component.
    @NotNull org.bukkit.Color
    toRgb()
     
    final String
    toString()
    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

    • HslColor

      public HslColor(double hue, double saturation, double lightness)
      Creates an instance of a HslColor record class.
      Parameters:
      hue - the value for the hue record component
      saturation - the value for the saturation record component
      lightness - the value for the lightness record component

  • Method Details

    • fromRgb

      @NotNull public static @NotNull HslColor fromRgb(@NotNull @NotNull org.bukkit.Color color)

    • toRgb

      @NotNull public @NotNull org.bukkit.Color toRgb()

    • 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.

    • hue

      public double hue()
      Returns the value of the hue record component.
      Returns:
      the value of the hue record component

    • saturation

      public double saturation()
      Returns the value of the saturation record component.
      Returns:
      the value of the saturation record component

    • lightness

      public double lightness()
      Returns the value of the lightness record component.
      Returns:
      the value of the lightness record component