Record Class DropOffResourceOutcome

java.lang.Object
java.lang.Record
idlab.colonyops.model.events.DropOffResourceOutcome
Record Components:
deposited - the crate contents at the moment of deposit (i.e. what was handed over)
All Implemented Interfaces:
ActionOutcome
public record DropOffResourceOutcome(Map<ResourceType, Integer> deposited) extends Record implements ActionOutcome
Outcome for a successfully applied DropOffResourceAction. Tells how much the colony's extracted-resource totals grew.

  • Constructor Details

    • DropOffResourceOutcome

      public DropOffResourceOutcome(Map<ResourceType, Integer> deposited)
      Creates an instance of a DropOffResourceOutcome record class.
      Parameters:
      deposited - the value for the deposited 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. 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.

    • deposited

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