Package megamek.common.moves

Record Class Key

java.lang.Object
java.lang.Record
megamek.common.moves.Key
public record Key(Coords coords, int facing, int type) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Key(Coords coords, int facing, int type)
    Creates an instance of a Key record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Coords
    coords()
    Returns the value of the coords record component.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    int
    facing()
    Returns the value of the facing record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    int
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Key

      public Key(Coords coords, int facing, int type)
      Creates an instance of a Key record class.
      Parameters:
      coords - the value for the coords record component
      facing - the value for the facing record component
      type - the value for the type record component

  • Method Details

    • equals

      public boolean equals(Object obj)
      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:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj 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

    • coords

      public Coords coords()
      Returns the value of the coords record component.
      Returns:
      the value of the coords record component

    • facing

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

    • type

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