Package dev.getelements.elements.sdk.util

Class OffensiveWordFilter.Builder

java.lang.Object
dev.getelements.elements.sdk.util.OffensiveWordFilter.Builder
Enclosing class:
OffensiveWordFilter
public static class OffensiveWordFilter.Builder extends Object
Builder for constructing an OffensiveWordFilter with a list of offensive words.

  • Field Details

    • DEFAULT_OFFENSIVE_WORDS_PATH

      public static String DEFAULT_OFFENSIVE_WORDS_PATH

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • addWord

      public OffensiveWordFilter.Builder addWord(OffensiveWordFilter.Word word)
      Adds a word to the offensive word list.
      Parameters:
      word - the word
      Returns:
      the builder

    • addWords

      public OffensiveWordFilter.Builder addWords(Properties properties)
      Adds words from a Properties object to the offensive word list.
      Parameters:
      properties - the properties containing words and their edit distances
      Returns:
      the builder

    • addWords

      public OffensiveWordFilter.Builder addWords(InputStream stream) throws IOException
      Adds words from an InputStream containing properties to the offensive word list.
      Parameters:
      stream - the input stream
      Returns:
      the builder
      Throws:
      IOException - if an I/O error occurs

    • addDefaultWords

      public OffensiveWordFilter.Builder addDefaultWords()
      Adds the default offensive words from the built-in properties file.
      Returns:
      the builder

    • ignoringCase

      public OffensiveWordFilter.Builder ignoringCase()
      Configures the filter to ignore case when checking for offensive words.
      Returns:
      the builder

    • build

      public OffensiveWordFilter build()
      Builds the OffensiveWordFilter instance.
      Returns:
      the OffensiveWordFilter