All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.text.translate.EntityArrays Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.text.translate;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * Class holding various entity data for HTML and XML - generally for use with
 * the LookupTranslator.
 * All Maps are generated using java.util.Collections.unmodifiableMap().
 *
 * @since 1.0
 */
public class EntityArrays {

   /**
     * A Map<CharSequence, CharSequence> to to escape
     * ISO-8859-1
     * characters to their named HTML 3.x equivalents.
     */
    public static final Map ISO8859_1_ESCAPE;
    static {
        final Map initialMap = new HashMap<>();
        initialMap.put("\u00A0", " "); // non-breaking space
        initialMap.put("\u00A1", "¡"); // inverted exclamation mark
        initialMap.put("\u00A2", "¢"); // cent sign
        initialMap.put("\u00A3", "£"); // pound sign
        initialMap.put("\u00A4", "¤"); // currency sign
        initialMap.put("\u00A5", "¥"); // yen sign = yuan sign
        initialMap.put("\u00A6", "¦"); // broken bar = broken vertical bar
        initialMap.put("\u00A7", "§"); // section sign
        initialMap.put("\u00A8", "¨"); // diaeresis = spacing diaeresis
        initialMap.put("\u00A9", "©"); // © - copyright sign
        initialMap.put("\u00AA", "ª"); // feminine ordinal indicator
        initialMap.put("\u00AB", "«"); // left-pointing double angle quotation mark = left pointing guillemet
        initialMap.put("\u00AC", "¬"); // not sign
        initialMap.put("\u00AD", "­"); // soft hyphen = discretionary hyphen
        initialMap.put("\u00AE", "®"); // ® - registered trademark sign
        initialMap.put("\u00AF", "¯"); // macron = spacing macron = overline = APL overbar
        initialMap.put("\u00B0", "°"); // degree sign
        initialMap.put("\u00B1", "±"); // plus-minus sign = plus-or-minus sign
        initialMap.put("\u00B2", "²"); // superscript two = superscript digit two = squared
        initialMap.put("\u00B3", "³"); // superscript three = superscript digit three = cubed
        initialMap.put("\u00B4", "´"); // acute accent = spacing acute
        initialMap.put("\u00B5", "µ"); // micro sign
        initialMap.put("\u00B6", "¶"); // pilcrow sign = paragraph sign
        initialMap.put("\u00B7", "·"); // middle dot = Georgian comma = Greek middle dot
        initialMap.put("\u00B8", "¸"); // cedilla = spacing cedilla
        initialMap.put("\u00B9", "¹"); // superscript one = superscript digit one
        initialMap.put("\u00BA", "º"); // masculine ordinal indicator
        initialMap.put("\u00BB", "»"); // right-pointing double angle quotation mark = right pointing guillemet
        initialMap.put("\u00BC", "¼"); // vulgar fraction one quarter = fraction one quarter
        initialMap.put("\u00BD", "½"); // vulgar fraction one half = fraction one half
        initialMap.put("\u00BE", "¾"); // vulgar fraction three quarters = fraction three quarters
        initialMap.put("\u00BF", "¿"); // inverted question mark = turned question mark
        initialMap.put("\u00C0", "À"); // À - uppercase A, grave accent
        initialMap.put("\u00C1", "Á"); // Á - uppercase A, acute accent
        initialMap.put("\u00C2", "Â"); // Â - uppercase A, circumflex accent
        initialMap.put("\u00C3", "Ã"); // Ã - uppercase A, tilde
        initialMap.put("\u00C4", "Ä"); // Ä - uppercase A, umlaut
        initialMap.put("\u00C5", "Å"); // Å - uppercase A, ring
        initialMap.put("\u00C6", "Æ"); // Æ - uppercase AE
        initialMap.put("\u00C7", "Ç"); // Ç - uppercase C, cedilla
        initialMap.put("\u00C8", "È"); // È - uppercase E, grave accent
        initialMap.put("\u00C9", "É"); // É - uppercase E, acute accent
        initialMap.put("\u00CA", "Ê"); // Ê - uppercase E, circumflex accent
        initialMap.put("\u00CB", "Ë"); // Ë - uppercase E, umlaut
        initialMap.put("\u00CC", "Ì"); // Ì - uppercase I, grave accent
        initialMap.put("\u00CD", "Í"); // Í - uppercase I, acute accent
        initialMap.put("\u00CE", "Î"); // Î - uppercase I, circumflex accent
        initialMap.put("\u00CF", "Ï"); // Ï - uppercase I, umlaut
        initialMap.put("\u00D0", "Ð"); // Ð - uppercase Eth, Icelandic
        initialMap.put("\u00D1", "Ñ"); // Ñ - uppercase N, tilde
        initialMap.put("\u00D2", "Ò"); // Ò - uppercase O, grave accent
        initialMap.put("\u00D3", "Ó"); // Ó - uppercase O, acute accent
        initialMap.put("\u00D4", "Ô"); // Ô - uppercase O, circumflex accent
        initialMap.put("\u00D5", "Õ"); // Õ - uppercase O, tilde
        initialMap.put("\u00D6", "Ö"); // Ö - uppercase O, umlaut
        initialMap.put("\u00D7", "×"); // multiplication sign
        initialMap.put("\u00D8", "Ø"); // Ø - uppercase O, slash
        initialMap.put("\u00D9", "Ù"); // Ù - uppercase U, grave accent
        initialMap.put("\u00DA", "Ú"); // Ú - uppercase U, acute accent
        initialMap.put("\u00DB", "Û"); // Û - uppercase U, circumflex accent
        initialMap.put("\u00DC", "Ü"); // Ü - uppercase U, umlaut
        initialMap.put("\u00DD", "Ý"); // Ý - uppercase Y, acute accent
        initialMap.put("\u00DE", "Þ"); // Þ - uppercase THORN, Icelandic
        initialMap.put("\u00DF", "ß"); // ß - lowercase sharps, German
        initialMap.put("\u00E0", "à"); // à - lowercase a, grave accent
        initialMap.put("\u00E1", "á"); // á - lowercase a, acute accent
        initialMap.put("\u00E2", "â"); // â - lowercase a, circumflex accent
        initialMap.put("\u00E3", "ã"); // ã - lowercase a, tilde
        initialMap.put("\u00E4", "ä"); // ä - lowercase a, umlaut
        initialMap.put("\u00E5", "å"); // å - lowercase a, ring
        initialMap.put("\u00E6", "æ"); // æ - lowercase ae
        initialMap.put("\u00E7", "ç"); // ç - lowercase c, cedilla
        initialMap.put("\u00E8", "è"); // è - lowercase e, grave accent
        initialMap.put("\u00E9", "é"); // é - lowercase e, acute accent
        initialMap.put("\u00EA", "ê"); // ê - lowercase e, circumflex accent
        initialMap.put("\u00EB", "ë"); // ë - lowercase e, umlaut
        initialMap.put("\u00EC", "ì"); // ì - lowercase i, grave accent
        initialMap.put("\u00ED", "í"); // í - lowercase i, acute accent
        initialMap.put("\u00EE", "î"); // î - lowercase i, circumflex accent
        initialMap.put("\u00EF", "ï"); // ï - lowercase i, umlaut
        initialMap.put("\u00F0", "ð"); // ð - lowercase eth, Icelandic
        initialMap.put("\u00F1", "ñ"); // ñ - lowercase n, tilde
        initialMap.put("\u00F2", "ò"); // ò - lowercase o, grave accent
        initialMap.put("\u00F3", "ó"); // ó - lowercase o, acute accent
        initialMap.put("\u00F4", "ô"); // ô - lowercase o, circumflex accent
        initialMap.put("\u00F5", "õ"); // õ - lowercase o, tilde
        initialMap.put("\u00F6", "ö"); // ö - lowercase o, umlaut
        initialMap.put("\u00F7", "÷"); // division sign
        initialMap.put("\u00F8", "ø"); // ø - lowercase o, slash
        initialMap.put("\u00F9", "ù"); // ù - lowercase u, grave accent
        initialMap.put("\u00FA", "ú"); // ú - lowercase u, acute accent
        initialMap.put("\u00FB", "û"); // û - lowercase u, circumflex accent
        initialMap.put("\u00FC", "ü"); // ü - lowercase u, umlaut
        initialMap.put("\u00FD", "ý"); // ý - lowercase y, acute accent
        initialMap.put("\u00FE", "þ"); // þ - lowercase thorn, Icelandic
        initialMap.put("\u00FF", "ÿ"); // ÿ - lowercase y, umlaut
        ISO8859_1_ESCAPE = Collections.unmodifiableMap(initialMap);
    }

