Method Detail

• setSafeRange

  public Escapers.Builder setSafeRange(char safeMin,
                              char safeMax)

  Sets the safe range of characters for the escaper. Characters in this range that have no explicit replacement are considered 'safe' and remain unescaped in the output. If safeMax < safeMin then the safe range is empty.

  Parameters:

  safeMin - the lowest 'safe' character

  safeMax - the highest 'safe' character

  Returns:

  the builder instance

• setUnsafeReplacement

  public Escapers.Builder setUnsafeReplacement(@Nullable
                                      String unsafeReplacement)

  Sets the replacement string for any characters outside the 'safe' range that have no explicit replacement. If unsafeReplacement is null then no replacement will occur, if it is "" then the unsafe characters are removed from the output.

  Parameters:

  unsafeReplacement - the string to replace unsafe chracters

  Returns:

  the builder instance

• addEscape

  public Escapers.Builder addEscape(char c,
                           String replacement)

  Adds a replacement string for the given input character. The specified character will be replaced by the given string whenever it occurs in the input, irrespective of whether it lies inside or outside the 'safe' range.

  Parameters:

  c - the character to be replaced

  replacement - the string to replace the given character

  Returns:

  the builder instance

  Throws:

  NullPointerException - if replacement is null

• build

  public Escaper build()

  Returns a new escaper based on the current state of the builder.