Package dev.objz.commandbridge.api.channel.command

Record Class CommandPayload

java.lang.Object
java.lang.Record
dev.objz.commandbridge.api.channel.command.CommandPayload
Record Components:
command - the command string to run
runAs - the execution mode
player - the optional player context
All Implemented Interfaces:
ChannelPayload
public record CommandPayload(String command, RunAs runAs, UUID player) extends Record implements ChannelPayload
Payload for command execution.

  • Constructor Details

    • CommandPayload

      public CommandPayload(String command, RunAs runAs)

    • CommandPayload

      public CommandPayload(String command, RunAs runAs, UUID player)
      Creates an instance of a CommandPayload record class.
      Parameters:
      command - the value for the command record component
      runAs - the value for the runAs record component
      player - the value for the player 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 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.

    • command

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

    • runAs

      public RunAs runAs()
      Returns the value of the runAs record component.
      Returns:
      the value of the runAs record component

    • player

      public UUID player()
      Returns the value of the player record component.
      Returns:
      the value of the player record component