/*

 * Copyright (c) 2002, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.lang;

import java.util.Arrays;

import java.util.Map;

import java.util.HashMap;

import java.util.Locale;

/**

 * The {@code Character} class wraps a value of the primitive

 * type {@code char} in an object. An object of class

 * {@code Character} contains a single field whose type is

 * {@code char}.

 * <p>

 * In addition, this class provides a large number of static methods for

 * determining a character's category (lowercase letter, digit, etc.)

 * and for converting characters from uppercase to lowercase and vice

 * versa.

 *

 * <h3><a id="conformance">Unicode Conformance</a></h3>

 * <p>

 * The fields and methods of class {@code Character} are defined in terms

 * of character information from the Unicode Standard, specifically the

 * <i>UnicodeData</i> file that is part of the Unicode Character Database.

 * This file specifies properties including name and category for every

 * assigned Unicode code point or character range. The file is available

 * from the Unicode Consortium at

 * <a href="http://www.unicode.org">http://www.unicode.org</a>.

 * <p>

 * The Java SE 8 Platform uses character information from version 6.2

 * of the Unicode Standard, with two extensions. First, the Java SE 8 Platform

 * allows an implementation of class {@code Character} to use the Japanese Era

 * code point, {@code U+32FF}, from the first version of the Unicode Standard

 * after 6.2 that assigns the code point. Second, in recognition of the fact

 * that new currencies appear frequently, the Java SE 8 Platform allows an

 * implementation of class {@code Character} to use the Currency Symbols

 * block from version 10.0 of the Unicode Standard. Consequently, the

 * behavior of fields and methods of class {@code Character} may vary across

 * implementations of the Java SE 8 Platform when processing the aforementioned

 * code points ( outside of version 6.2 ), except for the following methods

 * that define Java identifiers:

 * {@link #isJavaIdentifierStart(int)}, {@link #isJavaIdentifierStart(char)},

 * {@link #isJavaIdentifierPart(int)}, and {@link #isJavaIdentifierPart(char)}.

 * Code points in Java identifiers must be drawn from version 6.2 of

 * the Unicode Standard.

 *

 * <h3><a name="unicode">Unicode Character Representations</a></h3>

 *

 * <p>The {@code char} data type (and therefore the value that a

 * {@code Character} object encapsulates) are based on the

 * original Unicode specification, which defined characters as

 * fixed-width 16-bit entities. The Unicode Standard has since been

 * changed to allow for characters whose representation requires more

 * than 16 bits.  The range of legal <em>code point</em>s is now

 * U+0000 to U+10FFFF, known as <em>Unicode scalar value</em>.

 * (Refer to the <a

 * href="http://www.unicode.org/reports/tr27/#notation"><i>

 * definition</i></a> of the U+<i>n</i> notation in the Unicode

 * Standard.)

 *

 * <p><a name="BMP">The set of characters from U+0000 to U+FFFF</a> is

 * sometimes referred to as the <em>Basic Multilingual Plane (BMP)</em>.

 * <a name="supplementary">Characters</a> whose code points are greater

 * than U+FFFF are called <em>supplementary character</em>s.  The Java

 * platform uses the UTF-16 representation in {@code char} arrays and

 * in the {@code String} and {@code StringBuffer} classes. In

 * this representation, supplementary characters are represented as a pair

 * of {@code char} values, the first from the <em>high-surrogates</em>

 * range, (\uD800-\uDBFF), the second from the

 * <em>low-surrogates</em> range (&#92;uDC00-&#92;uDFFF).

 *

 * <p>A {@code char} value, therefore, represents Basic

 * Multilingual Plane (BMP) code points, including the surrogate

 * code points, or code units of the UTF-16 encoding. An

 * {@code int} value represents all Unicode code points,

 * including supplementary code points. The lower (least significant)

 * 21 bits of {@code int} are used to represent Unicode code

 * points and the upper (most significant) 11 bits must be zero.

 * Unless otherwise specified, the behavior with respect to

 * supplementary characters and surrogate {@code char} values is

 * as follows:

 *

 * <ul>

 * <li>The methods that only accept a {@code char} value cannot support

 * supplementary characters. They treat {@code char} values from the

 * surrogate ranges as undefined characters. For example,

 * {@code Character.isLetter('\u005CuD840')} returns {@code false}, even though

 * this specific value if followed by any low-surrogate value in a string

 * would represent a letter.

 *

 * <li>The methods that accept an {@code int} value support all

 * Unicode characters, including supplementary characters. For

 * example, {@code Character.isLetter(0x2F81A)} returns

 * {@code true} because the code point value represents a letter

 * (a CJK ideograph).

 * </ul>

 *

 * <p>In the Java SE API documentation, <em>Unicode code point</em> is

 * used for character values in the range between U+0000 and U+10FFFF,

 * and <em>Unicode code unit</em> is used for 16-bit

 * {@code char} values that are code units of the <em>UTF-16</em>

 * encoding. For more information on Unicode terminology, refer to the

 * <a href="http://www.unicode.org/glossary/">Unicode Glossary</a>.

 *

 * @author  Lee Boynton

 * @author  Guy Steele

 * @author  Akira Tanaka

 * @author  Martin Buchholz

 * @author  Ulf Zibis

 * @since   1.0

 */

