Record Class StatusResponseEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.message.StatusResponseEvent
Record Components:
cancelled - whether a listener vetoed the change
response - the platform-specific response object
All Implemented Interfaces:
Event
public record StatusResponseEvent(boolean cancelled, Object response) extends Record implements Event
Fired when the server answers a status ping, so the MOTD and player counts can be rewritten.

  • Constructor Details

    • StatusResponseEvent

      public StatusResponseEvent(Object response)
      Creates an event that has not been cancelled.
      Parameters:
      response - the platform-specific response object

    • StatusResponseEvent

      public StatusResponseEvent(boolean cancelled, Object response)
      Creates an instance of a StatusResponseEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      response - the value for the response record component

  • Method Details

    • withCancelled

      public StatusResponseEvent withCancelled(boolean cancelled)
      Description copied from interface: Event
      Returns a copy of this event with the cancelled flag set.
      Specified by:
      withCancelled in interface Event
      Parameters:
      cancelled - the new cancelled state
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withResponse

      public StatusResponseEvent withResponse(Object response)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • 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.

    • cancelled

      public boolean cancelled()
      Returns the value of the cancelled record component.
      Specified by:
      cancelled in interface Event
      Returns:
      the value of the cancelled record component

    • response

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