Class NumericEntityEscaper


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

      Fields 
      Modifier and Type Field Description
      private boolean between
      whether to escape between the boundaries or outside them.
      private org.apache.commons.lang3.Range<java.lang.Integer> range
      range from lowest codepoint to highest codepoint.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        NumericEntityEscaper()
      Constructs a NumericEntityEscaper for all characters.
      private NumericEntityEscaper​(int below, int above, boolean between)
      Constructs a NumericEntityEscaper for the specified range.
    • Field Detail

      • between

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

        private final org.apache.commons.lang3.Range<java.lang.Integer> range
        range from lowest codepoint to highest codepoint.
    • Constructor Detail

      • 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 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