    /**
     * Reverse of {@link #ISO8859_1_ESCAPE} for unescaping purposes.
     */
    public static final Map ISO8859_1_UNESCAPE;
    static {
        ISO8859_1_UNESCAPE = Collections.unmodifiableMap(invert(ISO8859_1_ESCAPE));
    }

    /**
     * A Map<CharSequence, CharSequence> to escape additional
     * character entity
     * references. Note that this must be used with {@link #ISO8859_1_ESCAPE} to get the full list of
     * HTML 4.0 character entities.
     */
    public static final Map HTML40_EXTENDED_ESCAPE;
    static {
        final Map initialMap = new HashMap<>();
        // 
        initialMap.put("\u0192", "ƒ"); // latin small f with hook = function= florin, U+0192 ISOtech -->
        // 
        initialMap.put("\u0391", "Α"); // greek capital letter alpha, U+0391 -->
        initialMap.put("\u0392", "Β"); // greek capital letter beta, U+0392 -->
        initialMap.put("\u0393", "Γ"); // greek capital letter gamma,U+0393 ISOgrk3 -->
        initialMap.put("\u0394", "Δ"); // greek capital letter delta,U+0394 ISOgrk3 -->
        initialMap.put("\u0395", "Ε"); // greek capital letter epsilon, U+0395 -->
        initialMap.put("\u0396", "Ζ"); // greek capital letter zeta, U+0396 -->
        initialMap.put("\u0397", "Η"); // greek capital letter eta, U+0397 -->
        initialMap.put("\u0398", "Θ"); // greek capital letter theta,U+0398 ISOgrk3 -->
        initialMap.put("\u0399", "Ι"); // greek capital letter iota, U+0399 -->
        initialMap.put("\u039A", "Κ"); // greek capital letter kappa, U+039A -->
        initialMap.put("\u039B", "Λ"); // greek capital letter lambda,U+039B ISOgrk3 -->
        initialMap.put("\u039C", "Μ"); // greek capital letter mu, U+039C -->
        initialMap.put("\u039D", "Ν"); // greek capital letter nu, U+039D -->
        initialMap.put("\u039E", "Ξ"); // greek capital letter xi, U+039E ISOgrk3 -->
        initialMap.put("\u039F", "Ο"); // greek capital letter omicron, U+039F -->
        initialMap.put("\u03A0", "Π"); // greek capital letter pi, U+03A0 ISOgrk3 -->
        initialMap.put("\u03A1", "Ρ"); // greek capital letter rho, U+03A1 -->
        // 
        initialMap.put("\u03A3", "Σ"); // greek capital letter sigma,U+03A3 ISOgrk3 -->
        initialMap.put("\u03A4", "Τ"); // greek capital letter tau, U+03A4 -->
        initialMap.put("\u03A5", "Υ"); // greek capital letter upsilon,U+03A5 ISOgrk3 -->
        initialMap.put("\u03A6", "Φ"); // greek capital letter phi,U+03A6 ISOgrk3 -->
        initialMap.put("\u03A7", "Χ"); // greek capital letter chi, U+03A7 -->
        initialMap.put("\u03A8", "Ψ"); // greek capital letter psi,U+03A8 ISOgrk3 -->
        initialMap.put("\u03A9", "Ω"); // greek capital letter omega,U+03A9 ISOgrk3 -->
        initialMap.put("\u03B1", "α"); // greek small letter alpha,U+03B1 ISOgrk3 -->
        initialMap.put("\u03B2", "β"); // greek small letter beta, U+03B2 ISOgrk3 -->
        initialMap.put("\u03B3", "γ"); // greek small letter gamma,U+03B3 ISOgrk3 -->
        initialMap.put("\u03B4", "δ"); // greek small letter delta,U+03B4 ISOgrk3 -->
        initialMap.put("\u03B5", "ε"); // greek small letter epsilon,U+03B5 ISOgrk3 -->
        initialMap.put("\u03B6", "ζ"); // greek small letter zeta, U+03B6 ISOgrk3 -->
        initialMap.put("\u03B7", "η"); // greek small letter eta, U+03B7 ISOgrk3 -->
        initialMap.put("\u03B8", "θ"); // greek small letter theta,U+03B8 ISOgrk3 -->
        initialMap.put("\u03B9", "ι"); // greek small letter iota, U+03B9 ISOgrk3 -->
        initialMap.put("\u03BA", "κ"); // greek small letter kappa,U+03BA ISOgrk3 -->
        initialMap.put("\u03BB", "λ"); // greek small letter lambda,U+03BB ISOgrk3 -->
        initialMap.put("\u03BC", "μ"); // greek small letter mu, U+03BC ISOgrk3 -->
        initialMap.put("\u03BD", "ν"); // greek small letter nu, U+03BD ISOgrk3 -->
        initialMap.put("\u03BE", "ξ"); // greek small letter xi, U+03BE ISOgrk3 -->
        initialMap.put("\u03BF", "ο"); // greek small letter omicron, U+03BF NEW -->
        initialMap.put("\u03C0", "π"); // greek small letter pi, U+03C0 ISOgrk3 -->
        initialMap.put("\u03C1", "ρ"); // greek small letter rho, U+03C1 ISOgrk3 -->
        initialMap.put("\u03C2", "ς"); // greek small letter final sigma,U+03C2 ISOgrk3 -->
        initialMap.put("\u03C3", "σ"); // greek small letter sigma,U+03C3 ISOgrk3 -->
        initialMap.put("\u03C4", "τ"); // greek small letter tau, U+03C4 ISOgrk3 -->
        initialMap.put("\u03C5", "υ"); // greek small letter upsilon,U+03C5 ISOgrk3 -->
        initialMap.put("\u03C6", "φ"); // greek small letter phi, U+03C6 ISOgrk3 -->
        initialMap.put("\u03C7", "χ"); // greek small letter chi, U+03C7 ISOgrk3 -->
        initialMap.put("\u03C8", "ψ"); // greek small letter psi, U+03C8 ISOgrk3 -->
        initialMap.put("\u03C9", "ω"); // greek small letter omega,U+03C9 ISOgrk3 -->
        initialMap.put("\u03D1", "ϑ"); // greek small letter theta symbol,U+03D1 NEW -->
        initialMap.put("\u03D2", "ϒ"); // greek upsilon with hook symbol,U+03D2 NEW -->
        initialMap.put("\u03D6", "ϖ"); // greek pi symbol, U+03D6 ISOgrk3 -->
        // 
        initialMap.put("\u2022", "•"); // bullet = black small circle,U+2022 ISOpub -->
        // 
        initialMap.put("\u2026", "…"); // horizontal ellipsis = three dot leader,U+2026 ISOpub -->
        initialMap.put("\u2032", "′"); // prime = minutes = feet, U+2032 ISOtech -->
        initialMap.put("\u2033", "″"); // double prime = seconds = inches,U+2033 ISOtech -->
        initialMap.put("\u203E", "‾"); // overline = spacing overscore,U+203E NEW -->
        initialMap.put("\u2044", "⁄"); // fraction slash, U+2044 NEW -->
        // 
        initialMap.put("\u2118", "℘"); // script capital P = power set= Weierstrass p, U+2118 ISOamso -->
        initialMap.put("\u2111", "ℑ"); // blackletter capital I = imaginary part,U+2111 ISOamso -->
        initialMap.put("\u211C", "ℜ"); // blackletter capital R = real part symbol,U+211C ISOamso -->
        initialMap.put("\u2122", "™"); // trade mark sign, U+2122 ISOnum -->
        initialMap.put("\u2135", "ℵ"); // alef symbol = first transfinite cardinal,U+2135 NEW -->
        // 
        // 
        initialMap.put("\u2190", "←"); // leftwards arrow, U+2190 ISOnum -->
        initialMap.put("\u2191", "↑"); // upwards arrow, U+2191 ISOnum-->
        initialMap.put("\u2192", "→"); // rightwards arrow, U+2192 ISOnum -->
        initialMap.put("\u2193", "↓"); // downwards arrow, U+2193 ISOnum -->
        initialMap.put("\u2194", "↔"); // left right arrow, U+2194 ISOamsa -->
        initialMap.put("\u21B5", "↵"); // downwards arrow with corner leftwards= carriage return, U+21B5 NEW -->
        initialMap.put("\u21D0", "⇐"); // leftwards double arrow, U+21D0 ISOtech -->
        // 
        initialMap.put("\u21D1", "⇑"); // upwards double arrow, U+21D1 ISOamsa -->
        initialMap.put("\u21D2", "⇒"); // rightwards double arrow,U+21D2 ISOtech -->
        // 
        initialMap.put("\u21D3", "⇓"); // downwards double arrow, U+21D3 ISOamsa -->
        initialMap.put("\u21D4", "⇔"); // left right double arrow,U+21D4 ISOamsa -->
        // 
        initialMap.put("\u2200", "∀"); // for all, U+2200 ISOtech -->
        initialMap.put("\u2202", "∂"); // partial differential, U+2202 ISOtech -->
        initialMap.put("\u2203", "∃"); // there exists, U+2203 ISOtech -->
        initialMap.put("\u2205", "∅"); // empty set = null set = diameter,U+2205 ISOamso -->
        initialMap.put("\u2207", "∇"); // nabla = backward difference,U+2207 ISOtech -->
        initialMap.put("\u2208", "∈"); // element of, U+2208 ISOtech -->
        initialMap.put("\u2209", "∉"); // not an element of, U+2209 ISOtech -->
        initialMap.put("\u220B", "∋"); // contains as member, U+220B ISOtech -->
        // 
        initialMap.put("\u220F", "∏"); // n-ary product = product sign,U+220F ISOamsb -->
        // 
        initialMap.put("\u2211", "∑"); // n-ary summation, U+2211 ISOamsb -->
        // 
        initialMap.put("\u2212", "−"); // minus sign, U+2212 ISOtech -->
        initialMap.put("\u2217", "∗"); // asterisk operator, U+2217 ISOtech -->
        initialMap.put("\u221A", "√"); // square root = radical sign,U+221A ISOtech -->
        initialMap.put("\u221D", "∝"); // proportional to, U+221D ISOtech -->
        initialMap.put("\u221E", "∞"); // infinity, U+221E ISOtech -->
        initialMap.put("\u2220", "∠"); // angle, U+2220 ISOamso -->
        initialMap.put("\u2227", "∧"); // logical and = wedge, U+2227 ISOtech -->
        initialMap.put("\u2228", "∨"); // logical or = vee, U+2228 ISOtech -->
        initialMap.put("\u2229", "∩"); // intersection = cap, U+2229 ISOtech -->
        initialMap.put("\u222A", "∪"); // union = cup, U+222A ISOtech -->
        initialMap.put("\u222B", "∫"); // integral, U+222B ISOtech -->
        initialMap.put("\u2234", "∴"); // therefore, U+2234 ISOtech -->
        initialMap.put("\u223C", "∼"); // tilde operator = varies with = similar to,U+223C ISOtech -->
        // 
        initialMap.put("\u2245", "≅"); // approximately equal to, U+2245 ISOtech -->
        initialMap.put("\u2248", "≈"); // almost equal to = asymptotic to,U+2248 ISOamsr -->
        initialMap.put("\u2260", "≠"); // not equal to, U+2260 ISOtech -->
        initialMap.put("\u2261", "≡"); // identical to, U+2261 ISOtech -->
        initialMap.put("\u2264", "≤"); // less-than or equal to, U+2264 ISOtech -->
        initialMap.put("\u2265", "≥"); // greater-than or equal to,U+2265 ISOtech -->
        initialMap.put("\u2282", "⊂"); // subset of, U+2282 ISOtech -->
        initialMap.put("\u2283", "⊃"); // superset of, U+2283 ISOtech -->
        // ,
        initialMap.put("\u2284", "⊄"); // not a subset of, U+2284 ISOamsn -->
        initialMap.put("\u2286", "⊆"); // subset of or equal to, U+2286 ISOtech -->
        initialMap.put("\u2287", "⊇"); // superset of or equal to,U+2287 ISOtech -->
        initialMap.put("\u2295", "⊕"); // circled plus = direct sum,U+2295 ISOamsb -->
        initialMap.put("\u2297", "⊗"); // circled times = vector product,U+2297 ISOamsb -->
        initialMap.put("\u22A5", "⊥"); // up tack = orthogonal to = perpendicular,U+22A5 ISOtech -->
        initialMap.put("\u22C5", "⋅"); // dot operator, U+22C5 ISOamsb -->
        // 
        // 
        initialMap.put("\u2308", "⌈"); // left ceiling = apl upstile,U+2308 ISOamsc -->
        initialMap.put("\u2309", "⌉"); // right ceiling, U+2309 ISOamsc -->
        initialMap.put("\u230A", "⌊"); // left floor = apl downstile,U+230A ISOamsc -->
        initialMap.put("\u230B", "⌋"); // right floor, U+230B ISOamsc -->
        initialMap.put("\u2329", "⟨"); // left-pointing angle bracket = bra,U+2329 ISOtech -->
        // 
        initialMap.put("\u232A", "⟩"); // right-pointing angle bracket = ket,U+232A ISOtech -->
        // 
        // 
        initialMap.put("\u25CA", "◊"); // lozenge, U+25CA ISOpub -->
        // 
        initialMap.put("\u2660", "♠"); // black spade suit, U+2660 ISOpub -->
        // 
        initialMap.put("\u2663", "♣"); // black club suit = shamrock,U+2663 ISOpub -->
        initialMap.put("\u2665", "♥"); // black heart suit = valentine,U+2665 ISOpub -->
        initialMap.put("\u2666", "♦"); // black diamond suit, U+2666 ISOpub -->

        // 
        initialMap.put("\u0152", "Œ"); // -- latin capital ligature OE,U+0152 ISOlat2 -->
        initialMap.put("\u0153", "œ"); // -- latin small ligature oe, U+0153 ISOlat2 -->
        // 
        initialMap.put("\u0160", "Š"); // -- latin capital letter S with caron,U+0160 ISOlat2 -->
        initialMap.put("\u0161", "š"); // -- latin small letter s with caron,U+0161 ISOlat2 -->
        initialMap.put("\u0178", "Ÿ"); // -- latin capital letter Y with diaeresis,U+0178 ISOlat2 -->
        // 
        initialMap.put("\u02C6", "ˆ"); // -- modifier letter circumflex accent,U+02C6 ISOpub -->
        initialMap.put("\u02DC", "˜"); // small tilde, U+02DC ISOdia -->
        // 
        initialMap.put("\u2002", " "); // en space, U+2002 ISOpub -->
        initialMap.put("\u2003", " "); // em space, U+2003 ISOpub -->
        initialMap.put("\u2009", " "); // thin space, U+2009 ISOpub -->
        initialMap.put("\u200C", "‌"); // zero width non-joiner,U+200C NEW RFC 2070 -->
        initialMap.put("\u200D", "‍"); // zero width joiner, U+200D NEW RFC 2070 -->
        initialMap.put("\u200E", "‎"); // left-to-right mark, U+200E NEW RFC 2070 -->
        initialMap.put("\u200F", "‏"); // right-to-left mark, U+200F NEW RFC 2070 -->
        initialMap.put("\u2013", "–"); // en dash, U+2013 ISOpub -->
        initialMap.put("\u2014", "—"); // em dash, U+2014 ISOpub -->
        initialMap.put("\u2018", "‘"); // left single quotation mark,U+2018 ISOnum -->
        initialMap.put("\u2019", "’"); // right single quotation mark,U+2019 ISOnum -->
        initialMap.put("\u201A", "‚"); // single low-9 quotation mark, U+201A NEW -->
        initialMap.put("\u201C", "“"); // left double quotation mark,U+201C ISOnum -->
        initialMap.put("\u201D", "”"); // right double quotation mark,U+201D ISOnum -->
        initialMap.put("\u201E", "„"); // double low-9 quotation mark, U+201E NEW -->
        initialMap.put("\u2020", "†"); // dagger, U+2020 ISOpub -->
        initialMap.put("\u2021", "‡"); // double dagger, U+2021 ISOpub -->
        initialMap.put("\u2030", "‰"); // per mille sign, U+2030 ISOtech -->
        initialMap.put("\u2039", "‹"); // single left-pointing angle quotation mark,U+2039 ISO proposed -->
        // 
        initialMap.put("\u203A", "›"); // single right-pointing angle quotation mark,U+203A ISO proposed -->
        // 
        initialMap.put("\u20AC", "€"); // -- euro sign, U+20AC NEW -->
        HTML40_EXTENDED_ESCAPE = Collections.unmodifiableMap(initialMap);
    }

