Record Class MessageSendEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.message.MessageSendEvent
Record Components:
cancelled - whether a listener suppressed this delivery
moduleName - the module the message came from
message - the main text
submessage - the secondary text, used by titles and toasts
eventMetadata - how the message is delivered
messageContext - the message context for this receiver
All Implemented Interfaces:
Event
public record MessageSendEvent(boolean cancelled, ModuleName moduleName, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata eventMetadata, MessageContext messageContext) extends Record implements Event
Fired for each receiver as the finished message goes out.

  • Constructor Details

    • MessageSendEvent

      public MessageSendEvent(ModuleName moduleName, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata eventMetadata, MessageContext messageContext)
      Creates an event that has not been cancelled.
      Parameters:
      moduleName - the module the message came from
      message - the main text
      submessage - the secondary text
      eventMetadata - how the message is delivered
      messageContext - the message context for this receiver

    • MessageSendEvent

      public MessageSendEvent(boolean cancelled, ModuleName moduleName, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata eventMetadata, MessageContext messageContext)
      Creates an instance of a MessageSendEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      moduleName - the value for the moduleName record component
      message - the value for the message record component
      submessage - the value for the submessage record component
      eventMetadata - the value for the eventMetadata record component
      messageContext - the value for the messageContext record component

  • Method Details

    • withCancelled

      public MessageSendEvent 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).

    • withModuleName

      public MessageSendEvent withModuleName(ModuleName moduleName)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withMessage

      public MessageSendEvent withMessage(net.kyori.adventure.text.Component message)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withSubmessage

      public MessageSendEvent withSubmessage(net.kyori.adventure.text.Component submessage)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withEventMetadata

      public MessageSendEvent withEventMetadata(EventMetadata eventMetadata)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withMessageContext

      public MessageSendEvent withMessageContext(MessageContext messageContext)
      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

    • moduleName

      public ModuleName moduleName()
      Returns the value of the moduleName record component.
      Returns:
      the value of the moduleName record component

    • message

      public net.kyori.adventure.text.Component message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • submessage

      public net.kyori.adventure.text.Component submessage()
      Returns the value of the submessage record component.
      Returns:
      the value of the submessage record component

    • eventMetadata

      public EventMetadata eventMetadata()
      Returns the value of the eventMetadata record component.
      Returns:
      the value of the eventMetadata record component

    • messageContext

      public MessageContext messageContext()
      Returns the value of the messageContext record component.
      Returns:
      the value of the messageContext record component