public final

class Character implements java.io.Serializable, Comparable<Character> {

    /**

     * The minimum radix available for conversion to and from strings.

     * The constant value of this field is the smallest value permitted

     * for the radix argument in radix-conversion methods such as the

     * {@code digit} method, the {@code forDigit} method, and the

     * {@code toString} method of class {@code Integer}.

     *

     * @see     Character#digit(char, int)

     * @see     Character#forDigit(int, int)

     * @see     Integer#toString(int, int)

     * @see     Integer#valueOf(String)

     */

    public static final int MIN_RADIX = 2;

    /**

     * The maximum radix available for conversion to and from strings.

     * The constant value of this field is the largest value permitted

     * for the radix argument in radix-conversion methods such as the

     * {@code digit} method, the {@code forDigit} method, and the

     * {@code toString} method of class {@code Integer}.

     *

     * @see     Character#digit(char, int)

     * @see     Character#forDigit(int, int)

     * @see     Integer#toString(int, int)

     * @see     Integer#valueOf(String)

     */

    public static final int MAX_RADIX = 36;

    /**

     * The constant value of this field is the smallest value of type

     * {@code char}, {@code '\u005Cu0000'}.

     *

     * @since   1.0.2

     */

    public static final char MIN_VALUE = '\u0000';

    /**

     * The constant value of this field is the largest value of type

     * {@code char}, {@code '\u005CuFFFF'}.

     *

     * @since   1.0.2

     */

    public static final char MAX_VALUE = '\uFFFF';

    /**

     * The {@code Class} instance representing the primitive type

     * {@code char}.

     *

     * @since   1.1

     */

    @SuppressWarnings("unchecked")

    public static final Class<Character> TYPE = (Class<Character>) Class.getPrimitiveClass("char");

    /*

     * Normative general types

     */

    /*

     * General character types

     */

    /**

     * General category "Cn" in the Unicode specification.

     * @since   1.1

     */

    public static final byte UNASSIGNED = 0;

    /**

     * General category "Lu" in the Unicode specification.

     * @since   1.1

     */

    public static final byte UPPERCASE_LETTER = 1;

    /**

     * General category "Ll" in the Unicode specification.

     * @since   1.1

     */

    public static final byte LOWERCASE_LETTER = 2;

    /**

     * General category "Lt" in the Unicode specification.

     * @since   1.1

     */

    public static final byte TITLECASE_LETTER = 3;

    /**

     * General category "Lm" in the Unicode specification.

     * @since   1.1

     */

    public static final byte MODIFIER_LETTER = 4;

    /**

     * General category "Lo" in the Unicode specification.

     * @since   1.1

     */

    public static final byte OTHER_LETTER = 5;

    /**

     * General category "Mn" in the Unicode specification.

     * @since   1.1

     */

    public static final byte NON_SPACING_MARK = 6;

    /**

     * General category "Me" in the Unicode specification.

     * @since   1.1

     */

    public static final byte ENCLOSING_MARK = 7;

    /**

     * General category "Mc" in the Unicode specification.

     * @since   1.1

     */

    public static final byte COMBINING_SPACING_MARK = 8;

    /**

     * General category "Nd" in the Unicode specification.

     * @since   1.1

     */

    public static final byte DECIMAL_DIGIT_NUMBER        = 9;

    /**

     * General category "Nl" in the Unicode specification.

     * @since   1.1

     */

    public static final byte LETTER_NUMBER = 10;

    /**

     * General category "No" in the Unicode specification.

     * @since   1.1

     */

    public static final byte OTHER_NUMBER = 11;

