Package net.mezzdev.config.api.value.color

Record Class PackedColor

java.lang.Object
java.lang.Record
net.mezzdev.config.api.value.color.PackedColor
Record Components:
packedValue - packed 0xRRGGBB or 0xAARRGGBB value
format - format of the packed value
public record PackedColor(int packedValue, ConfigColorFormat format) extends Record
A color stored as a packed integer.
Since:
0.1.0

  • Constructor Details

    • PackedColor

      public PackedColor(int packedValue, ConfigColorFormat format)
      Validate and create a packed color.
      Since:
      0.1.0

  • Method Details

    • rgb

      public static PackedColor rgb(int packedValue)
      Create an RGB color stored as 0xRRGGBB.
      Parameters:
      packedValue - packed RGB value
      Returns:
      the packed color
      Since:
      0.1.0

    • argb

      public static PackedColor argb(int packedValue)
      Create an ARGB color stored as 0xAARRGGBB.
      Parameters:
      packedValue - packed ARGB value
      Returns:
      the packed color
      Since:
      0.1.0

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • packedValue

      public int packedValue()
      Returns the value of the packedValue record component.
      Returns:
      the value of the packedValue record component

    • format

      public ConfigColorFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component