Record Class FilteredText

java.lang.Object
java.lang.Record
net.minecraft.server.network.FilteredText
public record FilteredText(String raw, FilterMask mask) extends Record

  • Field Details

    • raw

      private final String raw
      The field for the raw record component.

    • mask

      private final FilterMask mask
      The field for the mask record component.

    • EMPTY

      public static final FilteredText EMPTY

  • Constructor Details

    • FilteredText

      public FilteredText(String raw, FilterMask mask)
      Creates an instance of a FilteredText record class.
      Parameters:
      raw - the value for the raw record component
      mask - the value for the mask record component

  • Method Details

    • passThrough

      public static FilteredText passThrough(String message)

    • fullyFiltered

      public static FilteredText fullyFiltered(String message)

    • filtered

      public @Nullable String filtered()

    • filteredOrEmpty

      public String filteredOrEmpty()

    • isFiltered

      public boolean isFiltered()

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

    • raw

      public String raw()
      Returns the value of the raw record component.
      Returns:
      the value of the raw record component

    • mask

      public FilterMask mask()
      Returns the value of the mask record component.
      Returns:
      the value of the mask record component