    /**

     * General category "Zs" in the Unicode specification.

     * @since   1.1

     */

    public static final byte SPACE_SEPARATOR = 12;

    /**

     * General category "Zl" in the Unicode specification.

     * @since   1.1

     */

    public static final byte LINE_SEPARATOR = 13;

    /**

     * General category "Zp" in the Unicode specification.

     * @since   1.1

     */

    public static final byte PARAGRAPH_SEPARATOR = 14;

    /**

     * General category "Cc" in the Unicode specification.

     * @since   1.1

     */

    public static final byte CONTROL = 15;

    /**

     * General category "Cf" in the Unicode specification.

     * @since   1.1

     */

    public static final byte FORMAT = 16;

    /**

     * General category "Co" in the Unicode specification.

     * @since   1.1

     */

    public static final byte PRIVATE_USE = 18;

    /**

     * General category "Cs" in the Unicode specification.

     * @since   1.1

     */

    public static final byte SURROGATE = 19;

    /**

     * General category "Pd" in the Unicode specification.

     * @since   1.1

     */

    public static final byte DASH_PUNCTUATION = 20;

    /**

     * General category "Ps" in the Unicode specification.

     * @since   1.1

     */

    public static final byte START_PUNCTUATION = 21;

    /**

     * General category "Pe" in the Unicode specification.

     * @since   1.1

     */

    public static final byte END_PUNCTUATION = 22;

    /**

     * General category "Pc" in the Unicode specification.

     * @since   1.1

     */

    public static final byte CONNECTOR_PUNCTUATION = 23;

    /**

     * General category "Po" in the Unicode specification.

     * @since   1.1

     */

    public static final byte OTHER_PUNCTUATION = 24;

    /**

     * General category "Sm" in the Unicode specification.

     * @since   1.1

     */

    public static final byte MATH_SYMBOL = 25;

    /**

     * General category "Sc" in the Unicode specification.

     * @since   1.1

     */

    public static final byte CURRENCY_SYMBOL = 26;

    /**

     * General category "Sk" in the Unicode specification.

     * @since   1.1

     */

    public static final byte MODIFIER_SYMBOL = 27;

    /**

     * General category "So" in the Unicode specification.

     * @since   1.1

     */

    public static final byte OTHER_SYMBOL = 28;

    /**

     * General category "Pi" in the Unicode specification.

     * @since   1.4

     */

    public static final byte INITIAL_QUOTE_PUNCTUATION = 29;

    /**

     * General category "Pf" in the Unicode specification.

     * @since   1.4

     */

    public static final byte FINAL_QUOTE_PUNCTUATION = 30;

    /**

     * Error flag. Use int (code point) to avoid confusion with U+FFFF.

     */

    static final int ERROR = 0xFFFFFFFF;

    /**

     * Undefined bidirectional character type. Undefined {@code char}

     * values have undefined directionality in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_UNDEFINED = -1;

    /**

     * Strong bidirectional character type "L" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_LEFT_TO_RIGHT = 0;

    /**

     * Strong bidirectional character type "R" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_RIGHT_TO_LEFT = 1;

    /**

    * Strong bidirectional character type "AL" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC = 2;

    /**

     * Weak bidirectional character type "EN" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_EUROPEAN_NUMBER = 3;

    /**

     * Weak bidirectional character type "ES" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR = 4;

    /**

     * Weak bidirectional character type "ET" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR = 5;

    /**

     * Weak bidirectional character type "AN" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_ARABIC_NUMBER = 6;

    /**

     * Weak bidirectional character type "CS" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_COMMON_NUMBER_SEPARATOR = 7;

    /**

     * Weak bidirectional character type "NSM" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_NONSPACING_MARK = 8;

    /**

     * Weak bidirectional character type "BN" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_BOUNDARY_NEUTRAL = 9;

    /**

     * Neutral bidirectional character type "B" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_PARAGRAPH_SEPARATOR = 10;

    /**

     * Neutral bidirectional character type "S" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_SEGMENT_SEPARATOR = 11;

    /**

     * Neutral bidirectional character type "WS" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_WHITESPACE = 12;

    /**

     * Neutral bidirectional character type "ON" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_OTHER_NEUTRALS = 13;

    /**

     * Strong bidirectional character type "LRE" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING = 14;

    /**

     * Strong bidirectional character type "LRO" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE = 15;

    /**

     * Strong bidirectional character type "RLE" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING = 16;

    /**

     * Strong bidirectional character type "RLO" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE = 17;

    /**

     * Weak bidirectional character type "PDF" in the Unicode specification.

     * @since 1.4

     */

