001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.commons.text.translate; 018 019import java.util.Collections; 020import java.util.HashMap; 021import java.util.Iterator; 022import java.util.Map; 023 024/** 025 * Class holding various entity data for HTML and XML - generally for use with 026 * the LookupTranslator. 027 * All Maps are generated using <code>java.util.Collections.unmodifiableMap()</code>. 028 * 029 * @since 1.0 030 */ 031public class EntityArrays { 032 033 /** 034 * A Map<CharSequence, CharSequence> to to escape 035 * <a href="https://secure.wikimedia.org/wikipedia/en/wiki/ISO/IEC_8859-1">ISO-8859-1</a> 036 * characters to their named HTML 3.x equivalents. 037 */ 038 public static final Map<CharSequence, CharSequence> ISO8859_1_ESCAPE; 039 static { 040 Map<CharSequence, CharSequence> initialMap = new HashMap<>(); 041 initialMap.put("\u00A0", " "); // non-breaking space 042 initialMap.put("\u00A1", "¡"); // inverted exclamation mark 043 initialMap.put("\u00A2", "¢"); // cent sign 044 initialMap.put("\u00A3", "£"); // pound sign 045 initialMap.put("\u00A4", "¤"); // currency sign 046 initialMap.put("\u00A5", "¥"); // yen sign = yuan sign 047 initialMap.put("\u00A6", "¦"); // broken bar = broken vertical bar 048 initialMap.put("\u00A7", "§"); // section sign 049 initialMap.put("\u00A8", "¨"); // diaeresis = spacing diaeresis 050 initialMap.put("\u00A9", "©"); // © - copyright sign 051 initialMap.put("\u00AA", "ª"); // feminine ordinal indicator 052 initialMap.put("\u00AB", "«"); // left-pointing double angle quotation mark = left pointing guillemet 053 initialMap.put("\u00AC", "¬"); // not sign 054 initialMap.put("\u00AD", "­"); // soft hyphen = discretionary hyphen 055 initialMap.put("\u00AE", "®"); // ® - registered trademark sign 056 initialMap.put("\u00AF", "¯"); // macron = spacing macron = overline = APL overbar 057 initialMap.put("\u00B0", "°"); // degree sign 058 initialMap.put("\u00B1", "±"); // plus-minus sign = plus-or-minus sign 059 initialMap.put("\u00B2", "²"); // superscript two = superscript digit two = squared 060 initialMap.put("\u00B3", "³"); // superscript three = superscript digit three = cubed 061 initialMap.put("\u00B4", "´"); // acute accent = spacing acute 062 initialMap.put("\u00B5", "µ"); // micro sign 063 initialMap.put("\u00B6", "¶"); // pilcrow sign = paragraph sign 064 initialMap.put("\u00B7", "·"); // middle dot = Georgian comma = Greek middle dot 065 initialMap.put("\u00B8", "¸"); // cedilla = spacing cedilla 066 initialMap.put("\u00B9", "¹"); // superscript one = superscript digit one 067 initialMap.put("\u00BA", "º"); // masculine ordinal indicator 068 initialMap.put("\u00BB", "»"); // right-pointing double angle quotation mark = right pointing guillemet 069 initialMap.put("\u00BC", "¼"); // vulgar fraction one quarter = fraction one quarter 070 initialMap.put("\u00BD", "½"); // vulgar fraction one half = fraction one half 071 initialMap.put("\u00BE", "¾"); // vulgar fraction three quarters = fraction three quarters 072 initialMap.put("\u00BF", "¿"); // inverted question mark = turned question mark 073 initialMap.put("\u00C0", "À"); // À - uppercase A, grave accent 074 initialMap.put("\u00C1", "Á"); // Á - uppercase A, acute accent 075 initialMap.put("\u00C2", "Â"); //  - uppercase A, circumflex accent 076 initialMap.put("\u00C3", "Ã"); // à - uppercase A, tilde 077 initialMap.put("\u00C4", "Ä"); // Ä - uppercase A, umlaut 078 initialMap.put("\u00C5", "Å"); // Å - uppercase A, ring 079 initialMap.put("\u00C6", "Æ"); // Æ - uppercase AE 080 initialMap.put("\u00C7", "Ç"); // Ç - uppercase C, cedilla 081 initialMap.put("\u00C8", "È"); // È - uppercase E, grave accent 082 initialMap.put("\u00C9", "É"); // É - uppercase E, acute accent 083 initialMap.put("\u00CA", "Ê"); // Ê - uppercase E, circumflex accent 084 initialMap.put("\u00CB", "Ë"); // Ë - uppercase E, umlaut 085 initialMap.put("\u00CC", "Ì"); // Ì - uppercase I, grave accent 086 initialMap.put("\u00CD", "Í"); // Í - uppercase I, acute accent 087 initialMap.put("\u00CE", "Î"); // Î - uppercase I, circumflex accent 088 initialMap.put("\u00CF", "Ï"); // Ï - uppercase I, umlaut 089 initialMap.put("\u00D0", "Ð"); // Ð - uppercase Eth, Icelandic 090 initialMap.put("\u00D1", "Ñ"); // Ñ - uppercase N, tilde 091 initialMap.put("\u00D2", "Ò"); // Ò - uppercase O, grave accent 092 initialMap.put("\u00D3", "Ó"); // Ó - uppercase O, acute accent 093 initialMap.put("\u00D4", "Ô"); // Ô - uppercase O, circumflex accent 094 initialMap.put("\u00D5", "Õ"); // Õ - uppercase O, tilde 095 initialMap.put("\u00D6", "Ö"); // Ö - uppercase O, umlaut 096 initialMap.put("\u00D7", "×"); // multiplication sign 097 initialMap.put("\u00D8", "Ø"); // Ø - uppercase O, slash 098 initialMap.put("\u00D9", "Ù"); // Ù - uppercase U, grave accent 099 initialMap.put("\u00DA", "Ú"); // Ú - uppercase U, acute accent 100 initialMap.put("\u00DB", "Û"); // Û - uppercase U, circumflex accent 101 initialMap.put("\u00DC", "Ü"); // Ü - uppercase U, umlaut 102 initialMap.put("\u00DD", "Ý"); // Ý - uppercase Y, acute accent 103 initialMap.put("\u00DE", "Þ"); // Þ - uppercase THORN, Icelandic 104 initialMap.put("\u00DF", "ß"); // ß - lowercase sharps, German 105 initialMap.put("\u00E0", "à"); // à - lowercase a, grave accent 106 initialMap.put("\u00E1", "á"); // á - lowercase a, acute accent 107 initialMap.put("\u00E2", "â"); // â - lowercase a, circumflex accent 108 initialMap.put("\u00E3", "ã"); // ã - lowercase a, tilde 109 initialMap.put("\u00E4", "ä"); // ä - lowercase a, umlaut 110 initialMap.put("\u00E5", "å"); // å - lowercase a, ring 111 initialMap.put("\u00E6", "æ"); // æ - lowercase ae 112 initialMap.put("\u00E7", "ç"); // ç - lowercase c, cedilla 113 initialMap.put("\u00E8", "è"); // è - lowercase e, grave accent 114 initialMap.put("\u00E9", "é"); // é - lowercase e, acute accent 115 initialMap.put("\u00EA", "ê"); // ê - lowercase e, circumflex accent 116 initialMap.put("\u00EB", "ë"); // ë - lowercase e, umlaut 117 initialMap.put("\u00EC", "ì"); // ì - lowercase i, grave accent 118 initialMap.put("\u00ED", "í"); // í - lowercase i, acute accent 119 initialMap.put("\u00EE", "î"); // î - lowercase i, circumflex accent 120 initialMap.put("\u00EF", "ï"); // ï - lowercase i, umlaut 121 initialMap.put("\u00F0", "ð"); // ð - lowercase eth, Icelandic 122 initialMap.put("\u00F1", "ñ"); // ñ - lowercase n, tilde 123 initialMap.put("\u00F2", "ò"); // ò - lowercase o, grave accent 124 initialMap.put("\u00F3", "ó"); // ó - lowercase o, acute accent 125 initialMap.put("\u00F4", "ô"); // ô - lowercase o, circumflex accent 126 initialMap.put("\u00F5", "õ"); // õ - lowercase o, tilde 127 initialMap.put("\u00F6", "ö"); // ö - lowercase o, umlaut 128 initialMap.put("\u00F7", "÷"); // division sign 129 initialMap.put("\u00F8", "ø"); // ø - lowercase o, slash 130 initialMap.put("\u00F9", "ù"); // ù - lowercase u, grave accent 131 initialMap.put("\u00FA", "ú"); // ú - lowercase u, acute accent 132 initialMap.put("\u00FB", "û"); // û - lowercase u, circumflex accent 133 initialMap.put("\u00FC", "ü"); // ü - lowercase u, umlaut 134 initialMap.put("\u00FD", "ý"); // ý - lowercase y, acute accent 135 initialMap.put("\u00FE", "þ"); // þ - lowercase thorn, Icelandic 136 initialMap.put("\u00FF", "ÿ"); // ÿ - lowercase y, umlaut 137 ISO8859_1_ESCAPE = Collections.unmodifiableMap(initialMap); 138 } 139 140 /** 141 * Reverse of {@link #ISO8859_1_ESCAPE} for unescaping purposes. 142 */ 143 public static final Map<CharSequence, CharSequence> ISO8859_1_UNESCAPE; 144 static { 145 ISO8859_1_UNESCAPE = Collections.unmodifiableMap(invert(ISO8859_1_ESCAPE)); 146 } 147 148 /** 149 * A Map<CharSequence, CharSequence> to escape additional 150 * <a href="http://www.w3.org/TR/REC-html40/sgml/entities.html">character entity 151 * references</a>. Note that this must be used with {@link #ISO8859_1_ESCAPE} to get the full list of 152 * HTML 4.0 character entities. 153 */ 154 public static final Map<CharSequence, CharSequence> HTML40_EXTENDED_ESCAPE; 155 static { 156 Map<CharSequence, CharSequence> initialMap = new HashMap<>(); 157 // <!-- Latin Extended-B --> 158 initialMap.put("\u0192", "ƒ"); // latin small f with hook = function= florin, U+0192 ISOtech --> 159 // <!-- Greek --> 160 initialMap.put("\u0391", "Α"); // greek capital letter alpha, U+0391 --> 161 initialMap.put("\u0392", "Β"); // greek capital letter beta, U+0392 --> 162 initialMap.put("\u0393", "Γ"); // greek capital letter gamma,U+0393 ISOgrk3 --> 163 initialMap.put("\u0394", "Δ"); // greek capital letter delta,U+0394 ISOgrk3 --> 164 initialMap.put("\u0395", "Ε"); // greek capital letter epsilon, U+0395 --> 165 initialMap.put("\u0396", "Ζ"); // greek capital letter zeta, U+0396 --> 166 initialMap.put("\u0397", "Η"); // greek capital letter eta, U+0397 --> 167 initialMap.put("\u0398", "Θ"); // greek capital letter theta,U+0398 ISOgrk3 --> 168 initialMap.put("\u0399", "Ι"); // greek capital letter iota, U+0399 --> 169 initialMap.put("\u039A", "Κ"); // greek capital letter kappa, U+039A --> 170 initialMap.put("\u039B", "Λ"); // greek capital letter lambda,U+039B ISOgrk3 --> 171 initialMap.put("\u039C", "Μ"); // greek capital letter mu, U+039C --> 172 initialMap.put("\u039D", "Ν"); // greek capital letter nu, U+039D --> 173 initialMap.put("\u039E", "Ξ"); // greek capital letter xi, U+039E ISOgrk3 --> 174 initialMap.put("\u039F", "Ο"); // greek capital letter omicron, U+039F --> 175 initialMap.put("\u03A0", "Π"); // greek capital letter pi, U+03A0 ISOgrk3 --> 176 initialMap.put("\u03A1", "Ρ"); // greek capital letter rho, U+03A1 --> 177 // <!-- there is no Sigmaf, and no U+03A2 character either --> 178 initialMap.put("\u03A3", "Σ"); // greek capital letter sigma,U+03A3 ISOgrk3 --> 179 initialMap.put("\u03A4", "Τ"); // greek capital letter tau, U+03A4 --> 180 initialMap.put("\u03A5", "Υ"); // greek capital letter upsilon,U+03A5 ISOgrk3 --> 181 initialMap.put("\u03A6", "Φ"); // greek capital letter phi,U+03A6 ISOgrk3 --> 182 initialMap.put("\u03A7", "Χ"); // greek capital letter chi, U+03A7 --> 183 initialMap.put("\u03A8", "Ψ"); // greek capital letter psi,U+03A8 ISOgrk3 --> 184 initialMap.put("\u03A9", "Ω"); // greek capital letter omega,U+03A9 ISOgrk3 --> 185 initialMap.put("\u03B1", "α"); // greek small letter alpha,U+03B1 ISOgrk3 --> 186 initialMap.put("\u03B2", "β"); // greek small letter beta, U+03B2 ISOgrk3 --> 187 initialMap.put("\u03B3", "γ"); // greek small letter gamma,U+03B3 ISOgrk3 --> 188 initialMap.put("\u03B4", "δ"); // greek small letter delta,U+03B4 ISOgrk3 --> 189 initialMap.put("\u03B5", "ε"); // greek small letter epsilon,U+03B5 ISOgrk3 --> 190 initialMap.put("\u03B6", "ζ"); // greek small letter zeta, U+03B6 ISOgrk3 --> 191 initialMap.put("\u03B7", "η"); // greek small letter eta, U+03B7 ISOgrk3 --> 192 initialMap.put("\u03B8", "θ"); // greek small letter theta,U+03B8 ISOgrk3 --> 193 initialMap.put("\u03B9", "ι"); // greek small letter iota, U+03B9 ISOgrk3 --> 194 initialMap.put("\u03BA", "κ"); // greek small letter kappa,U+03BA ISOgrk3 --> 195 initialMap.put("\u03BB", "λ"); // greek small letter lambda,U+03BB ISOgrk3 --> 196 initialMap.put("\u03BC", "μ"); // greek small letter mu, U+03BC ISOgrk3 --> 197 initialMap.put("\u03BD", "ν"); // greek small letter nu, U+03BD ISOgrk3 --> 198 initialMap.put("\u03BE", "ξ"); // greek small letter xi, U+03BE ISOgrk3 --> 199 initialMap.put("\u03BF", "ο"); // greek small letter omicron, U+03BF NEW --> 200 initialMap.put("\u03C0", "π"); // greek small letter pi, U+03C0 ISOgrk3 --> 201 initialMap.put("\u03C1", "ρ"); // greek small letter rho, U+03C1 ISOgrk3 --> 202 initialMap.put("\u03C2", "ς"); // greek small letter final sigma,U+03C2 ISOgrk3 --> 203 initialMap.put("\u03C3", "σ"); // greek small letter sigma,U+03C3 ISOgrk3 --> 204 initialMap.put("\u03C4", "τ"); // greek small letter tau, U+03C4 ISOgrk3 --> 205 initialMap.put("\u03C5", "υ"); // greek small letter upsilon,U+03C5 ISOgrk3 --> 206 initialMap.put("\u03C6", "φ"); // greek small letter phi, U+03C6 ISOgrk3 --> 207 initialMap.put("\u03C7", "χ"); // greek small letter chi, U+03C7 ISOgrk3 --> 208 initialMap.put("\u03C8", "ψ"); // greek small letter psi, U+03C8 ISOgrk3 --> 209 initialMap.put("\u03C9", "ω"); // greek small letter omega,U+03C9 ISOgrk3 --> 210 initialMap.put("\u03D1", "ϑ"); // greek small letter theta symbol,U+03D1 NEW --> 211 initialMap.put("\u03D2", "ϒ"); // greek upsilon with hook symbol,U+03D2 NEW --> 212 initialMap.put("\u03D6", "ϖ"); // greek pi symbol, U+03D6 ISOgrk3 --> 213 // <!-- General Punctuation --> 214 initialMap.put("\u2022", "•"); // bullet = black small circle,U+2022 ISOpub --> 215 // <!-- bullet is NOT the same as bullet operator, U+2219 --> 216 initialMap.put("\u2026", "…"); // horizontal ellipsis = three dot leader,U+2026 ISOpub --> 217 initialMap.put("\u2032", "′"); // prime = minutes = feet, U+2032 ISOtech --> 218 initialMap.put("\u2033", "″"); // double prime = seconds = inches,U+2033 ISOtech --> 219 initialMap.put("\u203E", "‾"); // overline = spacing overscore,U+203E NEW --> 220 initialMap.put("\u2044", "⁄"); // fraction slash, U+2044 NEW --> 221 // <!-- Letterlike Symbols --> 222 initialMap.put("\u2118", "℘"); // script capital P = power set= Weierstrass p, U+2118 ISOamso --> 223 initialMap.put("\u2111", "ℑ"); // blackletter capital I = imaginary part,U+2111 ISOamso --> 224 initialMap.put("\u211C", "ℜ"); // blackletter capital R = real part symbol,U+211C ISOamso --> 225 initialMap.put("\u2122", "™"); // trade mark sign, U+2122 ISOnum --> 226 initialMap.put("\u2135", "ℵ"); // alef symbol = first transfinite cardinal,U+2135 NEW --> 227 // <!-- alef symbol is NOT the same as hebrew letter alef,U+05D0 although the 228 // same glyph could be used to depict both characters --> 229 // <!-- Arrows --> 230 initialMap.put("\u2190", "←"); // leftwards arrow, U+2190 ISOnum --> 231 initialMap.put("\u2191", "↑"); // upwards arrow, U+2191 ISOnum--> 232 initialMap.put("\u2192", "→"); // rightwards arrow, U+2192 ISOnum --> 233 initialMap.put("\u2193", "↓"); // downwards arrow, U+2193 ISOnum --> 234 initialMap.put("\u2194", "↔"); // left right arrow, U+2194 ISOamsa --> 235 initialMap.put("\u21B5", "↵"); // downwards arrow with corner leftwards= carriage return, U+21B5 NEW --> 236 initialMap.put("\u21D0", "⇐"); // leftwards double arrow, U+21D0 ISOtech --> 237 // <!-- ISO 10646 does not say that lArr is the same as the 'is implied by' 238 // arrow but also does not have any other character for that function. 239 // So ? lArr canbe used for 'is implied by' as ISOtech suggests --> 240 initialMap.put("\u21D1", "⇑"); // upwards double arrow, U+21D1 ISOamsa --> 241 initialMap.put("\u21D2", "⇒"); // rightwards double arrow,U+21D2 ISOtech --> 242 // <!-- ISO 10646 does not say this is the 'implies' character but does not 243 // have another character with this function so ?rArr can be used for 244 // 'implies' as ISOtech suggests --> 245 initialMap.put("\u21D3", "⇓"); // downwards double arrow, U+21D3 ISOamsa --> 246 initialMap.put("\u21D4", "⇔"); // left right double arrow,U+21D4 ISOamsa --> 247 // <!-- Mathematical Operators --> 248 initialMap.put("\u2200", "∀"); // for all, U+2200 ISOtech --> 249 initialMap.put("\u2202", "∂"); // partial differential, U+2202 ISOtech --> 250 initialMap.put("\u2203", "∃"); // there exists, U+2203 ISOtech --> 251 initialMap.put("\u2205", "∅"); // empty set = null set = diameter,U+2205 ISOamso --> 252 initialMap.put("\u2207", "∇"); // nabla = backward difference,U+2207 ISOtech --> 253 initialMap.put("\u2208", "∈"); // element of, U+2208 ISOtech --> 254 initialMap.put("\u2209", "∉"); // not an element of, U+2209 ISOtech --> 255 initialMap.put("\u220B", "∋"); // contains as member, U+220B ISOtech --> 256 // <!-- should there be a more memorable name than 'ni'? --> 257 initialMap.put("\u220F", "∏"); // n-ary product = product sign,U+220F ISOamsb --> 258 // <!-- prod is NOT the same character as U+03A0 'greek capital letter pi' 259 // though the same glyph might be used for both --> 260 initialMap.put("\u2211", "∑"); // n-ary summation, U+2211 ISOamsb --> 261 // <!-- sum is NOT the same character as U+03A3 'greek capital letter sigma' 262 // though the same glyph might be used for both --> 263 initialMap.put("\u2212", "−"); // minus sign, U+2212 ISOtech --> 264 initialMap.put("\u2217", "∗"); // asterisk operator, U+2217 ISOtech --> 265 initialMap.put("\u221A", "√"); // square root = radical sign,U+221A ISOtech --> 266 initialMap.put("\u221D", "∝"); // proportional to, U+221D ISOtech --> 267 initialMap.put("\u221E", "∞"); // infinity, U+221E ISOtech --> 268 initialMap.put("\u2220", "∠"); // angle, U+2220 ISOamso --> 269 initialMap.put("\u2227", "∧"); // logical and = wedge, U+2227 ISOtech --> 270 initialMap.put("\u2228", "∨"); // logical or = vee, U+2228 ISOtech --> 271 initialMap.put("\u2229", "∩"); // intersection = cap, U+2229 ISOtech --> 272 initialMap.put("\u222A", "∪"); // union = cup, U+222A ISOtech --> 273 initialMap.put("\u222B", "∫"); // integral, U+222B ISOtech --> 274 initialMap.put("\u2234", "∴"); // therefore, U+2234 ISOtech --> 275 initialMap.put("\u223C", "∼"); // tilde operator = varies with = similar to,U+223C ISOtech --> 276 // <!-- tilde operator is NOT the same character as the tilde, U+007E,although 277 // the same glyph might be used to represent both --> 278 initialMap.put("\u2245", "≅"); // approximately equal to, U+2245 ISOtech --> 279 initialMap.put("\u2248", "≈"); // almost equal to = asymptotic to,U+2248 ISOamsr --> 280 initialMap.put("\u2260", "≠"); // not equal to, U+2260 ISOtech --> 281 initialMap.put("\u2261", "≡"); // identical to, U+2261 ISOtech --> 282 initialMap.put("\u2264", "≤"); // less-than or equal to, U+2264 ISOtech --> 283 initialMap.put("\u2265", "≥"); // greater-than or equal to,U+2265 ISOtech --> 284 initialMap.put("\u2282", "⊂"); // subset of, U+2282 ISOtech --> 285 initialMap.put("\u2283", "⊃"); // superset of, U+2283 ISOtech --> 286 // <!-- note that nsup, 'not a superset of, U+2283' is not covered by the 287 // Symbol font encoding and is not included. Should it be, for symmetry? 288 // It is in ISOamsn -->, 289 initialMap.put("\u2284", "⊄"); // not a subset of, U+2284 ISOamsn --> 290 initialMap.put("\u2286", "⊆"); // subset of or equal to, U+2286 ISOtech --> 291 initialMap.put("\u2287", "⊇"); // superset of or equal to,U+2287 ISOtech --> 292 initialMap.put("\u2295", "⊕"); // circled plus = direct sum,U+2295 ISOamsb --> 293 initialMap.put("\u2297", "⊗"); // circled times = vector product,U+2297 ISOamsb --> 294 initialMap.put("\u22A5", "⊥"); // up tack = orthogonal to = perpendicular,U+22A5 ISOtech --> 295 initialMap.put("\u22C5", "⋅"); // dot operator, U+22C5 ISOamsb --> 296 // <!-- dot operator is NOT the same character as U+00B7 middle dot --> 297 // <!-- Miscellaneous Technical --> 298 initialMap.put("\u2308", "⌈"); // left ceiling = apl upstile,U+2308 ISOamsc --> 299 initialMap.put("\u2309", "⌉"); // right ceiling, U+2309 ISOamsc --> 300 initialMap.put("\u230A", "⌊"); // left floor = apl downstile,U+230A ISOamsc --> 301 initialMap.put("\u230B", "⌋"); // right floor, U+230B ISOamsc --> 302 initialMap.put("\u2329", "⟨"); // left-pointing angle bracket = bra,U+2329 ISOtech --> 303 // <!-- lang is NOT the same character as U+003C 'less than' or U+2039 'single left-pointing angle quotation 304 // mark' --> 305 initialMap.put("\u232A", "⟩"); // right-pointing angle bracket = ket,U+232A ISOtech --> 306 // <!-- rang is NOT the same character as U+003E 'greater than' or U+203A 307 // 'single right-pointing angle quotation mark' --> 308 // <!-- Geometric Shapes --> 309 initialMap.put("\u25CA", "◊"); // lozenge, U+25CA ISOpub --> 310 // <!-- Miscellaneous Symbols --> 311 initialMap.put("\u2660", "♠"); // black spade suit, U+2660 ISOpub --> 312 // <!-- black here seems to mean filled as opposed to hollow --> 313 initialMap.put("\u2663", "♣"); // black club suit = shamrock,U+2663 ISOpub --> 314 initialMap.put("\u2665", "♥"); // black heart suit = valentine,U+2665 ISOpub --> 315 initialMap.put("\u2666", "♦"); // black diamond suit, U+2666 ISOpub --> 316 317 // <!-- Latin Extended-A --> 318 initialMap.put("\u0152", "Œ"); // -- latin capital ligature OE,U+0152 ISOlat2 --> 319 initialMap.put("\u0153", "œ"); // -- latin small ligature oe, U+0153 ISOlat2 --> 320 // <!-- ligature is a misnomer, this is a separate character in some languages --> 321 initialMap.put("\u0160", "Š"); // -- latin capital letter S with caron,U+0160 ISOlat2 --> 322 initialMap.put("\u0161", "š"); // -- latin small letter s with caron,U+0161 ISOlat2 --> 323 initialMap.put("\u0178", "Ÿ"); // -- latin capital letter Y with diaeresis,U+0178 ISOlat2 --> 324 // <!-- Spacing Modifier Letters --> 325 initialMap.put("\u02C6", "ˆ"); // -- modifier letter circumflex accent,U+02C6 ISOpub --> 326 initialMap.put("\u02DC", "˜"); // small tilde, U+02DC ISOdia --> 327 // <!-- General Punctuation --> 328 initialMap.put("\u2002", " "); // en space, U+2002 ISOpub --> 329 initialMap.put("\u2003", " "); // em space, U+2003 ISOpub --> 330 initialMap.put("\u2009", " "); // thin space, U+2009 ISOpub --> 331 initialMap.put("\u200C", "‌"); // zero width non-joiner,U+200C NEW RFC 2070 --> 332 initialMap.put("\u200D", "‍"); // zero width joiner, U+200D NEW RFC 2070 --> 333 initialMap.put("\u200E", "‎"); // left-to-right mark, U+200E NEW RFC 2070 --> 334 initialMap.put("\u200F", "‏"); // right-to-left mark, U+200F NEW RFC 2070 --> 335 initialMap.put("\u2013", "–"); // en dash, U+2013 ISOpub --> 336 initialMap.put("\u2014", "—"); // em dash, U+2014 ISOpub --> 337 initialMap.put("\u2018", "‘"); // left single quotation mark,U+2018 ISOnum --> 338 initialMap.put("\u2019", "’"); // right single quotation mark,U+2019 ISOnum --> 339 initialMap.put("\u201A", "‚"); // single low-9 quotation mark, U+201A NEW --> 340 initialMap.put("\u201C", "“"); // left double quotation mark,U+201C ISOnum --> 341 initialMap.put("\u201D", "”"); // right double quotation mark,U+201D ISOnum --> 342 initialMap.put("\u201E", "„"); // double low-9 quotation mark, U+201E NEW --> 343 initialMap.put("\u2020", "†"); // dagger, U+2020 ISOpub --> 344 initialMap.put("\u2021", "‡"); // double dagger, U+2021 ISOpub --> 345 initialMap.put("\u2030", "‰"); // per mille sign, U+2030 ISOtech --> 346 initialMap.put("\u2039", "‹"); // single left-pointing angle quotation mark,U+2039 ISO proposed --> 347 // <!-- lsaquo is proposed but not yet ISO standardized --> 348 initialMap.put("\u203A", "›"); // single right-pointing angle quotation mark,U+203A ISO proposed --> 349 // <!-- rsaquo is proposed but not yet ISO standardized --> 350 initialMap.put("\u20AC", "€"); // -- euro sign, U+20AC NEW --> 351 HTML40_EXTENDED_ESCAPE = Collections.unmodifiableMap(initialMap); 352 } 353 354 /** 355 * Reverse of {@link #HTML40_EXTENDED_ESCAPE} for unescaping purposes. 356 */ 357 public static final Map<CharSequence, CharSequence> HTML40_EXTENDED_UNESCAPE; 358 static { 359 HTML40_EXTENDED_UNESCAPE = Collections.unmodifiableMap(invert(HTML40_EXTENDED_ESCAPE)); 360 } 361 362 /** 363 * A Map<CharSequence, CharSequence> to escape the basic XML and HTML 364 * character entities. 365 * 366 * Namely: {@code " & < >} 367 */ 368 public static final Map<CharSequence, CharSequence> BASIC_ESCAPE; 369 static { 370 Map<CharSequence, CharSequence> initialMap = new HashMap<>(); 371 initialMap.put("\"", """); // " - double-quote 372 initialMap.put("&", "&"); // & - ampersand 373 initialMap.put("<", "<"); // < - less-than 374 initialMap.put(">", ">"); // > - greater-than 375 BASIC_ESCAPE = Collections.unmodifiableMap(initialMap); 376 } 377 378 /** 379 * Reverse of {@link #BASIC_ESCAPE} for unescaping purposes. 380 */ 381 public static final Map<CharSequence, CharSequence> BASIC_UNESCAPE; 382 static { 383 BASIC_UNESCAPE = Collections.unmodifiableMap(invert(BASIC_ESCAPE)); 384 } 385 386 /** 387 * A Map<CharSequence, CharSequence> to escape the apostrophe character to 388 * its XML character entity. 389 */ 390 public static final Map<CharSequence, CharSequence> APOS_ESCAPE; 391 static { 392 Map<CharSequence, CharSequence> initialMap = new HashMap<>(); 393 initialMap.put("'", "'"); // XML apostrophe 394 APOS_ESCAPE = Collections.unmodifiableMap(initialMap); 395 } 396 397 /** 398 * Reverse of {@link #APOS_ESCAPE} for unescaping purposes. 399 */ 400 public static final Map<CharSequence, CharSequence> APOS_UNESCAPE; 401 static { 402 APOS_UNESCAPE = Collections.unmodifiableMap(invert(APOS_ESCAPE)); 403 } 404 405 /** 406 * A Map<CharSequence, CharSequence> to escape the Java 407 * control characters. 408 * 409 * Namely: {@code \b \n \t \f \r} 410 */ 411 public static final Map<CharSequence, CharSequence> JAVA_CTRL_CHARS_ESCAPE; 412 static { 413 Map<CharSequence, CharSequence> initialMap = new HashMap<>(); 414 initialMap.put("\b", "\\b"); 415 initialMap.put("\n", "\\n"); 416 initialMap.put("\t", "\\t"); 417 initialMap.put("\f", "\\f"); 418 initialMap.put("\r", "\\r"); 419 JAVA_CTRL_CHARS_ESCAPE = Collections.unmodifiableMap(initialMap); 420 } 421 422 /** 423 * Reverse of {@link #JAVA_CTRL_CHARS_ESCAPE} for unescaping purposes. 424 */ 425 public static final Map<CharSequence, CharSequence> JAVA_CTRL_CHARS_UNESCAPE; 426 static { 427 JAVA_CTRL_CHARS_UNESCAPE = Collections.unmodifiableMap(invert(JAVA_CTRL_CHARS_ESCAPE)); 428 } 429 430 /** 431 * Used to invert an escape Map into an unescape Map. 432 * @param map Map<String, String> to be inverted 433 * @return Map<String, String> inverted array 434 */ 435 public static Map<CharSequence, CharSequence> invert(final Map<CharSequence, CharSequence> map) { 436 Map<CharSequence, CharSequence> newMap = new HashMap<>(); 437 Iterator<Map.Entry<CharSequence, CharSequence>> it = map.entrySet().iterator(); 438 while (it.hasNext()) { 439 Map.Entry<CharSequence, CharSequence> pair = it.next(); 440 newMap.put((CharSequence) pair.getValue(), (CharSequence) pair.getKey()); 441 } 442 return newMap; 443 } 444 445}