Record Class MessageFormattingEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.message.MessageFormattingEvent
Record Components:
cancelled - whether a listener vetoed the formatting
context - the message being formatted
All Implemented Interfaces:
Event
public record MessageFormattingEvent(boolean cancelled, MessageContext context) extends Record implements Event
Fired while a message is being turned into a component, so listeners can adjust the text or its tags.

  • Constructor Details

    • MessageFormattingEvent

      public MessageFormattingEvent(MessageContext context)
      Creates an event that has not been cancelled.
      Parameters:
      context - the message being formatted

    • MessageFormattingEvent

      public MessageFormattingEvent(boolean cancelled, MessageContext context)
      Creates an instance of a MessageFormattingEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      context - the value for the context record component

  • Method Details

    • withContext

      public MessageFormattingEvent withContext(MessageContext context)
      Returns a copy carrying a different context, or this event if the context is unchanged.
      Parameters:
      context - the new context
      Returns:
      the copy, or this instance when nothing changed

    • withCancelled

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

    • 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

    • context

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