    public static final byte DIRECTIONALITY_POP_DIRECTIONAL_FORMAT = 18;

    /**

     * The minimum value of a

     * <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">

     * Unicode high-surrogate code unit</a>

     * in the UTF-16 encoding, constant {@code '\u005CuD800'}.

     * A high-surrogate is also known as a <i>leading-surrogate</i>.

     *

     * @since 1.5

     */

    public static final char MIN_HIGH_SURROGATE = '\uD800';

    /**

     * The maximum value of a

     * <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">

     * Unicode high-surrogate code unit</a>

     * in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.

     * A high-surrogate is also known as a <i>leading-surrogate</i>.

     *

     * @since 1.5

     */

    public static final char MAX_HIGH_SURROGATE = '\uDBFF';

    /**

     * The minimum value of a

     * <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">

     * Unicode low-surrogate code unit</a>

     * in the UTF-16 encoding, constant {@code '\u005CuDC00'}.

     * A low-surrogate is also known as a <i>trailing-surrogate</i>.

     *

     * @since 1.5

     */

    public static final char MIN_LOW_SURROGATE  = '\uDC00';

    /**

     * The maximum value of a

     * <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">

     * Unicode low-surrogate code unit</a>

     * in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.

     * A low-surrogate is also known as a <i>trailing-surrogate</i>.

     *

     * @since 1.5

     */

    public static final char MAX_LOW_SURROGATE  = '\uDFFF';

    /**

     * The minimum value of a Unicode surrogate code unit in the

     * UTF-16 encoding, constant {@code '\u005CuD800'}.

     *

     * @since 1.5

     */

    public static final char MIN_SURROGATE = MIN_HIGH_SURROGATE;

    /**

     * The maximum value of a Unicode surrogate code unit in the

     * UTF-16 encoding, constant {@code '\u005CuDFFF'}.

     *

     * @since 1.5

     */

    public static final char MAX_SURROGATE = MAX_LOW_SURROGATE;

    /**

     * The minimum value of a

     * <a href="http://www.unicode.org/glossary/#supplementary_code_point">

     * Unicode supplementary code point</a>, constant {@code U+10000}.

     *

     * @since 1.5

     */

    public static final int MIN_SUPPLEMENTARY_CODE_POINT = 0x010000;

    /**

     * The minimum value of a

     * <a href="http://www.unicode.org/glossary/#code_point">

     * Unicode code point</a>, constant {@code U+0000}.

     *

     * @since 1.5

     */

    public static final int MIN_CODE_POINT = 0x000000;

    /**

     * The maximum value of a

     * <a href="http://www.unicode.org/glossary/#code_point">

     * Unicode code point</a>, constant {@code U+10FFFF}.

     *

     * @since 1.5

     */

    public static final int MAX_CODE_POINT = 0X10FFFF;

    /**

     * Instances of this class represent particular subsets of the Unicode

     * character set.  The only family of subsets defined in the

     * {@code Character} class is {@link Character.UnicodeBlock}.

     * Other portions of the Java API may define other subsets for their

     * own purposes.

     *

     * @since 1.2

     */

    public static class Subset  {

        private String name;

        /**

         * Constructs a new {@code Subset} instance.

         *

         * @param  name  The name of this subset

         * @exception NullPointerException if name is {@code null}

         */

        protected Subset(String name) {

            if (name == null) {

                throw new NullPointerException("name");

            }

            this.name = name;

        }

        /**

         * Compares two {@code Subset} objects for equality.

         * This method returns {@code true} if and only if

         * {@code this} and the argument refer to the same

         * object; since this method is {@code final}, this

         * guarantee holds for all subclasses.

         */

        public final boolean equals(Object obj) {

            return (this == obj);

        }

        /**

         * Returns the standard hash code as defined by the

         * {@link Object#hashCode} method.  This method

         * is {@code final} in order to ensure that the

         * {@code equals} and {@code hashCode} methods will

         * be consistent in all subclasses.

         */

        public final int hashCode() {

            return super.hashCode();

        }

        /**

         * Returns the name of this subset.

         */

        public final String toString() {

            return name;

        }

    }

    // See http://www.unicode.org/Public/UNIDATA/Blocks.txt

    // for the latest specification of Unicode Blocks.

