jars/icu4j-4_4_2-src/main/classes/core/src/com/ibm/icu/lang/UCharacterEnums.java

   1 /**\r
   2  *******************************************************************************\r
   3  * Copyright (C) 2004-2007, International Business Machines Corporation and    *\r
   4  * others. All Rights Reserved.                                                *\r
   5  *******************************************************************************\r
   6  */\r
   7 \r
   8 package com.ibm.icu.lang;\r
   9 \r
  10 /**\r
  11  * A container for the different 'enumerated types' used by UCharacter.\r
  12  * @stable ICU 3.0\r
  13  */\r
  14 public class UCharacterEnums {\r
  15 \r
  16     /** This is just a namespace, it is not instantiatable. */\r
  17     ///CLOVER:OFF\r
  18     private UCharacterEnums() {}\r
  19 \r
  20     /**\r
  21      * 'Enum' for the CharacterCategory constants.  These constants are \r
  22      * compatible in name <b>but not in value</b> with those defined in\r
  23      * <code>java.lang.Character</code>.\r
  24      * @see UCharacterCategory\r
  25      * @stable ICU 3.0\r
  26      */\r
  27     public static interface ECharacterCategory {\r
  28         /**\r
  29          * Unassigned character type\r
  30          * @stable ICU 2.1\r
  31          */\r
  32         public static final byte UNASSIGNED              = 0; \r
  33 \r
  34         /**\r
  35          * Character type Cn\r
  36          * Not Assigned (no characters in [UnicodeData.txt] have this property) \r
  37          * @stable ICU 2.6\r
  38          */\r
  39         public static final byte GENERAL_OTHER_TYPES     = 0;\r
  40 \r
  41         /**\r
  42          * Character type Lu\r
  43          * @stable ICU 2.1\r
  44          */\r
  45         public static final byte UPPERCASE_LETTER        = 1;\r
  46 \r
  47         /**\r
  48          * Character type Ll\r
  49          * @stable ICU 2.1\r
  50          */\r
  51         public static final byte LOWERCASE_LETTER        = 2;\r
  52 \r
  53         /**\r
  54          * Character type Lt\r
  55          * @stable ICU 2.1\r
  56          */\r
  57 \r
  58         public static final byte TITLECASE_LETTER        = 3;\r
  59 \r
  60         /**\r
  61          * Character type Lm\r
  62          * @stable ICU 2.1\r
  63          */\r
  64         public static final byte MODIFIER_LETTER         = 4;\r
  65 \r
  66         /**\r
  67          * Character type Lo\r
  68          * @stable ICU 2.1\r
  69          */\r
  70         public static final byte OTHER_LETTER            = 5;\r
  71 \r
  72         /**\r
  73          * Character type Mn\r
  74          * @stable ICU 2.1\r
  75          */\r
  76         public static final byte NON_SPACING_MARK        = 6;\r
  77 \r
  78         /**\r
  79          * Character type Me\r
  80          * @stable ICU 2.1\r
  81          */\r
  82         public static final byte ENCLOSING_MARK          = 7;\r
  83 \r
  84         /**\r
  85          * Character type Mc\r
  86          * @stable ICU 2.1\r
  87          */\r
  88         public static final byte COMBINING_SPACING_MARK  = 8;\r
  89 \r
  90         /**\r
  91          * Character type Nd\r
  92          * @stable ICU 2.1      \r
  93          */\r
  94         public static final byte DECIMAL_DIGIT_NUMBER    = 9;\r
  95 \r
  96         /**\r
  97          * Character type Nl\r
  98          * @stable ICU 2.1\r
  99          */\r
 100         public static final byte LETTER_NUMBER           = 10;\r
 101         \r
 102         /**\r
 103          * Character type No\r
 104          * @stable ICU 2.1\r
 105          */\r
 106         public static final byte OTHER_NUMBER            = 11;\r
 107 \r
 108         /**\r
 109          * Character type Zs\r
 110          * @stable ICU 2.1\r
 111          */\r
 112         public static final byte SPACE_SEPARATOR         = 12;\r
 113 \r
 114         /**\r
 115          * Character type Zl\r
 116          * @stable ICU 2.1\r
 117          */\r
 118         public static final byte LINE_SEPARATOR          = 13;\r
 119 \r
 120         /**\r
 121          * Character type Zp\r
 122          * @stable ICU 2.1\r
 123          */\r
 124         public static final byte PARAGRAPH_SEPARATOR     = 14;\r
 125 \r
 126         /**\r
 127          * Character type Cc\r
 128          * @stable ICU 2.1\r
 129          */\r
 130         public static final byte CONTROL                 = 15;\r
 131 \r
 132         /**\r
 133          * Character type Cf\r
 134          * @stable ICU 2.1\r
 135          */\r
 136         public static final byte FORMAT                  = 16;\r
 137 \r
 138         /**\r
 139          * Character type Co\r
 140          * @stable ICU 2.1\r
 141          */\r
 142         public static final byte PRIVATE_USE             = 17;\r
 143 \r
 144         /**\r
 145          * Character type Cs\r
 146          * @stable ICU 2.1\r
 147          */\r
 148         public static final byte SURROGATE               = 18;\r
 149 \r
 150         /**\r
 151          * Character type Pd\r
 152          * @stable ICU 2.1\r
 153          */\r
 154         public static final byte DASH_PUNCTUATION        = 19;\r
 155 \r
 156         /**\r
 157          * Character type Ps\r
 158          * @stable ICU 2.1\r
 159          */\r
 160         public static final byte START_PUNCTUATION       = 20;\r
 161         \r
 162         /**\r
 163          * Character type Pe\r
 164          * @stable ICU 2.1\r
 165          */\r
 166         public static final byte END_PUNCTUATION         = 21;\r
 167 \r
 168         /**\r
 169          * Character type Pc\r
 170          * @stable ICU 2.1\r
 171          */\r
 172         public static final byte CONNECTOR_PUNCTUATION   = 22;\r
 173 \r
 174         /**\r
 175          * Character type Po\r
 176          * @stable ICU 2.1\r
 177          */\r
 178         public static final byte OTHER_PUNCTUATION       = 23;\r
 179 \r
 180         /**\r
 181          * Character type Sm\r
 182          * @stable ICU 2.1\r
 183          */\r
 184         public static final byte MATH_SYMBOL             = 24;\r
 185 \r
 186         /**\r
 187          * Character type Sc\r
 188          * @stable ICU 2.1\r
 189          */\r
 190         public static final byte CURRENCY_SYMBOL         = 25;\r
 191         \r
 192         /**\r
 193          * Character type Sk\r
 194          * @stable ICU 2.1\r
 195          */\r
 196         public static final byte MODIFIER_SYMBOL         = 26;\r
 197         \r
 198         /**\r
 199          * Character type So\r
 200          * @stable ICU 2.1\r
 201          */\r
 202         public static final byte OTHER_SYMBOL            = 27;\r
 203         \r
 204         /**\r
 205          * Character type Pi\r
 206          * @see #INITIAL_QUOTE_PUNCTUATION\r
 207          * @stable ICU 2.1\r
 208          */\r
 209         public static final byte INITIAL_PUNCTUATION     = 28;\r
 210 \r
 211         /**\r
 212          * Character type Pi\r
 213          * This name is compatible with java.lang.Character's name for this type.\r
 214          * @see #INITIAL_PUNCTUATION\r
 215          * @stable ICU 2.8\r
 216          */\r
 217         public static final byte INITIAL_QUOTE_PUNCTUATION = 28;\r
 218 \r
 219         /**\r
 220          * Character type Pf\r
 221          * @see #FINAL_QUOTE_PUNCTUATION\r
 222          * @stable ICU 2.1\r
 223          */\r
 224         public static final byte FINAL_PUNCTUATION       = 29;\r
 225 \r
 226         /**\r
 227          * Character type Pf\r
 228          * This name is compatible with java.lang.Character's name for this type.\r
 229          * @see #FINAL_PUNCTUATION\r
 230          * @stable ICU 2.8\r
 231          */\r
 232         public static final byte FINAL_QUOTE_PUNCTUATION   = 29;\r
 233         \r
 234         /**\r
 235          * Character type count\r
 236          * @stable ICU 2.1\r
 237          */\r
 238         public static final byte CHAR_CATEGORY_COUNT     = 30;\r
 239     }\r
 240 \r
 241     /**\r
 242      * 'Enum' for the CharacterDirection constants.  There are two sets\r
 243      * of names, those used in ICU, and those used in the JDK.  The\r
 244      * JDK constants are compatible in name <b>but not in value</b> \r
 245      * with those defined in <code>java.lang.Character</code>.\r
 246      * @see UCharacterDirection\r
 247      * @stable ICU 3.0\r
 248      */\r
 249     public static interface ECharacterDirection {\r
 250         /**\r
 251          * Directional type L\r
 252          * @stable ICU 2.1\r
 253          */\r
 254         public static final int LEFT_TO_RIGHT              = 0;\r
 255 \r
 256         /**\r
 257          * JDK-compatible synonym for LEFT_TO_RIGHT.\r
 258          * @stable ICU 3.0\r
 259          */\r
 260         public static final byte DIRECTIONALITY_LEFT_TO_RIGHT = (byte)LEFT_TO_RIGHT;\r
 261 \r
 262         /**\r
 263          * Directional type R\r
 264          * @stable ICU 2.1\r
 265          */\r
 266         public static final int RIGHT_TO_LEFT              = 1;\r
 267 \r
 268         /**\r
 269          * JDK-compatible synonym for RIGHT_TO_LEFT.\r
 270          * @stable ICU 3.0\r
 271          */\r
 272         public static final byte DIRECTIONALITY_RIGHT_TO_LEFT = (byte)RIGHT_TO_LEFT;\r
 273 \r
 274         /**\r
 275          * Directional type EN\r
 276          * @stable ICU 2.1\r
 277          */\r
 278         public static final int EUROPEAN_NUMBER            = 2;\r
 279 \r
 280         /**\r
 281          * JDK-compatible synonym for EUROPEAN_NUMBER.\r
 282          * @stable ICU 3.0\r
 283          */\r
 284         public static final byte DIRECTIONALITY_EUROPEAN_NUMBER = (byte)EUROPEAN_NUMBER;\r
 285 \r
 286         /**\r
 287          * Directional type ES\r
 288          * @stable ICU 2.1\r
 289          */\r
 290         public static final int EUROPEAN_NUMBER_SEPARATOR  = 3;\r
 291 \r
 292         /**\r
 293          * JDK-compatible synonym for EUROPEAN_NUMBER_SEPARATOR.\r
 294          * @stable ICU 3.0\r
 295          */\r
 296         public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR = (byte)EUROPEAN_NUMBER_SEPARATOR;\r
 297 \r
 298         /**\r
 299          * Directional type ET\r
 300          * @stable ICU 2.1\r
 301          */\r
 302         public static final int EUROPEAN_NUMBER_TERMINATOR = 4;\r
 303 \r
 304         /**\r
 305          * JDK-compatible synonym for EUROPEAN_NUMBER_TERMINATOR.\r
 306          * @stable ICU 3.0\r
 307          */\r
 308         public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR = (byte)EUROPEAN_NUMBER_TERMINATOR;\r
 309 \r
 310         /**\r
 311          * Directional type AN\r
 312          * @stable ICU 2.1\r
 313          */                                                    \r
 314         public static final int ARABIC_NUMBER              = 5;\r
 315 \r
 316         /**\r
 317          * JDK-compatible synonym for ARABIC_NUMBER.\r
 318          * @stable ICU 3.0\r
 319          */\r
 320         public static final byte DIRECTIONALITY_ARABIC_NUMBER = (byte)ARABIC_NUMBER;\r
 321 \r
 322         /**\r
 323          * Directional type CS\r
 324          * @stable ICU 2.1\r
 325          */\r
 326         public static final int COMMON_NUMBER_SEPARATOR    = 6;\r
 327 \r
 328         /**\r
 329          * JDK-compatible synonym for COMMON_NUMBER_SEPARATOR.\r
 330          * @stable ICU 3.0\r
 331          */\r
 332         public static final byte DIRECTIONALITY_COMMON_NUMBER_SEPARATOR = (byte)COMMON_NUMBER_SEPARATOR;\r
 333 \r
 334         /**\r
 335          * Directional type B\r
 336          * @stable ICU 2.1\r
 337          */\r
 338         public static final int BLOCK_SEPARATOR            = 7;\r
 339 \r
 340         /**\r
 341          * JDK-compatible synonym for BLOCK_SEPARATOR.\r
 342          * @stable ICU 3.0\r
 343          */\r
 344         public static final byte DIRECTIONALITY_PARAGRAPH_SEPARATOR = (byte)BLOCK_SEPARATOR;\r
 345 \r
 346         /**\r
 347          * Directional type S\r
 348          * @stable ICU 2.1\r
 349          */      \r
 350         public static final int SEGMENT_SEPARATOR          = 8;\r
 351 \r
 352         /**\r
 353          * JDK-compatible synonym for SEGMENT_SEPARATOR.\r
 354          * @stable ICU 3.0\r
 355          */\r
 356         public static final byte DIRECTIONALITY_SEGMENT_SEPARATOR = (byte)SEGMENT_SEPARATOR;\r
 357 \r
 358         /**\r
 359          * Directional type WS\r
 360          * @stable ICU 2.1\r
 361          */\r
 362         public static final int WHITE_SPACE_NEUTRAL        = 9;\r
 363 \r
 364         /**\r
 365          * JDK-compatible synonym for WHITE_SPACE_NEUTRAL.\r
 366          * @stable ICU 3.0\r
 367          */\r
 368         public static final byte DIRECTIONALITY_WHITESPACE = (byte)WHITE_SPACE_NEUTRAL;\r
 369 \r
 370         /**\r
 371          * Directional type ON\r
 372          * @stable ICU 2.1\r
 373          */\r
 374         public static final int OTHER_NEUTRAL              = 10;\r
 375 \r
 376         /**\r
 377          * JDK-compatible synonym for OTHER_NEUTRAL.\r
 378          * @stable ICU 3.0\r
 379          */\r
 380         public static final byte DIRECTIONALITY_OTHER_NEUTRALS = (byte)OTHER_NEUTRAL;\r
 381 \r
 382         /**\r
 383          * Directional type LRE\r
 384          * @stable ICU 2.1\r
 385          */\r
 386         public static final int LEFT_TO_RIGHT_EMBEDDING    = 11;\r
 387 \r
 388         /**\r
 389          * JDK-compatible synonym for LEFT_TO_RIGHT_EMBEDDING.\r
 390          * @stable ICU 3.0\r
 391          */\r
 392         public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING = (byte)LEFT_TO_RIGHT_EMBEDDING;\r
 393 \r
 394         /**\r
 395          * Directional type LRO\r
 396          * @stable ICU 2.1\r
 397          */\r
 398         public static final int LEFT_TO_RIGHT_OVERRIDE     = 12;  \r
 399 \r
 400         /**\r
 401          * JDK-compatible synonym for LEFT_TO_RIGHT_OVERRIDE.\r
 402          * @stable ICU 3.0\r
 403          */\r
 404         public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE = (byte)LEFT_TO_RIGHT_OVERRIDE;\r
 405 \r
 406         /**\r
 407          * Directional type AL\r
 408          * @stable ICU 2.1\r
 409          */\r
 410         public static final int RIGHT_TO_LEFT_ARABIC       = 13;\r
 411 \r
 412         /**\r
 413          * JDK-compatible synonym for RIGHT_TO_LEFT_ARABIC.\r
 414          * @stable ICU 3.0\r
 415          */\r
 416         public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC = (byte)RIGHT_TO_LEFT_ARABIC;\r
 417 \r
 418         /**\r
 419          * Directional type RLE\r
 420          * @stable ICU 2.1\r
 421          */\r
 422         public static final int RIGHT_TO_LEFT_EMBEDDING    = 14;\r
 423 \r
 424         /**\r
 425          * JDK-compatible synonym for RIGHT_TO_LEFT_EMBEDDING.\r
 426          * @stable ICU 3.0\r
 427          */\r
 428         public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING = (byte)RIGHT_TO_LEFT_EMBEDDING;\r
 429 \r
 430         /**\r
 431          * Directional type RLO\r
 432          * @stable ICU 2.1\r
 433          */\r
 434         public static final int RIGHT_TO_LEFT_OVERRIDE     = 15;\r
 435 \r
 436         /**\r
 437          * JDK-compatible synonym for RIGHT_TO_LEFT_OVERRIDE.\r
 438          * @stable ICU 3.0\r
 439          */\r
 440         public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE = (byte)RIGHT_TO_LEFT_OVERRIDE;\r
 441 \r
 442         /**\r
 443          * Directional type PDF\r
 444          * @stable ICU 2.1\r
 445          */\r
 446         public static final int POP_DIRECTIONAL_FORMAT     = 16;\r
 447 \r
 448         /**\r
 449          * JDK-compatible synonym for POP_DIRECTIONAL_FORMAT.\r
 450          * @stable ICU 3.0\r
 451          */\r
 452         public static final byte DIRECTIONALITY_POP_DIRECTIONAL_FORMAT = (byte)POP_DIRECTIONAL_FORMAT;\r
 453 \r
 454         /**\r
 455          * Directional type NSM\r
 456          * @stable ICU 2.1\r
 457          */\r
 458         public static final int DIR_NON_SPACING_MARK       = 17;\r
 459 \r
 460         /**\r
 461          * JDK-compatible synonym for DIR_NON_SPACING_MARK.\r
 462          * @stable ICU 3.0\r
 463          */\r
 464         public static final byte DIRECTIONALITY_NONSPACING_MARK = (byte)DIR_NON_SPACING_MARK;\r
 465 \r
 466         /**\r
 467          * Directional type BN\r
 468          * @stable ICU 2.1\r
 469          */\r
 470         public static final int BOUNDARY_NEUTRAL           = 18;\r
 471 \r
 472         /**\r
 473          * JDK-compatible synonym for BOUNDARY_NEUTRAL.\r
 474          * @stable ICU 3.0\r
 475          */\r
 476         public static final byte DIRECTIONALITY_BOUNDARY_NEUTRAL = (byte)BOUNDARY_NEUTRAL;\r
 477 \r
 478         /**\r
 479          * Number of directional types\r
 480          * @stable ICU 2.1\r
 481          */\r
 482         public static final int CHAR_DIRECTION_COUNT       = 19;\r
 483 \r
 484         /**\r
 485          * Undefined bidirectional character type. Undefined <code>char</code>\r
 486          * values have undefined directionality in the Unicode specification.\r
 487          * @stable ICU 3.0\r
 488          */\r
 489         public static final byte DIRECTIONALITY_UNDEFINED = -1;\r
 490     }\r
 491 }\r