Record Class EnergyUnit

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.common.energy.EnergyUnit
Record Components:
id - unique identifier of the unit
symbol - display symbol (e.g. FE, RF)
conversionRate - multiplier relative to the base unit
public record EnergyUnit(net.kyori.adventure.key.Key id, String symbol, double conversionRate) extends Record
Represents a unit of energy with a conversion rate relative to a base unit.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnergyUnit(net.kyori.adventure.key.Key id, String symbol, double conversionRate)
    Creates an instance of a EnergyUnit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    conversionRate()
    Returns the value of the conversionRate record component.
    double
    convert(double amount, EnergyUnit to)
    Converts an amount from this unit into another unit.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    fromBase(double amount)
    Converts a value from the base unit into this unit.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.kyori.adventure.key.Key
    id()
    Returns the value of the id record component.
    String
    symbol()
    Returns the value of the symbol record component.
    double
    toBase(double amount)
    Converts a value into the base unit.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EnergyUnit

      public EnergyUnit(net.kyori.adventure.key.Key id, String symbol, double conversionRate)
      Creates an instance of a EnergyUnit record class.
      Parameters:
      id - the value for the id record component
      symbol - the value for the symbol record component
      conversionRate - the value for the conversionRate record component

  • Method Details

    • convert

      public double convert(double amount, EnergyUnit to)
      Converts an amount from this unit into another unit.
      Parameters:
      amount - the value in this unit
      to - the target unit
      Returns:
      converted value in the target unit

    • toBase

      public double toBase(double amount)
      Converts a value into the base unit.
      Parameters:
      amount - value in this unit
      Returns:
      value in base unit

    • fromBase

      public double fromBase(double amount)
      Converts a value from the base unit into this unit.
      Parameters:
      amount - value in base unit
      Returns:
      value in this unit

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • id

      public net.kyori.adventure.key.Key id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • symbol

      public String symbol()
      Returns the value of the symbol record component.
      Returns:
      the value of the symbol record component

    • conversionRate

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