    /**

     * A family of character subsets representing the character blocks in the

     * Unicode specification. Character blocks generally define characters

     * used for a specific script or purpose. A character is contained by

     * at most one Unicode block.

     *

     * @since 1.2

     */

    public static final class UnicodeBlock extends Subset {

        private static Map<String, UnicodeBlock> map = new HashMap<>(256);

        /**

         * Creates a UnicodeBlock with the given identifier name.

         * This name must be the same as the block identifier.

         */

        private UnicodeBlock(String idName) {

            super(idName);

            map.put(idName, this);

        }

        /**

         * Creates a UnicodeBlock with the given identifier name and

         * alias name.

         */

        private UnicodeBlock(String idName, String alias) {

            this(idName);

            map.put(alias, this);

        }

        /**

         * Creates a UnicodeBlock with the given identifier name and

         * alias names.

         */

        private UnicodeBlock(String idName, String... aliases) {

            this(idName);

            for (String alias : aliases)

                map.put(alias, this);

        }

        /**

         * Constant for the "Basic Latin" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock  BASIC_LATIN =

            new UnicodeBlock("BASIC_LATIN",

                             "BASIC LATIN",

                             "BASICLATIN");

        /**

         * Constant for the "Latin-1 Supplement" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LATIN_1_SUPPLEMENT =

            new UnicodeBlock("LATIN_1_SUPPLEMENT",

                             "LATIN-1 SUPPLEMENT",

                             "LATIN-1SUPPLEMENT");

        /**

         * Constant for the "Latin Extended-A" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LATIN_EXTENDED_A =

            new UnicodeBlock("LATIN_EXTENDED_A",

                             "LATIN EXTENDED-A",

                             "LATINEXTENDED-A");

        /**

         * Constant for the "Latin Extended-B" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LATIN_EXTENDED_B =

            new UnicodeBlock("LATIN_EXTENDED_B",

                             "LATIN EXTENDED-B",

                             "LATINEXTENDED-B");

        /**

         * Constant for the "IPA Extensions" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock IPA_EXTENSIONS =

            new UnicodeBlock("IPA_EXTENSIONS",

                             "IPA EXTENSIONS",

                             "IPAEXTENSIONS");

        /**

         * Constant for the "Spacing Modifier Letters" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock SPACING_MODIFIER_LETTERS =

            new UnicodeBlock("SPACING_MODIFIER_LETTERS",

                             "SPACING MODIFIER LETTERS",

                             "SPACINGMODIFIERLETTERS");

        /**

         * Constant for the "Combining Diacritical Marks" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock COMBINING_DIACRITICAL_MARKS =

            new UnicodeBlock("COMBINING_DIACRITICAL_MARKS",

                             "COMBINING DIACRITICAL MARKS",

                             "COMBININGDIACRITICALMARKS");

        /**

         * Constant for the "Greek and Coptic" Unicode character block.

         * <p>

         * This block was previously known as the "Greek" block.

         *

         * @since 1.2

         */

        public static final UnicodeBlock GREEK =

            new UnicodeBlock("GREEK",

                             "GREEK AND COPTIC",

                             "GREEKANDCOPTIC");

