Record Class ResourceCrate

java.lang.Object
java.lang.Record
idlab.colonyops.model.entities.inventory.ResourceCrate
Record Components:
maxCapacity - the total quantity of resources the crate can hold, across all types
storage - the resources currently held, by type
public record ResourceCrate(int maxCapacity, Map<ResourceType, Integer> storage) extends Record
A squad member's container for carrying extracted resources back to a collection point. Resources still in a crate when a mission ends are lost.

  • Constructor Details

    • ResourceCrate

      public ResourceCrate(int maxCapacity, Map<ResourceType, Integer> storage)
      Creates an instance of a ResourceCrate record class.
      Parameters:
      maxCapacity - the value for the maxCapacity record component
      storage - the value for the storage record component

  • Method Details

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

    • maxCapacity

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

    • storage

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