Package com.ohacd.matchbox.api

Record Class ChatProcessor.ChatProcessingResult

java.lang.Object
java.lang.Record
com.ohacd.matchbox.api.ChatProcessor.ChatProcessingResult
Record Components:
result - the processing result enum
message - the (possibly modified) message
Enclosing interface:
ChatProcessor
public static record ChatProcessor.ChatProcessingResult(@NotNull ChatResult result, @NotNull ChatMessage message) extends Record
Result of chat processing with optional modified message.

  • Constructor Details

    • ChatProcessingResult

      public ChatProcessingResult(@NotNull @NotNull ChatResult result, @NotNull @NotNull ChatMessage message)
      Creates an instance of a ChatProcessingResult record class.
      Parameters:
      result - the value for the result record component
      message - the value for the message record component

  • Method Details

    • allow

      public static ChatProcessor.ChatProcessingResult allow(@NotNull @NotNull ChatMessage message)
      Creates an ALLOW result with the original message.
      Parameters:
      message - original chat message
      Returns:
      a ChatProcessingResult indicating ALLOW with the provided message

    • allowModified

      public static ChatProcessor.ChatProcessingResult allowModified(@NotNull @NotNull ChatMessage modifiedMessage)
      Creates an ALLOW result with a modified message.
      Parameters:
      modifiedMessage - modified chat message
      Returns:
      a ChatProcessingResult indicating ALLOW with the modified message

    • deny

      public static ChatProcessor.ChatProcessingResult deny(@NotNull @NotNull ChatMessage message)
      Creates a DENY result.
      Parameters:
      message - original chat message
      Returns:
      a ChatProcessingResult indicating DENY

    • cancel

      public static ChatProcessor.ChatProcessingResult cancel(@NotNull @NotNull ChatMessage message)
      Creates a CANCEL result.
      Parameters:
      message - original chat message
      Returns:
      a ChatProcessingResult indicating CANCEL

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

    • result

      @NotNull public @NotNull ChatResult result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • message

      @NotNull public @NotNull ChatMessage message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component