        /**

         * Constant for the "Cyrillic" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CYRILLIC =

            new UnicodeBlock("CYRILLIC");

        /**

         * Constant for the "Armenian" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ARMENIAN =

            new UnicodeBlock("ARMENIAN");

        /**

         * Constant for the "Hebrew" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock HEBREW =

            new UnicodeBlock("HEBREW");

        /**

         * Constant for the "Arabic" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ARABIC =

            new UnicodeBlock("ARABIC");

        /**

         * Constant for the "Devanagari" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock DEVANAGARI =

            new UnicodeBlock("DEVANAGARI");

        /**

         * Constant for the "Bengali" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock BENGALI =

            new UnicodeBlock("BENGALI");

        /**

         * Constant for the "Gurmukhi" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GURMUKHI =

            new UnicodeBlock("GURMUKHI");

        /**

         * Constant for the "Gujarati" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GUJARATI =

            new UnicodeBlock("GUJARATI");

        /**

         * Constant for the "Oriya" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ORIYA =

            new UnicodeBlock("ORIYA");

        /**

         * Constant for the "Tamil" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock TAMIL =

            new UnicodeBlock("TAMIL");

        /**

         * Constant for the "Telugu" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock TELUGU =

            new UnicodeBlock("TELUGU");

        /**

         * Constant for the "Kannada" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock KANNADA =

            new UnicodeBlock("KANNADA");

        /**

         * Constant for the "Malayalam" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock MALAYALAM =

            new UnicodeBlock("MALAYALAM");

        /**

         * Constant for the "Thai" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock THAI =

            new UnicodeBlock("THAI");

        /**

         * Constant for the "Lao" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LAO =

            new UnicodeBlock("LAO");

        /**

         * Constant for the "Tibetan" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock TIBETAN =

            new UnicodeBlock("TIBETAN");

        /**

         * Constant for the "Georgian" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GEORGIAN =

            new UnicodeBlock("GEORGIAN");

        /**

         * Constant for the "Hangul Jamo" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock HANGUL_JAMO =

            new UnicodeBlock("HANGUL_JAMO",

                             "HANGUL JAMO",

                             "HANGULJAMO");

        /**

         * Constant for the "Latin Extended Additional" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LATIN_EXTENDED_ADDITIONAL =

            new UnicodeBlock("LATIN_EXTENDED_ADDITIONAL",

                             "LATIN EXTENDED ADDITIONAL",

                             "LATINEXTENDEDADDITIONAL");

        /**

         * Constant for the "Greek Extended" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GREEK_EXTENDED =

            new UnicodeBlock("GREEK_EXTENDED",

                             "GREEK EXTENDED",

                             "GREEKEXTENDED");

        /**

         * Constant for the "General Punctuation" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GENERAL_PUNCTUATION =

            new UnicodeBlock("GENERAL_PUNCTUATION",

                             "GENERAL PUNCTUATION",

                             "GENERALPUNCTUATION");

        /**

         * Constant for the "Superscripts and Subscripts" Unicode character

         * block.

         * @since 1.2

         */

        public static final UnicodeBlock SUPERSCRIPTS_AND_SUBSCRIPTS =

            new UnicodeBlock("SUPERSCRIPTS_AND_SUBSCRIPTS",

                             "SUPERSCRIPTS AND SUBSCRIPTS",

                             "SUPERSCRIPTSANDSUBSCRIPTS");

        /**

         * Constant for the "Currency Symbols" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CURRENCY_SYMBOLS =

            new UnicodeBlock("CURRENCY_SYMBOLS",

                             "CURRENCY SYMBOLS",

                             "CURRENCYSYMBOLS");

        /**

         * Constant for the "Combining Diacritical Marks for Symbols" Unicode

         * character block.

         * <p>

         * This block was previously known as "Combining Marks for Symbols".

         * @since 1.2

         */

        public static final UnicodeBlock COMBINING_MARKS_FOR_SYMBOLS =

            new UnicodeBlock("COMBINING_MARKS_FOR_SYMBOLS",

                             "COMBINING DIACRITICAL MARKS FOR SYMBOLS",

                             "COMBININGDIACRITICALMARKSFORSYMBOLS",

                             "COMBINING MARKS FOR SYMBOLS",

                             "COMBININGMARKSFORSYMBOLS");

