Record Class ComponentRef

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.ComponentRef
public record ComponentRef(int interfaceId, int componentId) extends Record
Identifies a component by its owning interface and component id within that interface. Input shape for batched component lookups (GameAPI.getComponents(List)).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ComponentRef(int interfaceId, int componentId)
    Creates an instance of a ComponentRef record class.

  • Method Summary

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ComponentRef

      public ComponentRef(int interfaceId, int componentId)
      Creates an instance of a ComponentRef record class.
      Parameters:
      interfaceId - the value for the interfaceId record component
      componentId - the value for the componentId 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 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.

    • interfaceId

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

    • componentId

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