    /**
     * Reverse of {@link #HTML40_EXTENDED_ESCAPE} for unescaping purposes.
     */
    public static final Map HTML40_EXTENDED_UNESCAPE;
    static {
        HTML40_EXTENDED_UNESCAPE = Collections.unmodifiableMap(invert(HTML40_EXTENDED_ESCAPE));
    }

    /**
     * A Map<CharSequence, CharSequence> to escape the basic XML and HTML
     * character entities.
     *
     * Namely: {@code " & < >}
     */
    public static final Map BASIC_ESCAPE;
    static {
        final Map initialMap = new HashMap<>();
        initialMap.put("\"", """); // " - double-quote
        initialMap.put("&", "&");   // & - ampersand
        initialMap.put("<", "<");    // < - less-than
        initialMap.put(">", ">");    // > - greater-than
        BASIC_ESCAPE = Collections.unmodifiableMap(initialMap);
    }

    /**
     * Reverse of {@link #BASIC_ESCAPE} for unescaping purposes.
     */
    public static final Map BASIC_UNESCAPE;
    static {
        BASIC_UNESCAPE = Collections.unmodifiableMap(invert(BASIC_ESCAPE));
    }

    /**
     * A Map<CharSequence, CharSequence> to escape the apostrophe character to
     * its XML character entity.
     */
    public static final Map APOS_ESCAPE;
    static {
        final Map initialMap = new HashMap<>();
        initialMap.put("'", "'"); // XML apostrophe
        APOS_ESCAPE = Collections.unmodifiableMap(initialMap);
    }

    /**
     * Reverse of {@link #APOS_ESCAPE} for unescaping purposes.
     */
    public static final Map APOS_UNESCAPE;
    static {
        APOS_UNESCAPE = Collections.unmodifiableMap(invert(APOS_ESCAPE));
    }

    /**
     * A Map<CharSequence, CharSequence> to escape the Java
     * control characters.
     *
     * Namely: {@code \b \n \t \f \r}
     */
    public static final Map JAVA_CTRL_CHARS_ESCAPE;
    static {
        final Map initialMap = new HashMap<>();
        initialMap.put("\b", "\\b");
        initialMap.put("\n", "\\n");
        initialMap.put("\t", "\\t");
        initialMap.put("\f", "\\f");
        initialMap.put("\r", "\\r");
        JAVA_CTRL_CHARS_ESCAPE = Collections.unmodifiableMap(initialMap);
    }

    /**
     * Reverse of {@link #JAVA_CTRL_CHARS_ESCAPE} for unescaping purposes.
     */
    public static final Map JAVA_CTRL_CHARS_UNESCAPE;
    static {
        JAVA_CTRL_CHARS_UNESCAPE = Collections.unmodifiableMap(invert(JAVA_CTRL_CHARS_ESCAPE));
    }

    /**
     * Used to invert an escape Map into an unescape Map.
     * @param map Map<String, String> to be inverted
     * @return Map<String, String> inverted array
     */
    public static Map invert(final Map map) {
        final Map newMap = new HashMap<>();
        for (final Map.Entry pair : map.entrySet()) {
            newMap.put(pair.getValue(), pair.getKey());
        }
        return newMap;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy