Class NumericEntityEscaper


  • public class NumericEntityEscaper
    extends CodePointTranslator
    Translates codepoints to their XML numeric entity escaped value.
    Since:
    1.0
    • Constructor Detail

      • NumericEntityEscaper

        public NumericEntityEscaper()

        Constructs a NumericEntityEscaper for all characters.

    • Method Detail

      • 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,
                                 java.io.Writer out)
                          throws java.io.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:
        java.io.IOException - if and only if the Writer produces an IOException