Class NumericEntityEscaper


  • @Deprecated
    public class NumericEntityEscaper
    extends CodePointTranslator
    Deprecated.
    As of 3.6, use Apache Commons Text NumericEntityEscaper instead
    Translates code points to their XML numeric entity escaped value.
    Since:
    3.0
    • Field Detail

      • below

        private final int below
        Deprecated.
      • above

        private final int above
        Deprecated.
      • between

        private final boolean between
        Deprecated.
    • Constructor Detail

      • NumericEntityEscaper

        public NumericEntityEscaper()
        Deprecated.
        Constructs a NumericEntityEscaper for all characters.
      • NumericEntityEscaper

        private NumericEntityEscaper​(int below,
                                     int above,
                                     boolean between)
        Deprecated.
        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 code point boundary
        above - int value representing the highest code point boundary
        between - whether to escape between the boundaries or outside them
    • Method Detail

      • between

        public static NumericEntityEscaper between​(int codePointLow,
                                                   int codePointHigh)
        Deprecated.
        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)
        Deprecated.
        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,
                                 java.io.Writer out)
                          throws java.io.IOException
        Deprecated.
        Translate the specified code point 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:
        java.io.IOException - if and only if the Writer produces an IOException