Package org.apache.commons.text.translate

Class NumericEntityEscaper

java.lang.Object
org.apache.commons.text.translate.CharSequenceTranslator
org.apache.commons.text.translate.CodePointTranslator
org.apache.commons.text.translate.NumericEntityEscaper
public class NumericEntityEscaper extends CodePointTranslator
Translates codepoints to their XML numeric entity escaped value.
Since:
1.0

  • Field Details

    • between

      private final boolean between
      whether to escape between the boundaries or outside them.

    • range

      private final org.apache.commons.lang3.Range<Integer> range
      range from lowest codepoint to highest codepoint.

  • Constructor Details

    • NumericEntityEscaper

      private NumericEntityEscaper(int below, int above, boolean between)

      Constructs a NumericEntityEscaper for the specified range. This is the underlying method for the other constructors/builders. The below and above boundaries are inclusive when between is true and exclusive when it is false.

      Parameters:
      below - int value representing the lowest codepoint boundary
      above - int value representing the highest codepoint boundary
      between - whether to escape between the boundaries or outside them

    • NumericEntityEscaper

      public NumericEntityEscaper()

      Constructs a NumericEntityEscaper for all characters.

  • Method Details

    • below

      public static NumericEntityEscaper below(int codepoint)

      Constructs a NumericEntityEscaper below the specified value (exclusive).

      Parameters:
      codepoint - below which to escape
      Returns:
      The newly created NumericEntityEscaper instance

    • above

      public static NumericEntityEscaper above(int codepoint)

      Constructs a NumericEntityEscaper above the specified value (exclusive).

      Parameters:
      codepoint - above which to escape
      Returns:
      The newly created NumericEntityEscaper instance

    • between

      public static NumericEntityEscaper between(int codepointLow, int codepointHigh)

      Constructs a NumericEntityEscaper between the specified values (inclusive).

      Parameters:
      codepointLow - above which to escape
      codepointHigh - below which to escape
      Returns:
      The newly created NumericEntityEscaper instance

    • outsideOf

      public static NumericEntityEscaper outsideOf(int codepointLow, int codepointHigh)

      Constructs a NumericEntityEscaper outside of the specified values (exclusive).

      Parameters:
      codepointLow - below which to escape
      codepointHigh - above which to escape
      Returns:
      The newly created NumericEntityEscaper instance

    • translate

      public boolean translate(int codepoint, Writer out) throws IOException
      Translate the specified codepoint into another.
      Specified by:
      translate in class CodePointTranslator
      Parameters:
      codepoint - int character input to translate
      out - Writer to optionally push the translated output to
      Returns:
      boolean as to whether translation occurred or not
      Throws:
      IOException - if and only if the Writer produces an IOException