Record Class ResourceVariant

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.resource.ResourceVariant
public record ResourceVariant(@NotNull ResourceType type, @NotNull ResourceComponents components) extends Record
What a resource is, without an amount: a ResourceType plus its components. Storages are keyed by variant; two stacks of equal variants always stack.

  • Constructor Details

    • ResourceVariant

      public ResourceVariant(@NotNull @NotNull ResourceType type, @NotNull @NotNull ResourceComponents components)
      Creates an instance of a ResourceVariant record class.
      Parameters:
      type - the value for the type record component
      components - the value for the components record component

  • Method Details

    • of

      @NotNull public static @NotNull ResourceVariant of(@NotNull @NotNull ResourceType type)

    • category

      @NotNull public @NotNull ResourceCategory category()

    • with

      @NotNull public <T> @NotNull ResourceVariant with(@NotNull @NotNull ResourceComponentType<T> component, @NotNull T value)

    • stack

      @NotNull public @NotNull ResourceStack stack(long amount)

    • toString

      @NotNull public @NotNull 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 Objects::equals(Object,Object).
      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.

    • type

      @NotNull public @NotNull ResourceType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • components

      @NotNull public @NotNull ResourceComponents components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component