Package ua.mcchickenstudio.opencreative.settings.filters

Record Class FilterResult

java.lang.Object
java.lang.Record
ua.mcchickenstudio.opencreative.settings.filters.FilterResult
public record FilterResult(@NotNull String originalMessage, @NotNull String filteredMessage, Filter.Context context, @Nullable FilterRule rule, @NotNull List<String> matches) extends Record

  • Constructor Details

    • FilterResult

      public FilterResult(@NotNull @NotNull String originalMessage, @NotNull @NotNull String filteredMessage, @NotNull Filter.Context context, @Nullable @Nullable FilterRule rule, @NotNull @NotNull List<String> matches)
      Creates an instance of a FilterResult record class.
      Parameters:
      originalMessage - the value for the originalMessage record component
      filteredMessage - the value for the filteredMessage record component
      context - the value for the context record component
      rule - the value for the rule record component
      matches - the value for the matches record component

  • Method Details

    • onViolation

      public void onViolation(@NotNull @NotNull org.bukkit.entity.Player player)

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

    • originalMessage

      @NotNull public @NotNull String originalMessage()
      Returns the value of the originalMessage record component.
      Returns:
      the value of the originalMessage record component

    • filteredMessage

      @NotNull public @NotNull String filteredMessage()
      Returns the value of the filteredMessage record component.
      Returns:
      the value of the filteredMessage record component

    • context

      @NotNull public Filter.Context context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • rule

      @Nullable public @Nullable FilterRule rule()
      Returns the value of the rule record component.
      Returns:
      the value of the rule record component

    • matches

      @NotNull public @NotNull List<String> matches()
      Returns the value of the matches record component.
      Returns:
      the value of the matches record component