Package megamek.common.units

Record Class UnitTargetPair

java.lang.Object
java.lang.Record
megamek.common.units.UnitTargetPair
public record UnitTargetPair(InGameObject unit, Targetable target) extends Record
This class is a record of pair of a (InGameObject) unit and a (Targetable) target. Note that two such pairs are equal when their contents count as equal which is when the IDs of unit and target are equal. This object itself is immutable although the underlying objects are not.

  • Constructor Details

    • UnitTargetPair

      public UnitTargetPair(InGameObject unit, Targetable target)
      Creates an instance of a UnitTargetPair record class.
      Parameters:
      unit - the value for the unit record component
      target - the value for the target record component

  • Method Details

    • equals

      public boolean equals(@Nullable 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.

    • 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

    • unit

      public InGameObject unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component

    • target

      public Targetable target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component