        /**

         * Constant for the "Letterlike Symbols" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock LETTERLIKE_SYMBOLS =

            new UnicodeBlock("LETTERLIKE_SYMBOLS",

                             "LETTERLIKE SYMBOLS",

                             "LETTERLIKESYMBOLS");

        /**

         * Constant for the "Number Forms" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock NUMBER_FORMS =

            new UnicodeBlock("NUMBER_FORMS",

                             "NUMBER FORMS",

                             "NUMBERFORMS");

        /**

         * Constant for the "Arrows" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ARROWS =

            new UnicodeBlock("ARROWS");

        /**

         * Constant for the "Mathematical Operators" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock MATHEMATICAL_OPERATORS =

            new UnicodeBlock("MATHEMATICAL_OPERATORS",

                             "MATHEMATICAL OPERATORS",

                             "MATHEMATICALOPERATORS");

        /**

         * Constant for the "Miscellaneous Technical" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock MISCELLANEOUS_TECHNICAL =

            new UnicodeBlock("MISCELLANEOUS_TECHNICAL",

                             "MISCELLANEOUS TECHNICAL",

                             "MISCELLANEOUSTECHNICAL");

        /**

         * Constant for the "Control Pictures" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CONTROL_PICTURES =

            new UnicodeBlock("CONTROL_PICTURES",

                             "CONTROL PICTURES",

                             "CONTROLPICTURES");

        /**

         * Constant for the "Optical Character Recognition" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock OPTICAL_CHARACTER_RECOGNITION =

            new UnicodeBlock("OPTICAL_CHARACTER_RECOGNITION",

                             "OPTICAL CHARACTER RECOGNITION",

                             "OPTICALCHARACTERRECOGNITION");

        /**

         * Constant for the "Enclosed Alphanumerics" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ENCLOSED_ALPHANUMERICS =

            new UnicodeBlock("ENCLOSED_ALPHANUMERICS",

                             "ENCLOSED ALPHANUMERICS",

                             "ENCLOSEDALPHANUMERICS");

        /**

         * Constant for the "Box Drawing" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock BOX_DRAWING =

            new UnicodeBlock("BOX_DRAWING",

                             "BOX DRAWING",

                             "BOXDRAWING");

        /**

         * Constant for the "Block Elements" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock BLOCK_ELEMENTS =

            new UnicodeBlock("BLOCK_ELEMENTS",

                             "BLOCK ELEMENTS",

                             "BLOCKELEMENTS");

        /**

         * Constant for the "Geometric Shapes" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock GEOMETRIC_SHAPES =

            new UnicodeBlock("GEOMETRIC_SHAPES",

                             "GEOMETRIC SHAPES",

                             "GEOMETRICSHAPES");

        /**

         * Constant for the "Miscellaneous Symbols" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock MISCELLANEOUS_SYMBOLS =

            new UnicodeBlock("MISCELLANEOUS_SYMBOLS",

                             "MISCELLANEOUS SYMBOLS",

                             "MISCELLANEOUSSYMBOLS");

        /**

         * Constant for the "Dingbats" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock DINGBATS =

            new UnicodeBlock("DINGBATS");

        /**

         * Constant for the "CJK Symbols and Punctuation" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CJK_SYMBOLS_AND_PUNCTUATION =

            new UnicodeBlock("CJK_SYMBOLS_AND_PUNCTUATION",

                             "CJK SYMBOLS AND PUNCTUATION",

                             "CJKSYMBOLSANDPUNCTUATION");

        /**

         * Constant for the "Hiragana" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock HIRAGANA =

            new UnicodeBlock("HIRAGANA");

        /**

         * Constant for the "Katakana" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock KATAKANA =

            new UnicodeBlock("KATAKANA");

        /**

         * Constant for the "Bopomofo" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock BOPOMOFO =

            new UnicodeBlock("BOPOMOFO");

        /**

         * Constant for the "Hangul Compatibility Jamo" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock HANGUL_COMPATIBILITY_JAMO =

            new UnicodeBlock("HANGUL_COMPATIBILITY_JAMO",

                             "HANGUL COMPATIBILITY JAMO",

                             "HANGULCOMPATIBILITYJAMO");

        /**

         * Constant for the "Kanbun" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock KANBUN =

            new UnicodeBlock("KANBUN");

        /**

         * Constant for the "Enclosed CJK Letters and Months" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ENCLOSED_CJK_LETTERS_AND_MONTHS =

            new UnicodeBlock("ENCLOSED_CJK_LETTERS_AND_MONTHS",

                             "ENCLOSED CJK LETTERS AND MONTHS",

                             "ENCLOSEDCJKLETTERSANDMONTHS");

        /**

         * Constant for the "CJK Compatibility" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CJK_COMPATIBILITY =

            new UnicodeBlock("CJK_COMPATIBILITY",

                             "CJK COMPATIBILITY",

                             "CJKCOMPATIBILITY");

        /**

         * Constant for the "CJK Unified Ideographs" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CJK_UNIFIED_IDEOGRAPHS =

            new UnicodeBlock("CJK_UNIFIED_IDEOGRAPHS",

                             "CJK UNIFIED IDEOGRAPHS",

                             "CJKUNIFIEDIDEOGRAPHS");

        /**

         * Constant for the "Hangul Syllables" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock HANGUL_SYLLABLES =

            new UnicodeBlock("HANGUL_SYLLABLES",

                             "HANGUL SYLLABLES",

                             "HANGULSYLLABLES");

        /**

         * Constant for the "Private Use Area" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock PRIVATE_USE_AREA =

            new UnicodeBlock("PRIVATE_USE_AREA",

                             "PRIVATE USE AREA",

                             "PRIVATEUSEAREA");

        /**

         * Constant for the "CJK Compatibility Ideographs" Unicode character

         * block.

         * @since 1.2

         */

