Class StringEscapeUtils.LookupTranslator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int longest  
      private java.util.HashMap<java.lang.String,​java.lang.String> lookupMap  
      private java.util.HashSet<java.lang.Character> prefixSet  
      private int shortest  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private LookupTranslator​(java.lang.CharSequence[]... lookup)
      Define the lookup table to be used in translation
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected int translate​(java.lang.CharSequence input, int index, java.io.Writer out)
      Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • lookupMap

        private final java.util.HashMap<java.lang.String,​java.lang.String> lookupMap
      • prefixSet

        private final java.util.HashSet<java.lang.Character> prefixSet
      • shortest

        private final int shortest
      • longest

        private final int longest
    • Constructor Detail

      • LookupTranslator

        private LookupTranslator​(java.lang.CharSequence[]... lookup)
        Define the lookup table to be used in translation

        Note that, as of Lang 3.1, the key to the lookup table is converted to a java.lang.String. This is because we need the key to support hashCode and equals(Object), allowing it to be the key for a HashMap. See LANG-882.

        Parameters:
        lookup - CharSequence[][] table of size [*][2]
    • Method Detail

      • translate

        protected int translate​(java.lang.CharSequence input,
                                int index,
                                java.io.Writer out)
                         throws java.io.IOException
        Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints. The number of codepoints consumed must be returned, and the only IOExceptions thrown must be from interacting with the Writer so that the top level API may reliably ignore StringWriter IOExceptions.
        Specified by:
        translate in class StringEscapeUtils.CharSequenceTranslator
        Parameters:
        input - CharSequence that is being translated
        index - int representing the current point of translation
        out - Writer to translate the text to
        Returns:
        int count of codepoints consumed
        Throws:
        java.io.IOException - if and only if the Writer produces an IOException