    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.lang3.text.translate;
    018
    019/**
    020 * Class holding various entity data for HTML and XML - generally for use with
    021 * the LookupTranslator.
    022 * All arrays are of length [*][2].
    023 *
    024 * @since 3.0
    025 * @deprecated as of 3.6, use commons-text
    026 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
    027 * EntityArrays</a> instead
    028 */
    029@Deprecated
    030public class EntityArrays {
    031
    032    /**
    033     * Mapping to escape <a href="https://secure.wikimedia.org/wikipedia/en/wiki/ISO/IEC_8859-1">ISO-8859-1</a>
    034     * characters to their named HTML 3.x equivalents.
    035     * @return the mapping table
    036     */
    037    public static String[][] ISO8859_1_ESCAPE() {
    038        return ISO8859_1_ESCAPE.clone();
    039    }
    040
    041    private static final String[][] ISO8859_1_ESCAPE = {
    042        {"\u00A0", "&nbsp;"}, // non-breaking space
    043        {"\u00A1", "&iexcl;"}, // inverted exclamation mark
    044        {"\u00A2", "&cent;"}, // cent sign
    045        {"\u00A3", "&pound;"}, // pound sign
    046        {"\u00A4", "&curren;"}, // currency sign
    047        {"\u00A5", "&yen;"}, // yen sign = yuan sign
    048        {"\u00A6", "&brvbar;"}, // broken bar = broken vertical bar
    049        {"\u00A7", "&sect;"}, // section sign
    050        {"\u00A8", "&uml;"}, // diaeresis = spacing diaeresis
    051        {"\u00A9", "&copy;"}, // © - copyright sign
    052        {"\u00AA", "&ordf;"}, // feminine ordinal indicator
    053        {"\u00AB", "&laquo;"}, // left-pointing double angle quotation mark = left pointing guillemet
    054        {"\u00AC", "&not;"}, // not sign
    055        {"\u00AD", "&shy;"}, // soft hyphen = discretionary hyphen
    056        {"\u00AE", "&reg;"}, // ® - registered trademark sign
    057        {"\u00AF", "&macr;"}, // macron = spacing macron = overline = APL overbar
    058        {"\u00B0", "&deg;"}, // degree sign
    059        {"\u00B1", "&plusmn;"}, // plus-minus sign = plus-or-minus sign
    060        {"\u00B2", "&sup2;"}, // superscript two = superscript digit two = squared
    061        {"\u00B3", "&sup3;"}, // superscript three = superscript digit three = cubed
    062        {"\u00B4", "&acute;"}, // acute accent = spacing acute
    063        {"\u00B5", "&micro;"}, // micro sign
    064        {"\u00B6", "&para;"}, // pilcrow sign = paragraph sign
    065        {"\u00B7", "&middot;"}, // middle dot = Georgian comma = Greek middle dot
    066        {"\u00B8", "&cedil;"}, // cedilla = spacing cedilla
    067        {"\u00B9", "&sup1;"}, // superscript one = superscript digit one
    068        {"\u00BA", "&ordm;"}, // masculine ordinal indicator
    069        {"\u00BB", "&raquo;"}, // right-pointing double angle quotation mark = right pointing guillemet
    070        {"\u00BC", "&frac14;"}, // vulgar fraction one quarter = fraction one quarter
    071        {"\u00BD", "&frac12;"}, // vulgar fraction one half = fraction one half
    072        {"\u00BE", "&frac34;"}, // vulgar fraction three quarters = fraction three quarters
    073        {"\u00BF", "&iquest;"}, // inverted question mark = turned question mark
    074        {"\u00C0", "&Agrave;"}, // À - uppercase A, grave accent
    075        {"\u00C1", "&Aacute;"}, // Á - uppercase A, acute accent
    076        {"\u00C2", "&Acirc;"}, // Â - uppercase A, circumflex accent
    077        {"\u00C3", "&Atilde;"}, // Ã - uppercase A, tilde
    078        {"\u00C4", "&Auml;"}, // Ä - uppercase A, umlaut
    079        {"\u00C5", "&Aring;"}, // Å - uppercase A, ring
    080        {"\u00C6", "&AElig;"}, // Æ - uppercase AE
    081        {"\u00C7", "&Ccedil;"}, // Ç - uppercase C, cedilla
    082        {"\u00C8", "&Egrave;"}, // È - uppercase E, grave accent
    083        {"\u00C9", "&Eacute;"}, // É - uppercase E, acute accent
    084        {"\u00CA", "&Ecirc;"}, // Ê - uppercase E, circumflex accent
    085        {"\u00CB", "&Euml;"}, // Ë - uppercase E, umlaut
    086        {"\u00CC", "&Igrave;"}, // Ì - uppercase I, grave accent
    087        {"\u00CD", "&Iacute;"}, // Í - uppercase I, acute accent
    088        {"\u00CE", "&Icirc;"}, // Î - uppercase I, circumflex accent
    089        {"\u00CF", "&Iuml;"}, // Ï - uppercase I, umlaut
    090        {"\u00D0", "&ETH;"}, // Ð - uppercase Eth, Icelandic
    091        {"\u00D1", "&Ntilde;"}, // Ñ - uppercase N, tilde
    092        {"\u00D2", "&Ograve;"}, // Ò - uppercase O, grave accent
    093        {"\u00D3", "&Oacute;"}, // Ó - uppercase O, acute accent
    094        {"\u00D4", "&Ocirc;"}, // Ô - uppercase O, circumflex accent
    095        {"\u00D5", "&Otilde;"}, // Õ - uppercase O, tilde
    096        {"\u00D6", "&Ouml;"}, // Ö - uppercase O, umlaut
    097        {"\u00D7", "&times;"}, // multiplication sign
    098        {"\u00D8", "&Oslash;"}, // Ø - uppercase O, slash
    099        {"\u00D9", "&Ugrave;"}, // Ù - uppercase U, grave accent
    100        {"\u00DA", "&Uacute;"}, // Ú - uppercase U, acute accent
    101        {"\u00DB", "&Ucirc;"}, // Û - uppercase U, circumflex accent
    102        {"\u00DC", "&Uuml;"}, // Ü - uppercase U, umlaut
    103        {"\u00DD", "&Yacute;"}, // Ý - uppercase Y, acute accent
    104        {"\u00DE", "&THORN;"}, // Þ - uppercase THORN, Icelandic
    105        {"\u00DF", "&szlig;"}, // ß - lowercase sharps, German
    106        {"\u00E0", "&agrave;"}, // à - lowercase a, grave accent
    107        {"\u00E1", "&aacute;"}, // á - lowercase a, acute accent
    108        {"\u00E2", "&acirc;"}, // â - lowercase a, circumflex accent
    109        {"\u00E3", "&atilde;"}, // ã - lowercase a, tilde
    110        {"\u00E4", "&auml;"}, // ä - lowercase a, umlaut
    111        {"\u00E5", "&aring;"}, // å - lowercase a, ring
    112        {"\u00E6", "&aelig;"}, // æ - lowercase ae
    113        {"\u00E7", "&ccedil;"}, // ç - lowercase c, cedilla
    114        {"\u00E8", "&egrave;"}, // è - lowercase e, grave accent
    115        {"\u00E9", "&eacute;"}, // é - lowercase e, acute accent
    116        {"\u00EA", "&ecirc;"}, // ê - lowercase e, circumflex accent
    117        {"\u00EB", "&euml;"}, // ë - lowercase e, umlaut
    118        {"\u00EC", "&igrave;"}, // ì - lowercase i, grave accent
    119        {"\u00ED", "&iacute;"}, // í - lowercase i, acute accent
    120        {"\u00EE", "&icirc;"}, // î - lowercase i, circumflex accent
    121        {"\u00EF", "&iuml;"}, // ï - lowercase i, umlaut
    122        {"\u00F0", "&eth;"}, // ð - lowercase eth, Icelandic
    123        {"\u00F1", "&ntilde;"}, // ñ - lowercase n, tilde
    124        {"\u00F2", "&ograve;"}, // ò - lowercase o, grave accent
    125        {"\u00F3", "&oacute;"}, // ó - lowercase o, acute accent
    126        {"\u00F4", "&ocirc;"}, // ô - lowercase o, circumflex accent
    127        {"\u00F5", "&otilde;"}, // õ - lowercase o, tilde
    128        {"\u00F6", "&ouml;"}, // ö - lowercase o, umlaut
    129        {"\u00F7", "&divide;"}, // division sign
    130        {"\u00F8", "&oslash;"}, // ø - lowercase o, slash
    131        {"\u00F9", "&ugrave;"}, // ù - lowercase u, grave accent
    132        {"\u00FA", "&uacute;"}, // ú - lowercase u, acute accent
    133        {"\u00FB", "&ucirc;"}, // û - lowercase u, circumflex accent
    134        {"\u00FC", "&uuml;"}, // ü - lowercase u, umlaut
    135        {"\u00FD", "&yacute;"}, // ý - lowercase y, acute accent
    136        {"\u00FE", "&thorn;"}, // þ - lowercase thorn, Icelandic
    137        {"\u00FF", "&yuml;"}, // ÿ - lowercase y, umlaut
    138    };
    139
    140    /**
    141     * Reverse of {@link #ISO8859_1_ESCAPE()} for unescaping purposes.
    142     * @return the mapping table
    143     */
    144    public static String[][] ISO8859_1_UNESCAPE() {
    145        return ISO8859_1_UNESCAPE.clone();
    146    }
    147
    148    private static final String[][] ISO8859_1_UNESCAPE = invert(ISO8859_1_ESCAPE);
    149
    150    /**
    151     * Mapping to escape additional <a href="http://www.w3.org/TR/REC-html40/sgml/entities.html">character entity
    152     * references</a>. Note that this must be used with {@link #ISO8859_1_ESCAPE()} to get the full list of
    153     * HTML 4.0 character entities.
    154     * @return the mapping table
    155     */
    156    public static String[][] HTML40_EXTENDED_ESCAPE() {
    157        return HTML40_EXTENDED_ESCAPE.clone();
    158    }
    159
    160    private static final String[][] HTML40_EXTENDED_ESCAPE = {
    161        // <!-- Latin Extended-B -->
    162        {"\u0192", "&fnof;"}, // latin small f with hook = function= florin, U+0192 ISOtech -->
    163        // <!-- Greek -->
    164        {"\u0391", "&Alpha;"}, // greek capital letter alpha, U+0391 -->
    165        {"\u0392", "&Beta;"}, // greek capital letter beta, U+0392 -->
    166        {"\u0393", "&Gamma;"}, // greek capital letter gamma,U+0393 ISOgrk3 -->
    167        {"\u0394", "&Delta;"}, // greek capital letter delta,U+0394 ISOgrk3 -->
    168        {"\u0395", "&Epsilon;"}, // greek capital letter epsilon, U+0395 -->
    169        {"\u0396", "&Zeta;"}, // greek capital letter zeta, U+0396 -->
    170        {"\u0397", "&Eta;"}, // greek capital letter eta, U+0397 -->
    171        {"\u0398", "&Theta;"}, // greek capital letter theta,U+0398 ISOgrk3 -->
    172        {"\u0399", "&Iota;"}, // greek capital letter iota, U+0399 -->
    173        {"\u039A", "&Kappa;"}, // greek capital letter kappa, U+039A -->
    174        {"\u039B", "&Lambda;"}, // greek capital letter lambda,U+039B ISOgrk3 -->
    175        {"\u039C", "&Mu;"}, // greek capital letter mu, U+039C -->
    176        {"\u039D", "&Nu;"}, // greek capital letter nu, U+039D -->
    177        {"\u039E", "&Xi;"}, // greek capital letter xi, U+039E ISOgrk3 -->
    178        {"\u039F", "&Omicron;"}, // greek capital letter omicron, U+039F -->
    179        {"\u03A0", "&Pi;"}, // greek capital letter pi, U+03A0 ISOgrk3 -->
    180        {"\u03A1", "&Rho;"}, // greek capital letter rho, U+03A1 -->
    181        // <!-- there is no Sigmaf, and no U+03A2 character either -->
    182        {"\u03A3", "&Sigma;"}, // greek capital letter sigma,U+03A3 ISOgrk3 -->
    183        {"\u03A4", "&Tau;"}, // greek capital letter tau, U+03A4 -->
    184        {"\u03A5", "&Upsilon;"}, // greek capital letter upsilon,U+03A5 ISOgrk3 -->
    185        {"\u03A6", "&Phi;"}, // greek capital letter phi,U+03A6 ISOgrk3 -->
    186        {"\u03A7", "&Chi;"}, // greek capital letter chi, U+03A7 -->
    187        {"\u03A8", "&Psi;"}, // greek capital letter psi,U+03A8 ISOgrk3 -->
    188        {"\u03A9", "&Omega;"}, // greek capital letter omega,U+03A9 ISOgrk3 -->
    189        {"\u03B1", "&alpha;"}, // greek small letter alpha,U+03B1 ISOgrk3 -->
    190        {"\u03B2", "&beta;"}, // greek small letter beta, U+03B2 ISOgrk3 -->
    191        {"\u03B3", "&gamma;"}, // greek small letter gamma,U+03B3 ISOgrk3 -->
    192        {"\u03B4", "&delta;"}, // greek small letter delta,U+03B4 ISOgrk3 -->
    193        {"\u03B5", "&epsilon;"}, // greek small letter epsilon,U+03B5 ISOgrk3 -->
    194        {"\u03B6", "&zeta;"}, // greek small letter zeta, U+03B6 ISOgrk3 -->
    195        {"\u03B7", "&eta;"}, // greek small letter eta, U+03B7 ISOgrk3 -->
    196        {"\u03B8", "&theta;"}, // greek small letter theta,U+03B8 ISOgrk3 -->
    197        {"\u03B9", "&iota;"}, // greek small letter iota, U+03B9 ISOgrk3 -->
    198        {"\u03BA", "&kappa;"}, // greek small letter kappa,U+03BA ISOgrk3 -->
    199        {"\u03BB", "&lambda;"}, // greek small letter lambda,U+03BB ISOgrk3 -->
    200        {"\u03BC", "&mu;"}, // greek small letter mu, U+03BC ISOgrk3 -->
    201        {"\u03BD", "&nu;"}, // greek small letter nu, U+03BD ISOgrk3 -->
    202        {"\u03BE", "&xi;"}, // greek small letter xi, U+03BE ISOgrk3 -->
    203        {"\u03BF", "&omicron;"}, // greek small letter omicron, U+03BF NEW -->
    204        {"\u03C0", "&pi;"}, // greek small letter pi, U+03C0 ISOgrk3 -->
    205        {"\u03C1", "&rho;"}, // greek small letter rho, U+03C1 ISOgrk3 -->
    206        {"\u03C2", "&sigmaf;"}, // greek small letter final sigma,U+03C2 ISOgrk3 -->
    207        {"\u03C3", "&sigma;"}, // greek small letter sigma,U+03C3 ISOgrk3 -->
    208        {"\u03C4", "&tau;"}, // greek small letter tau, U+03C4 ISOgrk3 -->
    209        {"\u03C5", "&upsilon;"}, // greek small letter upsilon,U+03C5 ISOgrk3 -->
    210        {"\u03C6", "&phi;"}, // greek small letter phi, U+03C6 ISOgrk3 -->
    211        {"\u03C7", "&chi;"}, // greek small letter chi, U+03C7 ISOgrk3 -->
    212        {"\u03C8", "&psi;"}, // greek small letter psi, U+03C8 ISOgrk3 -->
    213        {"\u03C9", "&omega;"}, // greek small letter omega,U+03C9 ISOgrk3 -->
    214        {"\u03D1", "&thetasym;"}, // greek small letter theta symbol,U+03D1 NEW -->
    215        {"\u03D2", "&upsih;"}, // greek upsilon with hook symbol,U+03D2 NEW -->
    216        {"\u03D6", "&piv;"}, // greek pi symbol, U+03D6 ISOgrk3 -->
    217        // <!-- General Punctuation -->
    218        {"\u2022", "&bull;"}, // bullet = black small circle,U+2022 ISOpub -->
    219        // <!-- bullet is NOT the same as bullet operator, U+2219 -->
    220        {"\u2026", "&hellip;"}, // horizontal ellipsis = three dot leader,U+2026 ISOpub -->
    221        {"\u2032", "&prime;"}, // prime = minutes = feet, U+2032 ISOtech -->
    222        {"\u2033", "&Prime;"}, // double prime = seconds = inches,U+2033 ISOtech -->
    223        {"\u203E", "&oline;"}, // overline = spacing overscore,U+203E NEW -->
    224        {"\u2044", "&frasl;"}, // fraction slash, U+2044 NEW -->
    225        // <!-- Letterlike Symbols -->
    226        {"\u2118", "&weierp;"}, // script capital P = power set= Weierstrass p, U+2118 ISOamso -->
    227        {"\u2111", "&image;"}, // blackletter capital I = imaginary part,U+2111 ISOamso -->
    228        {"\u211C", "&real;"}, // blackletter capital R = real part symbol,U+211C ISOamso -->
    229        {"\u2122", "&trade;"}, // trade mark sign, U+2122 ISOnum -->
    230        {"\u2135", "&alefsym;"}, // alef symbol = first transfinite cardinal,U+2135 NEW -->
    231        // <!-- alef symbol is NOT the same as hebrew letter alef,U+05D0 although the
    232        // same glyph could be used to depict both characters -->
    233        // <!-- Arrows -->
    234        {"\u2190", "&larr;"}, // leftwards arrow, U+2190 ISOnum -->
    235        {"\u2191", "&uarr;"}, // upwards arrow, U+2191 ISOnum-->
    236        {"\u2192", "&rarr;"}, // rightwards arrow, U+2192 ISOnum -->
    237        {"\u2193", "&darr;"}, // downwards arrow, U+2193 ISOnum -->
    238        {"\u2194", "&harr;"}, // left right arrow, U+2194 ISOamsa -->
    239        {"\u21B5", "&crarr;"}, // downwards arrow with corner leftwards= carriage return, U+21B5 NEW -->
    240        {"\u21D0", "&lArr;"}, // leftwards double arrow, U+21D0 ISOtech -->
    241        // <!-- ISO 10646 does not say that lArr is the same as the 'is implied by'
    242        // arrow but also does not have any other character for that function.
    243        // So ? lArr canbe used for 'is implied by' as ISOtech suggests -->
    244        {"\u21D1", "&uArr;"}, // upwards double arrow, U+21D1 ISOamsa -->
    245        {"\u21D2", "&rArr;"}, // rightwards double arrow,U+21D2 ISOtech -->
    246        // <!-- ISO 10646 does not say this is the 'implies' character but does not
    247        // have another character with this function so ?rArr can be used for
    248        // 'implies' as ISOtech suggests -->
    249        {"\u21D3", "&dArr;"}, // downwards double arrow, U+21D3 ISOamsa -->
    250        {"\u21D4", "&hArr;"}, // left right double arrow,U+21D4 ISOamsa -->
    251        // <!-- Mathematical Operators -->
    252        {"\u2200", "&forall;"}, // for all, U+2200 ISOtech -->
    253        {"\u2202", "&part;"}, // partial differential, U+2202 ISOtech -->
    254        {"\u2203", "&exist;"}, // there exists, U+2203 ISOtech -->
    255        {"\u2205", "&empty;"}, // empty set = null set = diameter,U+2205 ISOamso -->
    256        {"\u2207", "&nabla;"}, // nabla = backward difference,U+2207 ISOtech -->
    257        {"\u2208", "&isin;"}, // element of, U+2208 ISOtech -->
    258        {"\u2209", "&notin;"}, // not an element of, U+2209 ISOtech -->
    259        {"\u220B", "&ni;"}, // contains as member, U+220B ISOtech -->
    260        // <!-- should there be a more memorable name than 'ni'? -->
    261        {"\u220F", "&prod;"}, // n-ary product = product sign,U+220F ISOamsb -->
    262        // <!-- prod is NOT the same character as U+03A0 'greek capital letter pi'
    263        // though the same glyph might be used for both -->
    264        {"\u2211", "&sum;"}, // n-ary summation, U+2211 ISOamsb -->
    265        // <!-- sum is NOT the same character as U+03A3 'greek capital letter sigma'
    266        // though the same glyph might be used for both -->
    267        {"\u2212", "&minus;"}, // minus sign, U+2212 ISOtech -->
    268        {"\u2217", "&lowast;"}, // asterisk operator, U+2217 ISOtech -->
    269        {"\u221A", "&radic;"}, // square root = radical sign,U+221A ISOtech -->
    270        {"\u221D", "&prop;"}, // proportional to, U+221D ISOtech -->
    271        {"\u221E", "&infin;"}, // infinity, U+221E ISOtech -->
    272        {"\u2220", "&ang;"}, // angle, U+2220 ISOamso -->
    273        {"\u2227", "&and;"}, // logical and = wedge, U+2227 ISOtech -->
    274        {"\u2228", "&or;"}, // logical or = vee, U+2228 ISOtech -->
    275        {"\u2229", "&cap;"}, // intersection = cap, U+2229 ISOtech -->
    276        {"\u222A", "&cup;"}, // union = cup, U+222A ISOtech -->
    277        {"\u222B", "&int;"}, // integral, U+222B ISOtech -->
    278        {"\u2234", "&there4;"}, // therefore, U+2234 ISOtech -->
    279        {"\u223C", "&sim;"}, // tilde operator = varies with = similar to,U+223C ISOtech -->
    280        // <!-- tilde operator is NOT the same character as the tilde, U+007E,although
    281        // the same glyph might be used to represent both -->
    282        {"\u2245", "&cong;"}, // approximately equal to, U+2245 ISOtech -->
    283        {"\u2248", "&asymp;"}, // almost equal to = asymptotic to,U+2248 ISOamsr -->
    284        {"\u2260", "&ne;"}, // not equal to, U+2260 ISOtech -->
    285        {"\u2261", "&equiv;"}, // identical to, U+2261 ISOtech -->
    286        {"\u2264", "&le;"}, // less-than or equal to, U+2264 ISOtech -->
    287        {"\u2265", "&ge;"}, // greater-than or equal to,U+2265 ISOtech -->
    288        {"\u2282", "&sub;"}, // subset of, U+2282 ISOtech -->
    289        {"\u2283", "&sup;"}, // superset of, U+2283 ISOtech -->
    290        // <!-- note that nsup, 'not a superset of, U+2283' is not covered by the
    291        // Symbol font encoding and is not included. Should it be, for symmetry?
    292        // It is in ISOamsn -->,
    293        {"\u2284", "&nsub;"}, // not a subset of, U+2284 ISOamsn -->
    294        {"\u2286", "&sube;"}, // subset of or equal to, U+2286 ISOtech -->
    295        {"\u2287", "&supe;"}, // superset of or equal to,U+2287 ISOtech -->
    296        {"\u2295", "&oplus;"}, // circled plus = direct sum,U+2295 ISOamsb -->
    297        {"\u2297", "&otimes;"}, // circled times = vector product,U+2297 ISOamsb -->
    298        {"\u22A5", "&perp;"}, // up tack = orthogonal to = perpendicular,U+22A5 ISOtech -->
    299        {"\u22C5", "&sdot;"}, // dot operator, U+22C5 ISOamsb -->
    300        // <!-- dot operator is NOT the same character as U+00B7 middle dot -->
    301        // <!-- Miscellaneous Technical -->
    302        {"\u2308", "&lceil;"}, // left ceiling = apl upstile,U+2308 ISOamsc -->
    303        {"\u2309", "&rceil;"}, // right ceiling, U+2309 ISOamsc -->
    304        {"\u230A", "&lfloor;"}, // left floor = apl downstile,U+230A ISOamsc -->
    305        {"\u230B", "&rfloor;"}, // right floor, U+230B ISOamsc -->
    306        {"\u2329", "&lang;"}, // left-pointing angle bracket = bra,U+2329 ISOtech -->
    307        // <!-- lang is NOT the same character as U+003C 'less than' or U+2039 'single left-pointing angle quotation
    308        // mark' -->
    309        {"\u232A", "&rang;"}, // right-pointing angle bracket = ket,U+232A ISOtech -->
    310        // <!-- rang is NOT the same character as U+003E 'greater than' or U+203A
    311        // 'single right-pointing angle quotation mark' -->
    312        // <!-- Geometric Shapes -->
    313        {"\u25CA", "&loz;"}, // lozenge, U+25CA ISOpub -->
    314        // <!-- Miscellaneous Symbols -->
    315        {"\u2660", "&spades;"}, // black spade suit, U+2660 ISOpub -->
    316        // <!-- black here seems to mean filled as opposed to hollow -->
    317        {"\u2663", "&clubs;"}, // black club suit = shamrock,U+2663 ISOpub -->
    318        {"\u2665", "&hearts;"}, // black heart suit = valentine,U+2665 ISOpub -->
    319        {"\u2666", "&diams;"}, // black diamond suit, U+2666 ISOpub -->
    320
    321        // <!-- Latin Extended-A -->
    322        {"\u0152", "&OElig;"}, // -- latin capital ligature OE,U+0152 ISOlat2 -->
    323        {"\u0153", "&oelig;"}, // -- latin small ligature oe, U+0153 ISOlat2 -->
    324        // <!-- ligature is a misnomer, this is a separate character in some languages -->
    325        {"\u0160", "&Scaron;"}, // -- latin capital letter S with caron,U+0160 ISOlat2 -->
    326        {"\u0161", "&scaron;"}, // -- latin small letter s with caron,U+0161 ISOlat2 -->
    327        {"\u0178", "&Yuml;"}, // -- latin capital letter Y with diaeresis,U+0178 ISOlat2 -->
    328        // <!-- Spacing Modifier Letters -->
    329        {"\u02C6", "&circ;"}, // -- modifier letter circumflex accent,U+02C6 ISOpub -->
    330        {"\u02DC", "&tilde;"}, // small tilde, U+02DC ISOdia -->
    331        // <!-- General Punctuation -->
    332        {"\u2002", "&ensp;"}, // en space, U+2002 ISOpub -->
    333        {"\u2003", "&emsp;"}, // em space, U+2003 ISOpub -->
    334        {"\u2009", "&thinsp;"}, // thin space, U+2009 ISOpub -->
    335        {"\u200C", "&zwnj;"}, // zero width non-joiner,U+200C NEW RFC 2070 -->
    336        {"\u200D", "&zwj;"}, // zero width joiner, U+200D NEW RFC 2070 -->
    337        {"\u200E", "&lrm;"}, // left-to-right mark, U+200E NEW RFC 2070 -->
    338        {"\u200F", "&rlm;"}, // right-to-left mark, U+200F NEW RFC 2070 -->
    339        {"\u2013", "&ndash;"}, // en dash, U+2013 ISOpub -->
    340        {"\u2014", "&mdash;"}, // em dash, U+2014 ISOpub -->
    341        {"\u2018", "&lsquo;"}, // left single quotation mark,U+2018 ISOnum -->
    342        {"\u2019", "&rsquo;"}, // right single quotation mark,U+2019 ISOnum -->
    343        {"\u201A", "&sbquo;"}, // single low-9 quotation mark, U+201A NEW -->
    344        {"\u201C", "&ldquo;"}, // left double quotation mark,U+201C ISOnum -->
    345        {"\u201D", "&rdquo;"}, // right double quotation mark,U+201D ISOnum -->
    346        {"\u201E", "&bdquo;"}, // double low-9 quotation mark, U+201E NEW -->
    347        {"\u2020", "&dagger;"}, // dagger, U+2020 ISOpub -->
    348        {"\u2021", "&Dagger;"}, // double dagger, U+2021 ISOpub -->
    349        {"\u2030", "&permil;"}, // per mille sign, U+2030 ISOtech -->
    350        {"\u2039", "&lsaquo;"}, // single left-pointing angle quotation mark,U+2039 ISO proposed -->
    351        // <!-- lsaquo is proposed but not yet ISO standardized -->
    352        {"\u203A", "&rsaquo;"}, // single right-pointing angle quotation mark,U+203A ISO proposed -->
    353        // <!-- rsaquo is proposed but not yet ISO standardized -->
    354        {"\u20AC", "&euro;"}, // -- euro sign, U+20AC NEW -->
    355    };
    356
    357    /**
    358     * Reverse of {@link #HTML40_EXTENDED_ESCAPE()} for unescaping purposes.
    359     * @return the mapping table
    360     */
    361    public static String[][] HTML40_EXTENDED_UNESCAPE() {
    362        return HTML40_EXTENDED_UNESCAPE.clone();
    363    }
    364
    365    private static final String[][] HTML40_EXTENDED_UNESCAPE = invert(HTML40_EXTENDED_ESCAPE);
    366
    367    /**
    368     * Mapping to escape the basic XML and HTML character entities.
    369     *
    370     * Namely: {@code " & < >}
    371     * @return the mapping table
    372     */
    373    public static String[][] BASIC_ESCAPE() {
    374        return BASIC_ESCAPE.clone();
    375    }
    376
    377    private static final String[][] BASIC_ESCAPE = {
    378        {"\"", "&quot;"}, // " - double-quote
    379        {"&", "&amp;"},   // & - ampersand
    380        {"<", "&lt;"},    // < - less-than
    381        {">", "&gt;"},    // > - greater-than
    382    };
    383
    384    /**
    385     * Reverse of {@link #BASIC_ESCAPE()} for unescaping purposes.
    386     * @return the mapping table
    387     */
    388    public static String[][] BASIC_UNESCAPE() {
    389        return BASIC_UNESCAPE.clone();
    390    }
    391
    392    private static final String[][] BASIC_UNESCAPE = invert(BASIC_ESCAPE);
    393
    394    /**
    395     * Mapping to escape the apostrophe character to its XML character entity.
    396     * @return the mapping table
    397     */
    398    public static String[][] APOS_ESCAPE() {
    399        return APOS_ESCAPE.clone();
    400    }
    401
    402    private static final String[][] APOS_ESCAPE = {
    403        {"'", "&apos;"}, // XML apostrophe
    404    };
    405
    406    /**
    407     * Reverse of {@link #APOS_ESCAPE()} for unescaping purposes.
    408     * @return the mapping table
    409     */
    410    public static String[][] APOS_UNESCAPE() {
    411        return APOS_UNESCAPE.clone();
    412    }
    413
    414    private static final String[][] APOS_UNESCAPE = invert(APOS_ESCAPE);
    415
    416    /**
    417     * Mapping to escape the Java control characters.
    418     *
    419     * Namely: {@code \b \n \t \f \r}
    420     * @return the mapping table
    421     */
    422    public static String[][] JAVA_CTRL_CHARS_ESCAPE() {
    423        return JAVA_CTRL_CHARS_ESCAPE.clone();
    424    }
    425
    426    private static final String[][] JAVA_CTRL_CHARS_ESCAPE = {
    427        {"\b", "\\b"},
    428        {"\n", "\\n"},
    429        {"\t", "\\t"},
    430        {"\f", "\\f"},
    431        {"\r", "\\r"}
    432    };
    433
    434    /**
    435     * Reverse of {@link #JAVA_CTRL_CHARS_ESCAPE()} for unescaping purposes.
    436     * @return the mapping table
    437     */
    438    public static String[][] JAVA_CTRL_CHARS_UNESCAPE() {
    439        return JAVA_CTRL_CHARS_UNESCAPE.clone();
    440    }
    441
    442    private static final String[][] JAVA_CTRL_CHARS_UNESCAPE = invert(JAVA_CTRL_CHARS_ESCAPE);
    443
    444    /**
    445     * Used to invert an escape array into an unescape array
    446     * @param array String[][] to be inverted
    447     * @return String[][] inverted array
    448     */
    449    public static String[][] invert(final String[][] array) {
    450        final String[][] newarray = new String[array.length][2];
    451        for(int i = 0; i<array.length; i++) {
    452            newarray[i][0] = array[i][1];
    453            newarray[i][1] = array[i][0];
    454        }
    455        return newarray;
    456    }
    457
    458}