Package org.apache.commons.text.translate

Class LookupTranslator

  • public class LookupTranslator
extends CharSequenceTranslator
    Translates a value using a lookup table.
    Since:
    1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      LookupTranslator​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> lookupMap)
      Define the lookup table to be used in translation Note that, as of Lang 3.1 (the origin of this code), the key to the lookup table is converted to a java.lang.String.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • LookupTranslator

        public LookupTranslator​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> lookupMap)
        Define the lookup table to be used in translation Note that, as of Lang 3.1 (the origin of this code), 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:
        lookupMap - Map<CharSequence, CharSequence> table of translator mappings

    • Method Detail

      • translate

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