Package dev.jaxydog.astral.utility

Record Class CurrencyHelper.Unit

java.lang.Object
java.lang.Record
dev.jaxydog.astral.utility.CurrencyHelper.Unit
Record Components:
itemId - The representing item's identifier.
value - The value of this currency.
dropRewards - Whether to drop rewards when automatically exchanging.
exchangeMap - A map containing exchange rates for other namespaces.
All Implemented Interfaces:
CurrencyHelper.ItemRepresentable, Comparable<CurrencyHelper.Unit>
Enclosing interface:
CurrencyHelper
public static record CurrencyHelper.Unit(net.minecraft.util.Identifier itemId, int value, boolean dropRewards, Map<String,Integer> exchangeMap) extends Record implements CurrencyHelper.ItemRepresentable, Comparable<CurrencyHelper.Unit>
A base unit of currency.
Since:
2.0.0

  • Field Details

  • Constructor Details

    • Unit

      public Unit(net.minecraft.util.Identifier itemId, int value, boolean dropRewards, Map<String,Integer> exchangeMap)
      Creates an instance of a Unit record class.
      Parameters:
      itemId - the value for the itemId record component
      value - the value for the value record component
      dropRewards - the value for the dropRewards record component
      exchangeMap - the value for the exchangeMap record component

  • Method Details

    • parse

      public static CurrencyHelper.Unit parse(String namespace, net.minecraft.util.Identifier itemId, com.google.gson.JsonObject object) throws com.google.gson.JsonSyntaxException
      Parses a JSON object and creates a new CurrencyHelper.Unit from the resolved data.
      Parameters:
      namespace - The unit's namespace.
      itemId - The representing item's identifier.
      object - The JSON object.
      Returns:
      A new unit.
      Throws:
      com.google.gson.JsonSyntaxException - If a field is invalid or missing from the given object.
      Since:
      2.0.0

    • next

      public Optional<Map.Entry<net.minecraft.util.Identifier,CurrencyHelper.Unit>> next(boolean exactMultiple)
      Returns the next unit of currency by value.
      Parameters:
      exactMultiple - Whether the value of the unit returned should be an exact multiple of this unit's value.
      Returns:
      The next unit by value.
      Since:
      2.0.0

    • getItemId

      public net.minecraft.util.Identifier getItemId()
      Description copied from interface: CurrencyHelper.ItemRepresentable
      Returns the associated item identifier, or minecraft:air if the referenced identifier is invalid.
      Specified by:
      getItemId in interface CurrencyHelper.ItemRepresentable
      Returns:
      The associated item identifier, or minecraft:air if the referenced identifier is invalid.

    • compareTo

      public int compareTo(@NotNull @NotNull CurrencyHelper.Unit o)
      Specified by:
      compareTo in interface Comparable<CurrencyHelper.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 '=='.
      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.

    • itemId

      public net.minecraft.util.Identifier itemId()
      Returns the value of the itemId record component.
      Returns:
      the value of the itemId record component

    • value

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

    • dropRewards

      public boolean dropRewards()
      Returns the value of the dropRewards record component.
      Returns:
      the value of the dropRewards record component

    • exchangeMap

      public Map<String,Integer> exchangeMap()
      Returns the value of the exchangeMap record component.
      Returns:
      the value of the exchangeMap record component