Record Class GmcpMessage

java.lang.Object
java.lang.Record
io.github.protasm.jvmud.engine.protocol.GmcpMessage
public record GmcpMessage(String packageName, Object payload, boolean hasPayload) extends Record
A decoded Generic Mud Communication Protocol message.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GmcpMessage(String packageName, Object payload, boolean hasPayload)
    Creates an instance of a GmcpMessage 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.
    boolean
    hasPayload()
    Returns the value of the hasPayload record component.
    String
    packageName()
    Returns the value of the packageName record component.
    Object
    payload()
    Returns the value of the payload record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • GmcpMessage

      public GmcpMessage(String packageName, Object payload, boolean hasPayload)
      Creates an instance of a GmcpMessage record class.
      Parameters:
      packageName - the value for the packageName record component
      payload - the value for the payload record component
      hasPayload - the value for the hasPayload 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.

    • packageName

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

    • payload

      public Object payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component

    • hasPayload

      public boolean hasPayload()
      Returns the value of the hasPayload record component.
      Returns:
      the value of the hasPayload record component