Record Class ChatMessage

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.ChatMessage
Record Components:
index - the message index in the chat history
messageType - the message type (e.g., public chat, private message, game message)
text - the message text content
playerName - the name of the player who sent the message, or null for system messages
public record ChatMessage(int index, int messageType, String text, String playerName) extends Record
A message from the game chat history.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatMessage(int index, int messageType, String text, String playerName)
    Creates an instance of a ChatMessage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    index()
    Returns the value of the index record component.
    int
    messageType()
    Returns the value of the messageType record component.
    String
    playerName()
    Returns the value of the playerName record component.
    String
    text()
    Returns the value of the text 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

    • ChatMessage

      public ChatMessage(int index, int messageType, String text, String playerName)
      Creates an instance of a ChatMessage record class.
      Parameters:
      index - the value for the index record component
      messageType - the value for the messageType record component
      text - the value for the text record component
      playerName - the value for the playerName 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.

    • index

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

    • messageType

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

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • playerName

      public String playerName()
      Returns the value of the playerName record component.
      Returns:
      the value of the playerName record component