You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by te...@apache.org on 2009/05/02 10:09:57 UTC
svn commit: r770909 [2/10] - in
/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang: ./
ref/ reflect/
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java Sat May 2 08:09:50 2009
@@ -26,36 +26,27 @@
import com.ibm.icu.lang.UCharacter;
/**
- * <p>
- * Character is the wrapper for the primitive type <code>char</code>. This
- * class also provides a number of utility methods for working with
- * <code>char</code>s.
- * </p>
- *
+ * The wrapper for the primitive type {@code char}. This class also provides a
+ * number of utility methods for working with characters.
* <p>
* Character data is based upon the Unicode Standard, 4.0. The Unicode
* specification, character tables and other information are available at <a
* href="http://www.unicode.org/">http://www.unicode.org/</a>.
- * </p>
- *
* <p>
* Unicode characters are referred to as <i>code points</i>. The range of valid
* code points is U+0000 to U+10FFFF. The <i>Basic Multilingual Plane (BMP)</i>
* is the code point range U+0000 to U+FFFF. Characters above the BMP are
* referred to as <i>Supplementary Characters</i>. On the Java platform, UTF-16
- * encoding and <code>char</code> pairs are used to represent code points in
- * the supplementary range. A pair of <code>char</code> values that represent
- * a supplementary character are made up of a <i>high surrogate</i> with a
- * value range of 0xD800 to 0xDBFF and a <i>low surrogate</i> with a value
- * range of 0xDC00 to 0xDFFF.
- * </p>
- *
+ * encoding and {@code char} pairs are used to represent code points in the
+ * supplementary range. A pair of {@code char} values that represent a
+ * supplementary character are made up of a <i>high surrogate</i> with a value
+ * range of 0xD800 to 0xDBFF and a <i>low surrogate</i> with a value range of
+ * 0xDC00 to 0xDFFF.
* <p>
- * On the Java platform a <code>char</code> value represents either a single
- * BMP code point or a UTF-16 unit that's part of a surrogate pair. The
- * <code>int</code> type is used to represent all Unicode code points.
- * </p>
- *
+ * On the Java platform a {@code char} value represents either a single BMP code
+ * point or a UTF-16 unit that's part of a surrogate pair. The {@code int} type
+ * is used to represent all Unicode code points.
+ *
* @since 1.0
*/
public final class Character implements Serializable, Comparable<Character> {
@@ -64,29 +55,27 @@
private final char value;
/**
- * The minimum possible Character value.
+ * The minimum {@code Character} value.
*/
public static final char MIN_VALUE = '\u0000';
/**
- * The maximum possible Character value.
+ * The maximum {@code Character} value.
*/
public static final char MAX_VALUE = '\uffff';
/**
- * The minimum possible radix used for conversions between Characters and
- * integers.
+ * The minimum radix used for conversions between characters and integers.
*/
public static final int MIN_RADIX = 2;
/**
- * The maximum possible radix used for conversions between Characters and
- * integers.
+ * The maximum radix used for conversions between characters and integers.
*/
public static final int MAX_RADIX = 36;
/**
- * The <code>char</code> {@link Class} object.
+ * The {@link Class} object that represents the primitive type {@code char}.
*/
@SuppressWarnings("unchecked")
public static final Class<Character> TYPE = (Class<Character>) new char[0]
@@ -237,226 +226,229 @@
/**
* Unicode category constant Pi.
+ *
* @since 1.4
*/
public static final byte INITIAL_QUOTE_PUNCTUATION = 29;
/**
* Unicode category constant Pf.
+ *
* @since 1.4
*/
public static final byte FINAL_QUOTE_PUNCTUATION = 30;
/**
* Unicode bidirectional constant.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_UNDEFINED = -1;
/**
* Unicode bidirectional constant L.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT = 0;
/**
* Unicode bidirectional constant R.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT = 1;
/**
* Unicode bidirectional constant AL.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC = 2;
/**
* Unicode bidirectional constant EN.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER = 3;
/**
* Unicode bidirectional constant ES.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR = 4;
/**
* Unicode bidirectional constant ET.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR = 5;
/**
* Unicode bidirectional constant AN.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_ARABIC_NUMBER = 6;
/**
* Unicode bidirectional constant CS.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_COMMON_NUMBER_SEPARATOR = 7;
/**
* Unicode bidirectional constant NSM.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_NONSPACING_MARK = 8;
/**
* Unicode bidirectional constant BN.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_BOUNDARY_NEUTRAL = 9;
/**
* Unicode bidirectional constant B.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_PARAGRAPH_SEPARATOR = 10;
/**
* Unicode bidirectional constant S.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_SEGMENT_SEPARATOR = 11;
/**
* Unicode bidirectional constant WS.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_WHITESPACE = 12;
/**
* Unicode bidirectional constant ON.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_OTHER_NEUTRALS = 13;
/**
* Unicode bidirectional constant LRE.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING = 14;
/**
* Unicode bidirectional constant LRO.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE = 15;
/**
* Unicode bidirectional constant RLE.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING = 16;
/**
* Unicode bidirectional constant RLO.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE = 17;
/**
* Unicode bidirectional constant PDF.
+ *
* @since 1.4
*/
public static final byte DIRECTIONALITY_POP_DIRECTIONAL_FORMAT = 18;
/**
- * <p>
- * Minimum value of a high surrogate or leading surrogate unit in UTF-16
- * encoding - <code>'\uD800'</code>.
- * </p>
- *
+ * The minimum value of a high surrogate or leading surrogate unit in UTF-16
+ * encoding, {@code '\uD800'}.
+ *
* @since 1.5
*/
public static final char MIN_HIGH_SURROGATE = '\uD800';
/**
- * <p>
- * Maximum value of a high surrogate or leading surrogate unit in UTF-16
- * encoding - <code>'\uDBFF'</code>.
- * </p>
- *
+ * The maximum value of a high surrogate or leading surrogate unit in UTF-16
+ * encoding, {@code '\uDBFF'}.
+ *
* @since 1.5
*/
public static final char MAX_HIGH_SURROGATE = '\uDBFF';
/**
- * <p>
- * Minimum value of a low surrogate or trailing surrogate unit in UTF-16
- * encoding - <code>'\uDC00'</code>.
- * </p>
- *
+ * The minimum value of a low surrogate or trailing surrogate unit in UTF-16
+ * encoding, {@code '\uDC00'}.
+ *
* @since 1.5
*/
public static final char MIN_LOW_SURROGATE = '\uDC00';
/**
- * Maximum value of a low surrogate or trailing surrogate unit in UTF-16
- * encoding - <code>'\uDFFF'</code>.
- * </p>
- *
+ * The maximum value of a low surrogate or trailing surrogate unit in UTF-16
+ * encoding, {@code '\uDFFF'}.
+ *
* @since 1.5
*/
public static final char MAX_LOW_SURROGATE = '\uDFFF';
/**
- * <p>
- * Minimum value of a surrogate unit in UTF-16 encoding - <code>'\uD800'</code>.
- * </p>
- *
+ * The minimum value of a surrogate unit in UTF-16 encoding, {@code '\uD800'}.
+ *
* @since 1.5
*/
public static final char MIN_SURROGATE = '\uD800';
/**
- * <p>
- * Maximum value of a surrogate unit in UTF-16 encoding - <code>'\uDFFF'</code>.
- * </p>
- *
+ * The maximum value of a surrogate unit in UTF-16 encoding, {@code '\uDFFF'}.
+ *
* @since 1.5
*/
public static final char MAX_SURROGATE = '\uDFFF';
/**
- * <p>
- * Minimum value of a supplementary code point - <code>U+010000</code>.
- * </p>
- *
+ * The minimum value of a supplementary code point, {@code U+010000}.
+ *
* @since 1.5
*/
public static final int MIN_SUPPLEMENTARY_CODE_POINT = 0x10000;
/**
- * <p>
- * Minimum code point value - <code>U+0000</code>.
- * </p>
- *
+ * The minimum code point value, {@code U+0000}.
+ *
* @since 1.5
*/
public static final int MIN_CODE_POINT = 0x000000;
/**
- * <p>
- * Maximum code point value - <code>U+10FFFF</code>.
- * </p>
- *
+ * The maximum code point value, {@code U+10FFFF}.
+ *
* @since 1.5
*/
public static final int MAX_CODE_POINT = 0x10FFFF;
/**
- * <p>
- * Constant for the number of bits to represent a <code>char</code> in
- * two's compliment form.
- * </p>
- *
+ * The number of bits required to represent a {@code Character} value
+ * unsigned form.
+ *
* @since 1.5
*/
public static final int SIZE = 16;
@@ -703,11 +695,17 @@
.getValue();
/*
- * Subset represents a subset of characters.
+ * Represents a subset of the Unicode character set.
*/
public static class Subset {
String name;
+ /**
+ * Constructs a new {@code Subset}.
+ *
+ * @param string
+ * this subset's name.
+ */
protected Subset(String string) {
if (string == null) {
throw new NullPointerException();
@@ -716,15 +714,13 @@
}
/**
- * Compares the specified object to this Subset and answers true if they
- * are equal. The object must be the same instance of Subset.
+ * Compares this character subset with the specified object. Uses
+ * {@link java.lang.Object#equals(Object)} to do the comparison.
*
* @param object
- * the object to compare
- * @return true if the specified object is equal to this Subset, false
- * otherwise
- *
- * @see #hashCode
+ * the object to compare this character subset with.
+ * @return {@code true} if {@code object} is this subset, that is, if
+ * {@code object == this}; {@code false} otherwise.
*/
@Override
public final boolean equals(Object object) {
@@ -732,12 +728,10 @@
}
/**
- * Answers an integer hash code for the receiver. Objects which are
- * equal answer the same value for this method.
+ * Returns the integer hash code for this character subset.
*
- * @return the receiver's hash
- *
- * @see #equals
+ * @return this subset's hash code, which is the hash code computed by
+ * {@link java.lang.Object#hashCode()}.
*/
@Override
public final int hashCode() {
@@ -745,9 +739,9 @@
}
/**
- * Answers the string representation of this Subset.
+ * Returns the string representation of this subset.
*
- * @return the string representation of this Subset
+ * @return this subset's name.
*/
@Override
public final String toString() {
@@ -756,638 +750,771 @@
}
/**
- * Blocks of characters, as defined by the Unicode 4.0.1 specification.
+ * Represents a block of Unicode characters, as defined by the Unicode 4.0.1
+ * specification.
+ *
* @since 1.2
*/
public static final class UnicodeBlock extends Subset {
/**
- * The "Surrogates Area" Unicode Block.
- * @deprecated As of Java 5, this block has been replaced by {@link #HIGH_SURROGATES}, {@link #HIGH_PRIVATE_USE_SURROGATES} and {@link #LOW_SURROGATES}.
+ * The "Surrogates Area" Unicode Block.
+ *
+ * @deprecated As of Java 5, this block has been replaced by
+ * {@link #HIGH_SURROGATES},
+ * {@link #HIGH_PRIVATE_USE_SURROGATES} and
+ * {@link #LOW_SURROGATES}.
*/
@Deprecated
public static final UnicodeBlock SURROGATES_AREA = new UnicodeBlock("SURROGATES_AREA", 0x0, 0x0);
/**
- * The "Basic Latin" Unicode Block.
+ * The "Basic Latin" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock BASIC_LATIN = new UnicodeBlock("BASIC_LATIN", 0x0, 0x7f);
/**
- * The "Latin-1 Supplement" Unicode Block.
+ * The "Latin-1 Supplement" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LATIN_1_SUPPLEMENT = new UnicodeBlock("LATIN_1_SUPPLEMENT", 0x80, 0xff);
/**
- * The "Latin Extended-A" Unicode Block.
+ * The "Latin Extended-A" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LATIN_EXTENDED_A = new UnicodeBlock("LATIN_EXTENDED_A", 0x100, 0x17f);
/**
- * The "Latin Extended-B" Unicode Block.
+ * The "Latin Extended-B" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LATIN_EXTENDED_B = new UnicodeBlock("LATIN_EXTENDED_B", 0x180, 0x24f);
/**
- * The "IPA Extensions" Unicode Block.
+ * The "IPA Extensions" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock IPA_EXTENSIONS = new UnicodeBlock("IPA_EXTENSIONS", 0x250, 0x2af);
/**
- * The "Spacing Modifier Letters" Unicode Block.
+ * The "Spacing Modifier Letters" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock SPACING_MODIFIER_LETTERS = new UnicodeBlock("SPACING_MODIFIER_LETTERS", 0x2b0, 0x2ff);
/**
- * The "Combining Diacritical Marks" Unicode Block.
+ * The "Combining Diacritical Marks" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock COMBINING_DIACRITICAL_MARKS = new UnicodeBlock("COMBINING_DIACRITICAL_MARKS", 0x300, 0x36f);
/**
- * The "Greek and Coptic" Unicode Block. Previously referred to as "Greek".
+ * The "Greek and Coptic" Unicode Block. Previously referred
+ * to as "Greek".
+ *
* @since 1.2
*/
public static final UnicodeBlock GREEK = new UnicodeBlock("GREEK", 0x370, 0x3ff);
/**
- * The "Cyrillic" Unicode Block.
+ * The "Cyrillic" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CYRILLIC = new UnicodeBlock("CYRILLIC", 0x400, 0x4ff);
/**
- * The "Cyrillic Supplement" Unicode Block. Previously referred to as "Cyrillic Supplementary".
+ * The "Cyrillic Supplement" Unicode Block. Previously
+ * referred to as "Cyrillic Supplementary".
+ *
* @since 1.5
*/
public static final UnicodeBlock CYRILLIC_SUPPLEMENTARY = new UnicodeBlock("CYRILLIC_SUPPLEMENTARY", 0x500, 0x52f);
/**
- * The "Armenian" Unicode Block.
+ * The "Armenian" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ARMENIAN = new UnicodeBlock("ARMENIAN", 0x530, 0x58f);
/**
- * The "Hebrew" Unicode Block.
+ * The "Hebrew" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HEBREW = new UnicodeBlock("HEBREW", 0x590, 0x5ff);
/**
- * The "Arabic" Unicode Block.
+ * The "Arabic" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ARABIC = new UnicodeBlock("ARABIC", 0x600, 0x6ff);
/**
- * The "Syriac" Unicode Block.
+ * The "Syriac" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock SYRIAC = new UnicodeBlock("SYRIAC", 0x700, 0x74f);
/**
- * The "Thaana" Unicode Block.
+ * The "Thaana" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock THAANA = new UnicodeBlock("THAANA", 0x780, 0x7bf);
/**
- * The "Devanagari" Unicode Block.
+ * The "Devanagari" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock DEVANAGARI = new UnicodeBlock("DEVANAGARI", 0x900, 0x97f);
/**
- * The "Bengali" Unicode Block.
+ * The "Bengali" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock BENGALI = new UnicodeBlock("BENGALI", 0x980, 0x9ff);
/**
- * The "Gurmukhi" Unicode Block.
+ * The "Gurmukhi" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GURMUKHI = new UnicodeBlock("GURMUKHI", 0xa00, 0xa7f);
/**
- * The "Gujarati" Unicode Block.
+ * The "Gujarati" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GUJARATI = new UnicodeBlock("GUJARATI", 0xa80, 0xaff);
/**
- * The "Oriya" Unicode Block.
+ * The "Oriya" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ORIYA = new UnicodeBlock("ORIYA", 0xb00, 0xb7f);
/**
- * The "Tamil" Unicode Block.
+ * The "Tamil" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock TAMIL = new UnicodeBlock("TAMIL", 0xb80, 0xbff);
/**
- * The "Telugu" Unicode Block.
+ * The "Telugu" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock TELUGU = new UnicodeBlock("TELUGU", 0xc00, 0xc7f);
/**
- * The "Kannada" Unicode Block.
+ * The "Kannada" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock KANNADA = new UnicodeBlock("KANNADA", 0xc80, 0xcff);
/**
- * The "Malayalam" Unicode Block.
+ * The "Malayalam" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock MALAYALAM = new UnicodeBlock("MALAYALAM", 0xd00, 0xd7f);
/**
- * The "Sinhala" Unicode Block.
+ * The "Sinhala" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock SINHALA = new UnicodeBlock("SINHALA", 0xd80, 0xdff);
/**
- * The "Thai" Unicode Block.
+ * The "Thai" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock THAI = new UnicodeBlock("THAI", 0xe00, 0xe7f);
/**
- * The "Lao" Unicode Block.
+ * The "Lao" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LAO = new UnicodeBlock("LAO", 0xe80, 0xeff);
/**
- * The "Tibetan" Unicode Block.
+ * The "Tibetan" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock TIBETAN = new UnicodeBlock("TIBETAN", 0xf00, 0xfff);
/**
- * The "Myanmar" Unicode Block.
+ * The "Myanmar" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock MYANMAR = new UnicodeBlock("MYANMAR", 0x1000, 0x109f);
/**
- * The "Georgian" Unicode Block.
+ * The "Georgian" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GEORGIAN = new UnicodeBlock("GEORGIAN", 0x10a0, 0x10ff);
/**
- * The "Hangul Jamo" Unicode Block.
+ * The "Hangul Jamo" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HANGUL_JAMO = new UnicodeBlock("HANGUL_JAMO", 0x1100, 0x11ff);
/**
- * The "Ethiopic" Unicode Block.
+ * The "Ethiopic" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock ETHIOPIC = new UnicodeBlock("ETHIOPIC", 0x1200, 0x137f);
/**
- * The "Cherokee" Unicode Block.
+ * The "Cherokee" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock CHEROKEE = new UnicodeBlock("CHEROKEE", 0x13a0, 0x13ff);
/**
- * The "Unified Canadian Aboriginal Syllabics" Unicode Block.
+ * The "Unified Canadian Aboriginal Syllabics" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS = new UnicodeBlock("UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS", 0x1400, 0x167f);
/**
- * The "Ogham" Unicode Block.
+ * The "Ogham" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock OGHAM = new UnicodeBlock("OGHAM", 0x1680, 0x169f);
/**
- * The "Runic" Unicode Block.
+ * The "Runic" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock RUNIC = new UnicodeBlock("RUNIC", 0x16a0, 0x16ff);
/**
- * The "Tagalog" Unicode Block.
+ * The "Tagalog" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock TAGALOG = new UnicodeBlock("TAGALOG", 0x1700, 0x171f);
/**
- * The "Hanunoo" Unicode Block.
+ * The "Hanunoo" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock HANUNOO = new UnicodeBlock("HANUNOO", 0x1720, 0x173f);
/**
- * The "Buhid" Unicode Block.
+ * The "Buhid" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock BUHID = new UnicodeBlock("BUHID", 0x1740, 0x175f);
/**
- * The "Tagbanwa" Unicode Block.
+ * The "Tagbanwa" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock TAGBANWA = new UnicodeBlock("TAGBANWA", 0x1760, 0x177f);
/**
- * The "Khmer" Unicode Block.
+ * The "Khmer" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock KHMER = new UnicodeBlock("KHMER", 0x1780, 0x17ff);
/**
- * The "Mongolian" Unicode Block.
+ * The "Mongolian" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock MONGOLIAN = new UnicodeBlock("MONGOLIAN", 0x1800, 0x18af);
/**
- * The "Limbu" Unicode Block.
+ * The "Limbu" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock LIMBU = new UnicodeBlock("LIMBU", 0x1900, 0x194f);
/**
- * The "Tai Le" Unicode Block.
+ * The "Tai Le" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock TAI_LE = new UnicodeBlock("TAI_LE", 0x1950, 0x197f);
/**
- * The "Khmer Symbols" Unicode Block.
+ * The "Khmer Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock KHMER_SYMBOLS = new UnicodeBlock("KHMER_SYMBOLS", 0x19e0, 0x19ff);
/**
- * The "Phonetic Extensions" Unicode Block.
+ * The "Phonetic Extensions" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock PHONETIC_EXTENSIONS = new UnicodeBlock("PHONETIC_EXTENSIONS", 0x1d00, 0x1d7f);
/**
- * The "Latin Extended Additional" Unicode Block.
+ * The "Latin Extended Additional" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LATIN_EXTENDED_ADDITIONAL = new UnicodeBlock("LATIN_EXTENDED_ADDITIONAL", 0x1e00, 0x1eff);
/**
- * The "Greek Extended" Unicode Block.
+ * The "Greek Extended" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GREEK_EXTENDED = new UnicodeBlock("GREEK_EXTENDED", 0x1f00, 0x1fff);
/**
- * The "General Punctuation" Unicode Block.
+ * The "General Punctuation" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GENERAL_PUNCTUATION = new UnicodeBlock("GENERAL_PUNCTUATION", 0x2000, 0x206f);
/**
- * The "Superscripts and Subscripts" Unicode Block.
+ * The "Superscripts and Subscripts" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock SUPERSCRIPTS_AND_SUBSCRIPTS = new UnicodeBlock("SUPERSCRIPTS_AND_SUBSCRIPTS", 0x2070, 0x209f);
/**
- * The "Currency Symbols" Unicode Block.
+ * The "Currency Symbols" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CURRENCY_SYMBOLS = new UnicodeBlock("CURRENCY_SYMBOLS", 0x20a0, 0x20cf);
/**
- * The "Combining Diacritical Marks for Symbols" Unicode Block. Previously referred to as "Combining Marks for Symbols".
+ * The "Combining Diacritical Marks for Symbols" Unicode
+ * Block. Previously referred to as "Combining Marks for
+ * Symbols".
+ *
* @since 1.2
*/
public static final UnicodeBlock COMBINING_MARKS_FOR_SYMBOLS = new UnicodeBlock("COMBINING_MARKS_FOR_SYMBOLS", 0x20d0, 0x20ff);
/**
- * The "Letterlike Symbols" Unicode Block.
+ * The "Letterlike Symbols" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LETTERLIKE_SYMBOLS = new UnicodeBlock("LETTERLIKE_SYMBOLS", 0x2100, 0x214f);
/**
- * The "Number Forms" Unicode Block.
+ * The "Number Forms" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock NUMBER_FORMS = new UnicodeBlock("NUMBER_FORMS", 0x2150, 0x218f);
/**
- * The "Arrows" Unicode Block.
+ * The "Arrows" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ARROWS = new UnicodeBlock("ARROWS", 0x2190, 0x21ff);
/**
- * The "Mathematical Operators" Unicode Block.
+ * The "Mathematical Operators" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock MATHEMATICAL_OPERATORS = new UnicodeBlock("MATHEMATICAL_OPERATORS", 0x2200, 0x22ff);
/**
- * The "Miscellaneous Technical" Unicode Block.
+ * The "Miscellaneous Technical" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock MISCELLANEOUS_TECHNICAL = new UnicodeBlock("MISCELLANEOUS_TECHNICAL", 0x2300, 0x23ff);
/**
- * The "Control Pictures" Unicode Block.
+ * The "Control Pictures" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CONTROL_PICTURES = new UnicodeBlock("CONTROL_PICTURES", 0x2400, 0x243f);
/**
- * The "Optical Character Recognition" Unicode Block.
+ * The "Optical Character Recognition" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock OPTICAL_CHARACTER_RECOGNITION = new UnicodeBlock("OPTICAL_CHARACTER_RECOGNITION", 0x2440, 0x245f);
/**
- * The "Enclosed Alphanumerics" Unicode Block.
+ * The "Enclosed Alphanumerics" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ENCLOSED_ALPHANUMERICS = new UnicodeBlock("ENCLOSED_ALPHANUMERICS", 0x2460, 0x24ff);
/**
- * The "Box Drawing" Unicode Block.
+ * The "Box Drawing" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock BOX_DRAWING = new UnicodeBlock("BOX_DRAWING", 0x2500, 0x257f);
/**
- * The "Block Elements" Unicode Block.
+ * The "Block Elements" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock BLOCK_ELEMENTS = new UnicodeBlock("BLOCK_ELEMENTS", 0x2580, 0x259f);
/**
- * The "Geometric Shapes" Unicode Block.
+ * The "Geometric Shapes" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock GEOMETRIC_SHAPES = new UnicodeBlock("GEOMETRIC_SHAPES", 0x25a0, 0x25ff);
/**
- * The "Miscellaneous Symbols" Unicode Block.
+ * The "Miscellaneous Symbols" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock MISCELLANEOUS_SYMBOLS = new UnicodeBlock("MISCELLANEOUS_SYMBOLS", 0x2600, 0x26ff);
/**
- * The "Dingbats" Unicode Block.
+ * The "Dingbats" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock DINGBATS = new UnicodeBlock("DINGBATS", 0x2700, 0x27bf);
/**
- * The "Miscellaneous Mathematical Symbols-A" Unicode Block.
+ * The "Miscellaneous Mathematical Symbols-A" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A = new UnicodeBlock("MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A", 0x27c0, 0x27ef);
/**
- * The "Supplemental Arrows-A" Unicode Block.
+ * The "Supplemental Arrows-A" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SUPPLEMENTAL_ARROWS_A = new UnicodeBlock("SUPPLEMENTAL_ARROWS_A", 0x27f0, 0x27ff);
/**
- * The "Braille Patterns" Unicode Block.
+ * The "Braille Patterns" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock BRAILLE_PATTERNS = new UnicodeBlock("BRAILLE_PATTERNS", 0x2800, 0x28ff);
/**
- * The "Supplemental Arrows-B" Unicode Block.
+ * The "Supplemental Arrows-B" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SUPPLEMENTAL_ARROWS_B = new UnicodeBlock("SUPPLEMENTAL_ARROWS_B", 0x2900, 0x297f);
/**
- * The "Miscellaneous Mathematical Symbols-B" Unicode Block.
+ * The "Miscellaneous Mathematical Symbols-B" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B = new UnicodeBlock("MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B", 0x2980, 0x29ff);
/**
- * The "Supplemental Mathematical Operators" Unicode Block.
+ * The "Supplemental Mathematical Operators" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SUPPLEMENTAL_MATHEMATICAL_OPERATORS = new UnicodeBlock("SUPPLEMENTAL_MATHEMATICAL_OPERATORS", 0x2a00, 0x2aff);
/**
- * The "Miscellaneous Symbols and Arrows" Unicode Block.
+ * The "Miscellaneous Symbols and Arrows" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock MISCELLANEOUS_SYMBOLS_AND_ARROWS = new UnicodeBlock("MISCELLANEOUS_SYMBOLS_AND_ARROWS", 0x2b00, 0x2bff);
/**
- * The "CJK Radicals Supplement" Unicode Block.
+ * The "CJK Radicals Supplement" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock CJK_RADICALS_SUPPLEMENT = new UnicodeBlock("CJK_RADICALS_SUPPLEMENT", 0x2e80, 0x2eff);
/**
- * The "Kangxi Radicals" Unicode Block.
+ * The "Kangxi Radicals" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock KANGXI_RADICALS = new UnicodeBlock("KANGXI_RADICALS", 0x2f00, 0x2fdf);
/**
- * The "Ideographic Description Characters" Unicode Block.
+ * The "Ideographic Description Characters" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock IDEOGRAPHIC_DESCRIPTION_CHARACTERS = new UnicodeBlock("IDEOGRAPHIC_DESCRIPTION_CHARACTERS", 0x2ff0, 0x2fff);
/**
- * The "CJK Symbols and Punctuation" Unicode Block.
+ * The "CJK Symbols and Punctuation" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CJK_SYMBOLS_AND_PUNCTUATION = new UnicodeBlock("CJK_SYMBOLS_AND_PUNCTUATION", 0x3000, 0x303f);
/**
- * The "Hiragana" Unicode Block.
+ * The "Hiragana" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HIRAGANA = new UnicodeBlock("HIRAGANA", 0x3040, 0x309f);
/**
- * The "Katakana" Unicode Block.
+ * The "Katakana" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock KATAKANA = new UnicodeBlock("KATAKANA", 0x30a0, 0x30ff);
/**
- * The "Bopomofo" Unicode Block.
+ * The "Bopomofo" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock BOPOMOFO = new UnicodeBlock("BOPOMOFO", 0x3100, 0x312f);
/**
- * The "Hangul Compatibility Jamo" Unicode Block.
+ * The "Hangul Compatibility Jamo" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HANGUL_COMPATIBILITY_JAMO = new UnicodeBlock("HANGUL_COMPATIBILITY_JAMO", 0x3130, 0x318f);
/**
- * The "Kanbun" Unicode Block.
+ * The "Kanbun" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock KANBUN = new UnicodeBlock("KANBUN", 0x3190, 0x319f);
/**
- * The "Bopomofo Extended" Unicode Block.
+ * The "Bopomofo Extended" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock BOPOMOFO_EXTENDED = new UnicodeBlock("BOPOMOFO_EXTENDED", 0x31a0, 0x31bf);
/**
- * The "Katakana Phonetic Extensions" Unicode Block.
+ * The "Katakana Phonetic Extensions" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock KATAKANA_PHONETIC_EXTENSIONS = new UnicodeBlock("KATAKANA_PHONETIC_EXTENSIONS", 0x31f0, 0x31ff);
/**
- * The "Enclosed CJK Letters and Months" Unicode Block.
+ * The "Enclosed CJK Letters and Months" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ENCLOSED_CJK_LETTERS_AND_MONTHS = new UnicodeBlock("ENCLOSED_CJK_LETTERS_AND_MONTHS", 0x3200, 0x32ff);
/**
- * The "CJK Compatibility" Unicode Block.
+ * The "CJK Compatibility" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CJK_COMPATIBILITY = new UnicodeBlock("CJK_COMPATIBILITY", 0x3300, 0x33ff);
/**
- * The "CJK Unified Ideographs Extension A" Unicode Block.
+ * The "CJK Unified Ideographs Extension A" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A = new UnicodeBlock("CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A", 0x3400, 0x4dbf);
/**
- * The "Yijing Hexagram Symbols" Unicode Block.
+ * The "Yijing Hexagram Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock YIJING_HEXAGRAM_SYMBOLS = new UnicodeBlock("YIJING_HEXAGRAM_SYMBOLS", 0x4dc0, 0x4dff);
/**
- * The "CJK Unified Ideographs" Unicode Block.
+ * The "CJK Unified Ideographs" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CJK_UNIFIED_IDEOGRAPHS = new UnicodeBlock("CJK_UNIFIED_IDEOGRAPHS", 0x4e00, 0x9fff);
/**
- * The "Yi Syllables" Unicode Block.
+ * The "Yi Syllables" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock YI_SYLLABLES = new UnicodeBlock("YI_SYLLABLES", 0xa000, 0xa48f);
/**
- * The "Yi Radicals" Unicode Block.
+ * The "Yi Radicals" Unicode Block.
+ *
* @since 1.4
*/
public static final UnicodeBlock YI_RADICALS = new UnicodeBlock("YI_RADICALS", 0xa490, 0xa4cf);
/**
- * The "Hangul Syllables" Unicode Block.
+ * The "Hangul Syllables" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HANGUL_SYLLABLES = new UnicodeBlock("HANGUL_SYLLABLES", 0xac00, 0xd7af);
/**
- * The "High Surrogates" Unicode Block.
- * This block represents code point values in the high surrogate range 0xD800 to 0xDB7F @since 1.5
+ * The "High Surrogates" Unicode Block. This block represents
+ * code point values in the high surrogate range 0xD800 to 0xDB7F
*/
public static final UnicodeBlock HIGH_SURROGATES = new UnicodeBlock("HIGH_SURROGATES", 0xd800, 0xdb7f);
/**
- * The "High Private Use Surrogates" Unicode Block.
- * This block represents code point values in the high surrogate range 0xDB80 to 0xDBFF @since 1.5
+ * The "High Private Use Surrogates" Unicode Block. This block
+ * represents code point values in the high surrogate range 0xDB80 to
+ * 0xDBFF
*/
public static final UnicodeBlock HIGH_PRIVATE_USE_SURROGATES = new UnicodeBlock("HIGH_PRIVATE_USE_SURROGATES", 0xdb80, 0xdbff);
/**
- * The "Low Surrogates" Unicode Block.
- * This block represents code point values in the low surrogate range 0xDC00 to 0xDFFF @since 1.5
+ * The "Low Surrogates" Unicode Block. This block represents
+ * code point values in the low surrogate range 0xDC00 to 0xDFFF
*/
public static final UnicodeBlock LOW_SURROGATES = new UnicodeBlock("LOW_SURROGATES", 0xdc00, 0xdfff);
/**
- * The "Private Use Area" Unicode Block.
+ * The "Private Use Area" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock PRIVATE_USE_AREA = new UnicodeBlock("PRIVATE_USE_AREA", 0xe000, 0xf8ff);
/**
- * The "CJK Compatibility Ideographs" Unicode Block.
+ * The "CJK Compatibility Ideographs" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CJK_COMPATIBILITY_IDEOGRAPHS = new UnicodeBlock("CJK_COMPATIBILITY_IDEOGRAPHS", 0xf900, 0xfaff);
/**
- * The "Alphabetic Presentation Forms" Unicode Block.
+ * The "Alphabetic Presentation Forms" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ALPHABETIC_PRESENTATION_FORMS = new UnicodeBlock("ALPHABETIC_PRESENTATION_FORMS", 0xfb00, 0xfb4f);
/**
- * The "Arabic Presentation Forms-A" Unicode Block.
+ * The "Arabic Presentation Forms-A" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ARABIC_PRESENTATION_FORMS_A = new UnicodeBlock("ARABIC_PRESENTATION_FORMS_A", 0xfb50, 0xfdff);
/**
- * The "Variation Selectors" Unicode Block.
+ * The "Variation Selectors" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock VARIATION_SELECTORS = new UnicodeBlock("VARIATION_SELECTORS", 0xfe00, 0xfe0f);
/**
- * The "Combining Half Marks" Unicode Block.
+ * The "Combining Half Marks" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock COMBINING_HALF_MARKS = new UnicodeBlock("COMBINING_HALF_MARKS", 0xfe20, 0xfe2f);
/**
- * The "CJK Compatibility Forms" Unicode Block.
+ * The "CJK Compatibility Forms" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock CJK_COMPATIBILITY_FORMS = new UnicodeBlock("CJK_COMPATIBILITY_FORMS", 0xfe30, 0xfe4f);
/**
- * The "Small Form Variants" Unicode Block.
+ * The "Small Form Variants" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock SMALL_FORM_VARIANTS = new UnicodeBlock("SMALL_FORM_VARIANTS", 0xfe50, 0xfe6f);
/**
- * The "Arabic Presentation Forms-B" Unicode Block.
+ * The "Arabic Presentation Forms-B" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock ARABIC_PRESENTATION_FORMS_B = new UnicodeBlock("ARABIC_PRESENTATION_FORMS_B", 0xfe70, 0xfeff);
/**
- * The "Halfwidth and Fullwidth Forms" Unicode Block.
+ * The "Halfwidth and Fullwidth Forms" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock HALFWIDTH_AND_FULLWIDTH_FORMS = new UnicodeBlock("HALFWIDTH_AND_FULLWIDTH_FORMS", 0xff00, 0xffef);
/**
- * The "Specials" Unicode Block.
+ * The "Specials" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock SPECIALS = new UnicodeBlock("SPECIALS", 0xfff0, 0xffff);
/**
- * The "Linear B Syllabary" Unicode Block.
+ * The "Linear B Syllabary" Unicode Block.
+ *
* @since 1.2
*/
public static final UnicodeBlock LINEAR_B_SYLLABARY = new UnicodeBlock("LINEAR_B_SYLLABARY", 0x10000, 0x1007f);
/**
- * The "Linear B Ideograms" Unicode Block.
+ * The "Linear B Ideograms" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock LINEAR_B_IDEOGRAMS = new UnicodeBlock("LINEAR_B_IDEOGRAMS", 0x10080, 0x100ff);
/**
- * The "Aegean Numbers" Unicode Block.
+ * The "Aegean Numbers" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock AEGEAN_NUMBERS = new UnicodeBlock("AEGEAN_NUMBERS", 0x10100, 0x1013f);
/**
- * The "Old Italic" Unicode Block.
+ * The "Old Italic" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock OLD_ITALIC = new UnicodeBlock("OLD_ITALIC", 0x10300, 0x1032f);
/**
- * The "Gothic" Unicode Block.
+ * The "Gothic" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock GOTHIC = new UnicodeBlock("GOTHIC", 0x10330, 0x1034f);
/**
- * The "Ugaritic" Unicode Block.
+ * The "Ugaritic" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock UGARITIC = new UnicodeBlock("UGARITIC", 0x10380, 0x1039f);
/**
- * The "Deseret" Unicode Block.
+ * The "Deseret" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock DESERET = new UnicodeBlock("DESERET", 0x10400, 0x1044f);
/**
- * The "Shavian" Unicode Block.
+ * The "Shavian" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SHAVIAN = new UnicodeBlock("SHAVIAN", 0x10450, 0x1047f);
/**
- * The "Osmanya" Unicode Block.
+ * The "Osmanya" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock OSMANYA = new UnicodeBlock("OSMANYA", 0x10480, 0x104af);
/**
- * The "Cypriot Syllabary" Unicode Block.
+ * The "Cypriot Syllabary" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock CYPRIOT_SYLLABARY = new UnicodeBlock("CYPRIOT_SYLLABARY", 0x10800, 0x1083f);
/**
- * The "Byzantine Musical Symbols" Unicode Block.
+ * The "Byzantine Musical Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock BYZANTINE_MUSICAL_SYMBOLS = new UnicodeBlock("BYZANTINE_MUSICAL_SYMBOLS", 0x1d000, 0x1d0ff);
/**
- * The "Musical Symbols" Unicode Block.
+ * The "Musical Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock MUSICAL_SYMBOLS = new UnicodeBlock("MUSICAL_SYMBOLS", 0x1d100, 0x1d1ff);
/**
- * The "Tai Xuan Jing Symbols" Unicode Block.
+ * The "Tai Xuan Jing Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock TAI_XUAN_JING_SYMBOLS = new UnicodeBlock("TAI_XUAN_JING_SYMBOLS", 0x1d300, 0x1d35f);
/**
- * The "Mathematical Alphanumeric Symbols" Unicode Block.
+ * The "Mathematical Alphanumeric Symbols" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock MATHEMATICAL_ALPHANUMERIC_SYMBOLS = new UnicodeBlock("MATHEMATICAL_ALPHANUMERIC_SYMBOLS", 0x1d400, 0x1d7ff);
/**
- * The "CJK Unified Ideographs Extension B" Unicode Block.
+ * The "CJK Unified Ideographs Extension B" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B = new UnicodeBlock("CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B", 0x20000, 0x2a6df);
/**
- * The "CJK Compatibility Ideographs Supplement" Unicode Block.
+ * The "CJK Compatibility Ideographs Supplement" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT = new UnicodeBlock("CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT", 0x2f800, 0x2fa1f);
/**
- * The "Tags" Unicode Block.
+ * The "Tags" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock TAGS = new UnicodeBlock("TAGS", 0xe0000, 0xe007f);
/**
- * The "Variation Selectors Supplement" Unicode Block.
+ * The "Variation Selectors Supplement" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock VARIATION_SELECTORS_SUPPLEMENT = new UnicodeBlock("VARIATION_SELECTORS_SUPPLEMENT", 0xe0100, 0xe01ef);
/**
- * The "Supplementary Private Use Area-A" Unicode Block.
+ * The "Supplementary Private Use Area-A" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SUPPLEMENTARY_PRIVATE_USE_AREA_A = new UnicodeBlock("SUPPLEMENTARY_PRIVATE_USE_AREA_A", 0xf0000, 0xfffff);
/**
- * The "Supplementary Private Use Area-B" Unicode Block.
+ * The "Supplementary Private Use Area-B" Unicode Block.
+ *
* @since 1.5
*/
public static final UnicodeBlock SUPPLEMENTARY_PRIVATE_USE_AREA_B = new UnicodeBlock("SUPPLEMENTARY_PRIVATE_USE_AREA_B", 0x100000, 0x10ffff);
@@ -1744,30 +1871,28 @@
}
/**
- * <p>
- * Retrieves the constant that corresponds to the block name given. The
- * block names are defined by the Unicode 4.0.1 specification in the
- * <code>Blocks-4.0.1.txt</code> file.
- * </p>
+ * Retrieves the constant that corresponds to the specified block name.
+ * The block names are defined by the Unicode 4.0.1 specification in the
+ * {@code Blocks-4.0.1.txt} file.
* <p>
* Block names may be one of the following:
- * </p>
* <ul>
* <li>Canonical block name, as defined by the Unicode specification;
* case-insensitive.</li>
* <li>Canonical block name without any spaces, as defined by the
* Unicode specification; case-insensitive.</li>
- * <li><code>UnicodeBlock</code> constant identifier. This is
- * determined by uppercasing the canonical name and replacing all spaces
- * and hyphens with underscores.</li>
+ * <li>{@code UnicodeBlock} constant identifier. This is determined by
+ * uppercasing the canonical name and replacing all spaces and hyphens
+ * with underscores.</li>
* </ul>
*
- * @param blockName The name of the block to retrieve.
- * @return A UnicodeBlock constant.
- * @throws NullPointerException if <code>blockName</code> is
- * <code>null</code>.
- * @throws IllegalArgumentException if <code>blockName</code> is not a
- * valid block name.
+ * @param blockName
+ * the name of the block to retrieve.
+ * @return the UnicodeBlock constant corresponding to {@code blockName}.
+ * @throws NullPointerException
+ * if {@code blockName} is {@code null}.
+ * @throws IllegalArgumentException
+ * if {@code blockName} is not a valid block name.
* @since 1.5
*/
public static UnicodeBlock forName(String blockName) {
@@ -1782,29 +1907,32 @@
}
/**
- * <p>
- * Retrieves the constant that contains the given <code>char</code> or
- * <code>null</code> if there is none.
- * </p>
+ * Gets the constant for the Unicode block that contains the specified
+ * character.
*
- * @param c The character to retrieve a UnicodeBlock for.
- * @return A UnicodeBlock constant or <code>null</code>.
+ * @param c
+ * the character for which to get the {@code UnicodeBlock}
+ * constant.
+ * @return the {@code UnicodeBlock} constant for the block that contains
+ * {@code c}, or {@code null} if {@code c} does not belong to
+ * any defined block.
*/
public static UnicodeBlock of(char c) {
return of((int) c);
}
/**
- * <p>
- * Retrieves the constant that contains the given Unicode code point or
- * <code>null</code> if there is none.
- * </p>
+ * Gets the constant for the Unicode block that contains the specified
+ * Unicode code point.
*
- * @param codePoint The Unicode code point to retrieve a UnicodeBlock
- * for.
- * @return A UnicodeBlock constant or <code>null</code>.
- * @throws IllegalArgumentException if <code>codePoint</code> is not a
- * valid Unicode code point.
+ * @param codePoint
+ * the Unicode code point for which to get the
+ * {@code UnicodeBlock} constant.
+ * @return the {@code UnicodeBlock} constant for the block that contains
+ * {@code codePoint}, or {@code null} if {@code codePoint} does
+ * not belong to any defined block.
+ * @throws IllegalArgumentException
+ * if {@code codePoint} is not a valid Unicode code point.
* @since 1.5
*/
public static UnicodeBlock of(int codePoint) {
@@ -1838,36 +1966,37 @@
}
/**
- * Constructs a new instance of the receiver which represents the char
- * valued argument.
+ * Constructs a new {@code Character} with the specified primitive char
+ * value.
*
* @param value
- * the char to store in the new instance.
+ * the primitive char value to store in the new instance.
*/
public Character(char value) {
this.value = value;
}
/**
- * Answers the char value which the receiver represents.
+ * Gets the primitive value of this character.
*
- * @return char the value of the receiver
+ * @return this object's primitive value.
*/
public char charValue() {
return value;
}
/**
- * Compares the receiver to the specified Character to determine the
- * relative ordering.
+ * Compares this object to the specified character object to determine their
+ * relative order.
*
* @param c
- * the Character
- * @return an int < 0 if this Character is less than the specified
- * Character, 0 if they are equal, and > 0 if this Character is
- * greater
- * @throws NullPointerException
- * if <code>c</code> is <code>null</code>.
+ * the character object to compare this object to.
+ * @return {@code 0} if the value of this character and the value of
+ * {@code c} are equal; a positive value if the value of this
+ * character is greater than the value of {@code c}; a negative
+ * value if the value of this character is less than the value of
+ * {@code c}.
+ * @see java.lang.Comparable
* @since 1.2
*/
public int compareTo(Character c) {
@@ -1875,14 +2004,14 @@
}
/**
- * <p>
- * Returns a <code>Character</code> instance for the <code>char</code>
- * value passed. This method is preferred over the constructor, as this
- * method may maintain a cache of instances.
- * </p>
- *
- * @param c The char value.
- * @return A <code>Character</code> instance.
+ * Returns a {@code Character} instance for the {@code char} value passed.
+ * For ASCII/Latin-1 characters (and generally all characters with a Unicode
+ * value up to 512), this method should be used instead of the constructor,
+ * as it maintains a cache of corresponding {@code Character} instances.
+ *
+ * @param c
+ * the char value for which to get a {@code Character} instance.
+ * @return the {@code Character} instance for {@code c}.
* @since 1.5
*/
public static Character valueOf(char c) {
@@ -1909,13 +2038,12 @@
}
}
/**
- * <p>
- * A test for determining if the <code>codePoint</code> is a valid Unicode
- * code point.
- * </p>
- *
- * @param codePoint The code point to test.
- * @return A boolean value.
+ * Indicates whether {@code codePoint} is a valid Unicode code point.
+ *
+ * @param codePoint
+ * the code point to test.
+ * @return {@code true} if {@code codePoint} is a valid Unicode code point;
+ * {@code false} otherwise.
* @since 1.5
*/
public static boolean isValidCodePoint(int codePoint) {
@@ -1923,13 +2051,13 @@
}
/**
- * <p>
- * A test for determining if the <code>codePoint</code> is within the
- * supplementary code point range.
- * </p>
- *
- * @param codePoint The code point to test.
- * @return A boolean value.
+ * Indicates whether {@code codePoint} is within the supplementary code
+ * point range.
+ *
+ * @param codePoint
+ * the code point to test.
+ * @return {@code true} if {@code codePoint} is within the supplementary
+ * code point range; {@code false} otherwise.
* @since 1.5
*/
public static boolean isSupplementaryCodePoint(int codePoint) {
@@ -1937,88 +2065,88 @@
}
/**
- * <p>
- * A test for determining if the <code>char</code> is a high
- * surrogate/leading surrogate unit that's used for representing
- * supplementary characters in UTF-16 encoding.
- * </p>
- *
- * @param ch The <code>char</code> unit to test.
- * @return A boolean value.
- * @since 1.5
+ * Indicates whether {@code ch} is a high- (or leading-) surrogate code unit
+ * that is used for representing supplementary characters in UTF-16
+ * encoding.
+ *
+ * @param ch
+ * the character to test.
+ * @return {@code true} if {@code ch} is a high-surrogate code unit;
+ * {@code false} otherwise.
* @see #isLowSurrogate(char)
+ * @since 1.5
*/
public static boolean isHighSurrogate(char ch) {
return (MIN_HIGH_SURROGATE <= ch && MAX_HIGH_SURROGATE >= ch);
}
/**
- * <p>
- * A test for determining if the <code>char</code> is a high
- * surrogate/leading surrogate unit that's used for representing
- * supplementary characters in UTF-16 encoding.
- * </p>
- *
- * @param ch The <code>char</code> unit to test.
- * @return A boolean value.
- * @since 1.5
+ * Indicates whether {@code ch} is a low- (or trailing-) surrogate code unit
+ * that is used for representing supplementary characters in UTF-16
+ * encoding.
+ *
+ * @param ch
+ * the character to test.
+ * @return {@code true} if {@code ch} is a low-surrogate code unit;
+ * {@code false} otherwise.
* @see #isHighSurrogate(char)
+ * @since 1.5
*/
public static boolean isLowSurrogate(char ch) {
return (MIN_LOW_SURROGATE <= ch && MAX_LOW_SURROGATE >= ch);
}
/**
- * <p>
- * A test for determining if the <code>char</code> pair is a valid
- * surrogate pair.
- * </p>
- *
- * @param high The high surrogate unit to test.
- * @param low The low surrogate unit to test.
- * @return A boolean value.
- * @since 1.5
+ * Indicates whether the specified character pair is a valid surrogate pair.
+ *
+ * @param high
+ * the high surrogate unit to test.
+ * @param low
+ * the low surrogate unit to test.
+ * @return {@code true} if {@code high} is a high-surrogate code unit and
+ * {@code low} is a low-surrogate code unit; {@code false}
+ * otherwise.
* @see #isHighSurrogate(char)
* @see #isLowSurrogate(char)
+ * @since 1.5
*/
public static boolean isSurrogatePair(char high, char low) {
return (isHighSurrogate(high) && isLowSurrogate(low));
}
/**
- * <p>
- * Calculates the number of <code>char</code> values required to represent
- * the Unicode code point. This method only tests if the
- * <code>codePoint</code> is greater than or equal to <code>0x10000</code>,
- * in which case <code>2</code> is returned, otherwise <code>1</code>.
- * To test if the code point is valid, use the
- * {@link #isValidCodePoint(int)} method.
- * </p>
- *
- * @param codePoint The code point to test.
- * @return An <code>int</code> value of 2 or 1.
- * @since 1.5
+ * Calculates the number of {@code char} values required to represent the
+ * specified Unicode code point. This method checks if the {@code codePoint}
+ * is greater than or equal to {@code 0x10000}, in which case {@code 2} is
+ * returned, otherwise {@code 1}. To test if the code point is valid, use
+ * the {@link #isValidCodePoint(int)} method.
+ *
+ * @param codePoint
+ * the code point for which to calculate the number of required
+ * chars.
+ * @return {@code 2} if {@code codePoint >= 0x10000}; {@code 1} otherwise.
* @see #isValidCodePoint(int)
* @see #isSupplementaryCodePoint(int)
+ * @since 1.5
*/
public static int charCount(int codePoint) {
return (codePoint >= 0x10000 ? 2 : 1);
}
/**
- * <p>
- * Converts a surrogate pair into a Unicode code point. This method assume
- * that the pair are valid surrogates. If the pair are NOT valid surrogates,
- * then the result is indeterminate. The
+ * Converts a surrogate pair into a Unicode code point. This method assumes
+ * that the pair are valid surrogates. If the pair are <i>not</i> valid
+ * surrogates, then the result is indeterminate. The
* {@link #isSurrogatePair(char, char)} method should be used prior to this
* method to validate the pair.
- * </p>
- *
- * @param high The high surrogate unit.
- * @param low The low surrogate unit.
- * @return The decoded code point.
- * @since 1.5
+ *
+ * @param high
+ * the high surrogate unit.
+ * @param low
+ * the low surrogate unit.
+ * @return the Unicode code point corresponding to the surrogate unit pair.
* @see #isSurrogatePair(char, char)
+ * @since 1.5
*/
public static int toCodePoint(char high, char low) {
// See RFC 2781, Section 2.2
@@ -2029,22 +2157,25 @@
}
/**
- * <p>
- * Returns the code point at the index in the <code>CharSequence</code>.
- * If <code>char</code> unit at the index is a high-surrogate unit, the
- * next index is less than the length of the sequence and the
- * <code>char</code> unit at the next index is a low surrogate unit, then
- * the code point represented by the pair is returned; otherwise the
- * <code>char</code> unit at the index is returned.
- * </p>
- *
- * @param seq The sequence of <code>char</code> units.
- * @param index The index into the <code>seq</code> to retrieve and
- * convert.
- * @return The Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if the <code>index</code> is negative
- * or greater than or equal to <code>seq.length()</code>.
+ * Returns the code point at {@code index} in the specified sequence of
+ * character units. If the unit at {@code index} is a high-surrogate unit,
+ * {@code index + 1} is less than the length of the sequence and the unit at
+ * {@code index + 1} is a low-surrogate unit, then the supplementary code
+ * point represented by the pair is returned; otherwise the {@code char}
+ * value at {@code index} is returned.
+ *
+ * @param seq
+ * the source sequence of {@code char} units.
+ * @param index
+ * the position in {@code seq} from which to retrieve the code
+ * point.
+ * @return the Unicode code point or {@code char} value at {@code index} in
+ * {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if the {@code index} is negative or greater than or equal to
+ * the length of {@code seq}.
* @since 1.5
*/
public static int codePointAt(CharSequence seq, int index) {
@@ -2068,22 +2199,25 @@
}
/**
- * <p>
- * Returns the code point at the index in the <code>char[]</code>. If
- * <code>char</code> unit at the index is a high-surrogate unit, the next
- * index is less than the length of the sequence and the <code>char</code>
- * unit at the next index is a low surrogate unit, then the code point
- * represented by the pair is returned; otherwise the <code>char</code>
- * unit at the index is returned.
- * </p>
- *
- * @param seq The sequence of <code>char</code> units.
- * @param index The index into the <code>seq</code> to retrieve and
- * convert.
- * @return The Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if the <code>index</code> is negative
- * or greater than or equal to <code>seq.length()</code>.
+ * Returns the code point at {@code index} in the specified array of
+ * character units. If the unit at {@code index} is a high-surrogate unit,
+ * {@code index + 1} is less than the length of the array and the unit at
+ * {@code index + 1} is a low-surrogate unit, then the supplementary code
+ * point represented by the pair is returned; otherwise the {@code char}
+ * value at {@code index} is returned.
+ *
+ * @param seq
+ * the source array of {@code char} units.
+ * @param index
+ * the position in {@code seq} from which to retrieve the code
+ * point.
+ * @return the Unicode code point or {@code char} value at {@code index} in
+ * {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if the {@code index} is negative or greater than or equal to
+ * the length of {@code seq}.
* @since 1.5
*/
public static int codePointAt(char[] seq, int index) {
@@ -2107,26 +2241,28 @@
}
/**
- * <p>
- * Returns the code point at the index in the <code>char[]</code> that's
- * within the limit. If <code>char</code> unit at the index is a
- * high-surrogate unit, the next index is less than the <code>limit</code>
- * and the <code>char</code> unit at the next index is a low surrogate
- * unit, then the code point represented by the pair is returned; otherwise
- * the <code>char</code> unit at the index is returned.
- * </p>
- *
- * @param seq The sequence of <code>char</code> units.
- * @param index The index into the <code>seq</code> to retrieve and
- * convert.
- * @param limit The exclusive index into the <code>seq</code> that marks
- * the end of the units that can be used.
- * @return The Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if the <code>index</code> is
- * negative, greater than or equal to <code>limit</code>,
- * <code>limit</code> is negative or <code>limit</code> is
- * greater than the length of <code>seq</code>.
+ * Returns the code point at {@code index} in the specified array of
+ * character units, where {@code index} has to be less than {@code limit}.
+ * If the unit at {@code index} is a high-surrogate unit, {@code index + 1}
+ * is less than {@code limit} and the unit at {@code index + 1} is a
+ * low-surrogate unit, then the supplementary code point represented by the
+ * pair is returned; otherwise the {@code char} value at {@code index} is
+ * returned.
+ *
+ * @param seq
+ * the source array of {@code char} units.
+ * @param index
+ * the position in {@code seq} from which to get the code point.
+ * @param limit
+ * the index after the last unit in {@code seq} that can be used.
+ * @return the Unicode code point or {@code char} value at {@code index} in
+ * {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if {@code index < 0}, {@code index >= limit},
+ * {@code limit < 0} or if {@code limit} is greater than the
+ * length of {@code seq}.
* @since 1.5
*/
public static int codePointAt(char[] seq, int index, int limit) {
@@ -2146,23 +2282,25 @@
}
/**
- * <p>
- * Returns the Unicode code point that proceeds the <code>index</code> in
- * the <code>CharSequence</code>. If the <code>char</code> unit at
- * <code>index - 1</code> is within the low surrogate range, the value
- * <code>index - 2</code> isn't negative and the <code>char</code> unit
- * at <code>index - 2</code> is within the high surrogate range, then the
- * supplementary code point made up of the surrogate pair is returned;
- * otherwise, the <code>char</code> value at <code>index - 1</code> is
- * returned.
- * </p>
- *
- * @param seq The <code>CharSequence</code> to search.
- * @param index The index into the <code>seq</code>.
- * @return A Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>index</code> is less than 1
- * or greater than <code>seq.length()</code>.
+ * Returns the code point that preceds {@code index} in the specified
+ * sequence of character units. If the unit at {@code index - 1} is a
+ * low-surrogate unit, {@code index - 2} is not negative and the unit at
+ * {@code index - 2} is a high-surrogate unit, then the supplementary code
+ * point represented by the pair is returned; otherwise the {@code char}
+ * value at {@code index - 1} is returned.
+ *
+ * @param seq
+ * the source sequence of {@code char} units.
+ * @param index
+ * the position in {@code seq} following the code
+ * point that should be returned.
+ * @return the Unicode code point or {@code char} value before {@code index}
+ * in {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if the {@code index} is less than 1 or greater than the
+ * length of {@code seq}.
* @since 1.5
*/
public static int codePointBefore(CharSequence seq, int index) {
@@ -2186,23 +2324,25 @@
}
/**
- * <p>
- * Returns the Unicode code point that proceeds the <code>index</code> in
- * the <code>char[]</code>. If the <code>char</code> unit at
- * <code>index - 1</code> is within the low surrogate range, the value
- * <code>index - 2</code> isn't negative and the <code>char</code> unit
- * at <code>index - 2</code> is within the high surrogate range, then the
- * supplementary code point made up of the surrogate pair is returned;
- * otherwise, the <code>char</code> value at <code>index - 1</code> is
- * returned.
- * </p>
- *
- * @param seq The <code>char[]</code> to search.
- * @param index The index into the <code>seq</code>.
- * @return A Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>index</code> is less than 1
- * or greater than <code>seq.length</code>.
+ * Returns the code point that preceds {@code index} in the specified
+ * array of character units. If the unit at {@code index - 1} is a
+ * low-surrogate unit, {@code index - 2} is not negative and the unit at
+ * {@code index - 2} is a high-surrogate unit, then the supplementary code
+ * point represented by the pair is returned; otherwise the {@code char}
+ * value at {@code index - 1} is returned.
+ *
+ * @param seq
+ * the source array of {@code char} units.
+ * @param index
+ * the position in {@code seq} following the code
+ * point that should be returned.
+ * @return the Unicode code point or {@code char} value before {@code index}
+ * in {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if the {@code index} is less than 1 or greater than the
+ * length of {@code seq}.
* @since 1.5
*/
public static int codePointBefore(char[] seq, int index) {
@@ -2226,27 +2366,30 @@
}
/**
- * <p>
- * Returns the Unicode code point that proceeds the <code>index</code> in
- * the <code>char[]</code> and isn't less than <code>start</code>. If
- * the <code>char</code> unit at <code>index - 1</code> is within the
- * low surrogate range, the value <code>index - 2</code> isn't less than
- * <code>start</code> and the <code>char</code> unit at
- * <code>index - 2</code> is within the high surrogate range, then the
- * supplementary code point made up of the surrogate pair is returned;
- * otherwise, the <code>char</code> value at <code>index - 1</code> is
- * returned.
- * </p>
- *
- * @param seq The <code>char[]</code> to search.
- * @param index The index into the <code>seq</code>.
- * @return A Unicode code point.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>index</code> is less than or
- * equal to <code>start</code>, <code>index</code> is greater
- * than <code>seq.length</code>, <code>start</code> is not
- * negative and <code>start</code> is greater than
- * <code>seq.length</code>.
+ * Returns the code point that preceds the {@code index} in the specified
+ * array of character units and is not less than {@code start}. If the unit
+ * at {@code index - 1} is a low-surrogate unit, {@code index - 2} is not
+ * less than {@code start} and the unit at {@code index - 2} is a
+ * high-surrogate unit, then the supplementary code point represented by the
+ * pair is returned; otherwise the {@code char} value at {@code index - 1}
+ * is returned.
+ *
+ * @param seq
+ * the source array of {@code char} units.
+ * @param index
+ * the position in {@code seq} following the code point that
+ * should be returned.
+ * @param start
+ * the index of the first element in {@code seq}.
+ * @return the Unicode code point or {@code char} value before {@code index}
+ * in {@code seq}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if the {@code index <= start}, {@code start < 0},
+ * {@code index} is greater than the length of {@code seq}, or
+ * if {@code start} is equal or greater than the length of
+ * {@code seq}.
* @since 1.5
*/
public static int codePointBefore(char[] seq, int index, int start) {
@@ -2270,25 +2413,26 @@
}
/**
- * <p>
- * Converts the Unicode code point, <code>codePoint</code>, into a UTF-16
- * encoded sequence and copies the value(s) into the
- * <code>char[]</code> <code>dst</code>, starting at the index
- * <code>dstIndex</code>.
- * </p>
- *
- * @param codePoint The Unicode code point to encode.
- * @param dst The <code>char[]</code> to copy the encoded value into.
- * @param dstIndex The index to start copying into <code>dst</code>.
- * @return The number of <code>char</code> value units copied into
- * <code>dst</code>.
- * @throws IllegalArgumentException if <code>codePoint</code> is not a
- * valid Unicode code point.
- * @throws NullPointerException if <code>dst</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>dstIndex</code> is negative,
- * greater than or equal to <code>dst.length</code> or equals
- * <code>dst.length - 1</code> when <code>codePoint</code> is a
- * {@link #isSupplementaryCodePoint(int) supplementary code point}.
+ * Converts the specified Unicode code point into a UTF-16 encoded sequence
+ * and copies the value(s) into the char array {@code dst}, starting at
+ * index {@code dstIndex}.
+ *
+ * @param codePoint
+ * the Unicode code point to encode.
+ * @param dst
+ * the destination array to copy the encoded value into.
+ * @param dstIndex
+ * the index in {@code dst} from where to start copying.
+ * @return the number of {@code char} value units copied into {@code dst}.
+ * @throws IllegalArgumentException
+ * if {@code codePoint} is not a valid Unicode code point.
+ * @throws NullPointerException
+ * if {@code dst} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if {@code dstIndex} is negative, greater than or equal to
+ * {@code dst.length} or equals {@code dst.length - 1} when
+ * {@code codePoint} is a
+ * {@link #isSupplementaryCodePoint(int) supplementary code point}.
* @since 1.5
*/
public static int toChars(int codePoint, char[] dst, int dstIndex) {
@@ -2321,18 +2465,17 @@
}
/**
- * <p>
- * Converts the Unicode code point, <code>codePoint</code>, into a UTF-16
- * encoded sequence that is returned as a <code>char[]</code>.
- * </p>
- *
- * @param codePoint The Unicode code point to encode.
- * @return The UTF-16 encoded <code>char</code> sequence; if code point is
- * a {@link #isSupplementaryCodePoint(int) supplementary code point},
- * then a 2 <code>char</code> array is returned, otherwise a 1
- * <code>char</code> array is returned.
- * @throws IllegalArgumentException if <code>codePoint</code> is not a
- * valid Unicode code point.
+ * Converts the specified Unicode code point into a UTF-16 encoded sequence
+ * and returns it as a char array.
+ *
+ * @param codePoint
+ * the Unicode code point to encode.
+ * @return the UTF-16 encoded char sequence. If {@code codePoint} is a
+ * {@link #isSupplementaryCodePoint(int) supplementary code point},
+ * then the returned array contains two characters, otherwise it
+ * contains just one character.
+ * @throws IllegalArgumentException
+ * if {@code codePoint} is not a valid Unicode code point.
* @since 1.5
*/
public static char[] toChars(int codePoint) {
@@ -2350,21 +2493,23 @@
}
/**
- * <p>
* Counts the number of Unicode code points in the subsequence of the
- * <code>CharSequence</code>, as delineated by the
- * <code>beginIndex</code> and <code>endIndex</code>. Any surrogate
- * values with missing pair values will be counted as 1 code point.
- * </p>
- *
- * @param seq The <code>CharSequence</code> to look through.
- * @param beginIndex The inclusive index to begin counting at.
- * @param endIndex The exclusive index to stop counting at.
- * @return The number of Unicode code points.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>beginIndex</code> is
- * negative, greater than <code>seq.length()</code> or greater
- * than <code>endIndex</code>.
+ * specified character sequence, as delineated by {@code beginIndex} and
+ * {@code endIndex}. Any surrogate values with missing pair values will be
+ * counted as one code point.
+ *
+ * @param seq
+ * the {@code CharSequence} to look through.
+ * @param beginIndex
+ * the inclusive index to begin counting at.
+ * @param endIndex
+ * the exclusive index to stop counting at.
+ * @return the number of Unicode code points.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if {@code beginIndex < 0}, {@code beginIndex > endIndex} or
+ * if {@code endIndex} is greater than the length of {@code seq}.
* @since 1.5
*/
public static int codePointCount(CharSequence seq, int beginIndex,
@@ -2394,22 +2539,25 @@
}
/**
- * <p>
* Counts the number of Unicode code points in the subsequence of the
- * <code>char[]</code>, as delineated by the <code>offset</code> and
- * <code>count</code>. Any surrogate values with missing pair values will
- * be counted as 1 code point.
- * </p>
- *
- * @param seq The <code>char[]</code> to look through.
- * @param offset The inclusive index to begin counting at.
- * @param count The number of <code>char</code> values to look through in
- * <code>seq</code>.
- * @return The number of Unicode code points.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>offset</code> or
- * <code>count</code> is negative or if <code>endIndex</code> is
- * greater than <code>seq.length</code>.
+ * specified char array, as delineated by {@code offset} and {@code count}.
+ * Any surrogate values with missing pair values will be counted as one code
+ * point.
+ *
+ * @param seq
+ * the char array to look through
+ * @param offset
+ * the inclusive index to begin counting at.
+ * @param count
+ * the number of {@code char} values to look through in
+ * {@code seq}.
+ * @return the number of Unicode code points.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if {@code offset < 0}, {@code count < 0} or if
+ * {@code offset + count} is greater than the length of
+ * {@code seq}.
* @since 1.5
*/
public static int codePointCount(char[] seq, int offset, int count) {
@@ -2439,25 +2587,26 @@
}
/**
- * <p>
- * Determines the index into the <code>CharSequence</code> that is offset
- * (measured in code points and specified by <code>codePointOffset</code>),
- * from the <code>index</code> argument.
- * </p>
- *
- * @param seq The <code>CharSequence</code> to find the index within.
- * @param index The index to begin from, within the
- * <code>CharSequence</code>.
- * @param codePointOffset The number of code points to look back or
- * forwards; may be a negative or positive value.
- * @return The calculated index that is <code>codePointOffset</code> code
- * points from <code>index</code>.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>index</code> is negative,
- * greater than <code>seq.length()</code>, there aren't enough
- * values in <code>seq</code> after <code>index</code> or before
- * <code>index</code> if <code>codePointOffset</code> is
- * negative.
+ * Determines the index in the specified character sequence that is offset
+ * {@code codePointOffset} code points from {@code index}.
+ *
+ * @param seq
+ * the character sequence to find the index in.
+ * @param index
+ * the start index in {@code seq}.
+ * @param codePointOffset
+ * the number of code points to look backwards or forwards; may
+ * be a negative or positive value.
+ * @return the index in {@code seq} that is {@code codePointOffset} code
+ * points away from {@code index}.
+ * @throws NullPointerException
+ * if {@code seq} is {@code null}.
+ * @throws IndexOutOfBoundsException
+ * if {@code index < 0}, {@code index} is greater than the
+ * length of {@code seq}, or if there are not enough values in
+ * {@code seq} to skip {@code codePointOffset} code points
+ * forwards or backwards (if {@code codePointOffset} is
+ * negative) from {@code index}.
* @since 1.5
*/
public static int offsetByCodePoints(CharSequence seq, int index,
@@ -2513,33 +2662,35 @@
}
/**
- * <p>
- * Determines the index into the <code>char[]</code> that is offset
- * (measured in code points and specified by <code>codePointOffset</code>),
- * from the <code>index</code> argument and is within the subsequence as
- * delineated by <code>start</code> and <code>count</code>.
- * </p>
- *
- * @param seq The <code>char[]</code> to find the index within.
- *
- * @param index The index to begin from, within the <code>char[]</code>.
- * @param codePointOffset The number of code points to look back or
- * forwards; may be a negative or positive value.
- * @param start The inclusive index that marks the beginning of the
- * subsequence.
- * @param count The number of <code>char</code> values to include within
- * the subsequence.
- * @return The calculated index that is <code>codePointOffset</code> code
- * points from <code>index</code>.
- * @throws NullPointerException if <code>seq</code> is <code>null</code>.
- * @throws IndexOutOfBoundsException if <code>start</code> or
- * <code>count</code> is negative, <code>start + count</code>
[... 981 lines stripped ...]