Class ArrayBasedEscaperMap

  • @Beta
    public final class ArrayBasedEscaperMap
    extends Object
    An implementation-specific parameter class suitable for initializing ArrayBasedCharEscaper or ArrayBasedUnicodeEscaper instances. This class should be used when more than one escaper is created using the same character replacement mapping to allow the underlying (implementation specific) data structures to be shared.

    The size of the data structure used by ArrayBasedCharEscaper and ArrayBasedUnicodeEscaper is proportional to the highest valued character that has a replacement. For example a replacement map containing the single character '\u1000' will require approximately 16K of memory. As such sharing this data structure between escaper instances is the primary goal of this class.

    David Beaumont
    • Method Detail

      • create

        public static ArrayBasedEscaperMap create​(Map<Character,​String> replacements)
        Returns a new ArrayBasedEscaperMap for creating ArrayBasedCharEscaper or ArrayBasedUnicodeEscaper instances.
        replacements - a map of characters to their escaped representations