        public static final UnicodeBlock CJK_COMPATIBILITY_IDEOGRAPHS =

            new UnicodeBlock("CJK_COMPATIBILITY_IDEOGRAPHS",

                             "CJK COMPATIBILITY IDEOGRAPHS",

                             "CJKCOMPATIBILITYIDEOGRAPHS");

        /**

         * Constant for the "Alphabetic Presentation Forms" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ALPHABETIC_PRESENTATION_FORMS =

            new UnicodeBlock("ALPHABETIC_PRESENTATION_FORMS",

                             "ALPHABETIC PRESENTATION FORMS",

                             "ALPHABETICPRESENTATIONFORMS");

        /**

         * Constant for the "Arabic Presentation Forms-A" Unicode character

         * block.

         * @since 1.2

         */

        public static final UnicodeBlock ARABIC_PRESENTATION_FORMS_A =

            new UnicodeBlock("ARABIC_PRESENTATION_FORMS_A",

                             "ARABIC PRESENTATION FORMS-A",

                             "ARABICPRESENTATIONFORMS-A");

        /**

         * Constant for the "Combining Half Marks" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock COMBINING_HALF_MARKS =

            new UnicodeBlock("COMBINING_HALF_MARKS",

                             "COMBINING HALF MARKS",

                             "COMBININGHALFMARKS");

        /**

         * Constant for the "CJK Compatibility Forms" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock CJK_COMPATIBILITY_FORMS =

            new UnicodeBlock("CJK_COMPATIBILITY_FORMS",

                             "CJK COMPATIBILITY FORMS",

                             "CJKCOMPATIBILITYFORMS");

        /**

         * Constant for the "Small Form Variants" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock SMALL_FORM_VARIANTS =

            new UnicodeBlock("SMALL_FORM_VARIANTS",

                             "SMALL FORM VARIANTS",

                             "SMALLFORMVARIANTS");

        /**

         * Constant for the "Arabic Presentation Forms-B" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock ARABIC_PRESENTATION_FORMS_B =

            new UnicodeBlock("ARABIC_PRESENTATION_FORMS_B",

                             "ARABIC PRESENTATION FORMS-B",

                             "ARABICPRESENTATIONFORMS-B");

        /**

         * Constant for the "Halfwidth and Fullwidth Forms" Unicode character

         * block.

         * @since 1.2

         */

        public static final UnicodeBlock HALFWIDTH_AND_FULLWIDTH_FORMS =

            new UnicodeBlock("HALFWIDTH_AND_FULLWIDTH_FORMS",

                             "HALFWIDTH AND FULLWIDTH FORMS",

                             "HALFWIDTHANDFULLWIDTHFORMS");

        /**

         * Constant for the "Specials" Unicode character block.

         * @since 1.2

         */

        public static final UnicodeBlock SPECIALS =

            new UnicodeBlock("SPECIALS");

        /**

         * @deprecated As of J2SE 5, use {@link #HIGH_SURROGATES},

         *             {@link #HIGH_PRIVATE_USE_SURROGATES}, and

         *             {@link #LOW_SURROGATES}. These new constants match

         *             the block definitions of the Unicode Standard.

         *             The {@link #of(char)} and {@link #of(int)} methods

         *             return the new constants, not SURROGATES_AREA.

         */

        @Deprecated

        public static final UnicodeBlock SURROGATES_AREA =

            new UnicodeBlock("SURROGATES_AREA");

        /**

         * Constant for the "Syriac" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock SYRIAC =

            new UnicodeBlock("SYRIAC");

        /**

         * Constant for the "Thaana" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock THAANA =

            new UnicodeBlock("THAANA");

        /**

         * Constant for the "Sinhala" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock SINHALA =

            new UnicodeBlock("SINHALA");

        /**

         * Constant for the "Myanmar" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock MYANMAR =

            new UnicodeBlock("MYANMAR");

        /**

         * Constant for the "Ethiopic" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock ETHIOPIC =

            new UnicodeBlock("ETHIOPIC");

        /**

         * Constant for the "Cherokee" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock CHEROKEE =

            new UnicodeBlock("CHEROKEE");

        /**

         * Constant for the "Unified Canadian Aboriginal Syllabics" Unicode character block.

         * @since 1.4

         */

        public static final UnicodeBlock UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS =