Record Class CancelNextEvents.Command

java.lang.Object
java.lang.Record
nl.pim16aap2.lightkeeper.protocol.CancelNextEvents.Command
Record Components:
requestId - Correlation identifier matching the response's requestId.
eventClassName - Fully-qualified class name of the Bukkit event to cancel; must implement Cancellable.
count - How many upcoming events to cancel; must be positive.
All Implemented Interfaces:
IAgentCommand<CancelNextEvents.Response>
Enclosing class:
CancelNextEvents

public static record CancelNextEvents.Command(String requestId, String eventClassName, int count) extends Record implements IAgentCommand<CancelNextEvents.Response>
Command record for CANCEL_NEXT_EVENTS.

The agent registers a LOWEST-priority listener (so it acts before regular plugin listeners) that cancels the next count fired events of the class; the MONITOR-priority capture listener still observes every event with its final cancelled state.

  • Constructor Details

    • Command

      public Command(String requestId, String eventClassName, int count)
      Validates command inputs.
  • Method Details

    • responseType

      public Class<CancelNextEvents.Response> responseType()
      Description copied from interface: IAgentCommand
      Returns the concrete response class for this command, used by the client to deserialize typed responses.
      Specified by:
      responseType in interface IAgentCommand<CancelNextEvents.Response>
      Returns:
      Non-null response class token.
    • 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 '=='.
      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.
    • requestId

      public String requestId()
      Returns the value of the requestId record component.
      Specified by:
      requestId in interface IAgentCommand<CancelNextEvents.Response>
      Returns:
      the value of the requestId record component
    • eventClassName

      public String eventClassName()
      Returns the value of the eventClassName record component.
      Returns:
      the value of the eventClassName record component
    • count

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