UCharacterProperty (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

java.lang.Object
- com.adobe.agl.impl.UCharacterProperty

```
public final class UCharacterProperty
extends Object
```
Internal class used for Unicode character property database.

This classes store binary data read from uprops.icu. It does not have the capability to parse the data into more high-level information. It only returns bytes of information when required.

Due to the form most commonly used for retrieval, array of char is used to store the binary data.

UCharacterPropertyDB also contains information on accessing indexes to significant points in the binary data.

Responsibility for molding the binary data into more meaning form lies on UCharacter.

Since:

release 2.1, february 1st 2002

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE_` Latin capital letter i with dot above
`static char`	`LATIN_SMALL_LETTER_DOTLESS_I_` Latin small letter i with dot above
`static char`	`LATIN_SMALL_LETTER_I_` Latin lowercase i
`CharTrie`	`m_trie_` Trie data
`char[]`	`m_trieData_` Optimization CharTrie data array
`char[]`	`m_trieIndex_` Optimization CharTrie index array
`int`	`m_trieInitialValue_` Optimization CharTrie data offset
`VersionInfo`	`m_unicodeVersion_` Unicode version
`static int`	`NT_COUNT`
`static int`	`NT_FRACTION`
`static int`	`NT_LARGE`
`static int`	`SRC_BIDI` From ubidi_props.c/ubidi.icu
`static int`	`SRC_CASE` From ucase.c/ucase.icu
`static int`	`SRC_CHAR` From uchar.c/uprops.icu main trie
`static int`	`SRC_CHAR_AND_PROPSVEC` From uchar.c/uprops.icu main trie as well as properties vectors trie
`static int`	`SRC_COUNT` One more than the highest UPropertySource (SRC_) constant.
`static int`	`SRC_HST` Hangul_Syllable_Type, from uchar.c/uprops.icu
`static int`	`SRC_NAMES` From unames.c/unames.icu
`static int`	`SRC_NONE` No source, not a supported property.
`static int`	`SRC_NORM` From unorm.cpp/unorm.icu
`static int`	`SRC_PROPSVEC` From uchar.c/uprops.icu properties vectors trie
`static int`	`TYPE_MASK` Character type mask

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAdditional(int codepoint, int column)` Gets the unicode additional properties.
`VersionInfo`	`getAge(int codepoint)` Get the "age" of the code point.
`static UCharacterProperty`	`getInstance()` Loads the property data and initialize the UCharacterProperty instance.
`static int`	`getMask(int type)` Gets the type mask
`int`	`getMaxValues(int column)` Get the the maximum values for some enum/int properties.
`int`	`getProperty(int ch)` Gets the property value at the index.
`static int`	`getRawSupplementary(char lead, char trail)` Forms a supplementary code point from the argument character Note this is for internal use hence no checks for the validity of the surrogate characters are done
`int`	`getSource(int which)`
`static int`	`getUnsignedValue(int prop)` Getting the unsigned numeric value of a character embedded in the property argument
`static boolean`	`isRuleWhiteSpace(int c)` Checks if the argument c is to be treated as a white space in ICU rules.
`void`	`setIndexData(CharTrie.FriendAgent friendagent)` Java friends implementation

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_trie_
```
public CharTrie m_trie_
```
    Trie data
  - m_trieIndex_
```
public char[] m_trieIndex_
```
    Optimization CharTrie index array
  - m_trieData_
```
public char[] m_trieData_
```
    Optimization CharTrie data array
  - m_trieInitialValue_
```
public int m_trieInitialValue_
```
    Optimization CharTrie data offset
  - m_unicodeVersion_
```
public VersionInfo m_unicodeVersion_
```
    Unicode version
  - LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE_
```
public static final char LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE_
```
    Latin capital letter i with dot above
    
    See Also:
    
    Constant Field Values
  - LATIN_SMALL_LETTER_DOTLESS_I_
```
public static final char LATIN_SMALL_LETTER_DOTLESS_I_
```
    Latin small letter i with dot above
    
    See Also:
    
    Constant Field Values
  - LATIN_SMALL_LETTER_I_
```
public static final char LATIN_SMALL_LETTER_I_
```
    Latin lowercase i
    
    See Also:
    
    Constant Field Values
  - TYPE_MASK
```
public static final int TYPE_MASK
```
    Character type mask
    
    See Also:
    
    Constant Field Values
  - SRC_NONE
```
public static final int SRC_NONE
```
    No source, not a supported property.
    
    See Also:
    
    Constant Field Values
  - SRC_CHAR
```
public static final int SRC_CHAR
```
    From uchar.c/uprops.icu main trie
    
    See Also:
    
    Constant Field Values
  - SRC_PROPSVEC
```
public static final int SRC_PROPSVEC
```
    From uchar.c/uprops.icu properties vectors trie
    
    See Also:
    
    Constant Field Values
  - SRC_HST
```
public static final int SRC_HST
```
    Hangul_Syllable_Type, from uchar.c/uprops.icu
    
    See Also:
    
    Constant Field Values
  - SRC_NAMES
```
public static final int SRC_NAMES
```
    From unames.c/unames.icu
    
    See Also:
    
    Constant Field Values
  - SRC_NORM
```
public static final int SRC_NORM
```
    From unorm.cpp/unorm.icu
    
    See Also:
    
    Constant Field Values
  - SRC_CASE
```
public static final int SRC_CASE
```
    From ucase.c/ucase.icu
    
    See Also:
    
    Constant Field Values
  - SRC_BIDI
```
public static final int SRC_BIDI
```
    From ubidi_props.c/ubidi.icu
    
    See Also:
    
    Constant Field Values
  - SRC_CHAR_AND_PROPSVEC
```
public static final int SRC_CHAR_AND_PROPSVEC
```
    From uchar.c/uprops.icu main trie as well as properties vectors trie
    
    See Also:
    
    Constant Field Values
  - SRC_COUNT
```
public static final int SRC_COUNT
```
    One more than the highest UPropertySource (SRC_) constant.
    
    See Also:
    
    Constant Field Values
  - NT_FRACTION
```
public static final int NT_FRACTION
```
    See Also:
    
    Constant Field Values
  - NT_LARGE
```
public static final int NT_LARGE
```
    See Also:
    
    Constant Field Values
  - NT_COUNT
```
public static final int NT_COUNT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setIndexData
```
public void setIndexData(CharTrie.FriendAgent friendagent)
```
    Java friends implementation
  - getProperty
```
public final int getProperty(int ch)
```
    Gets the property value at the index. This is optimized. Note this is alittle different from CharTrie the index m_trieData_ is never negative.
    
    Parameters:
    
    ch - code point whose property value is to be retrieved
    
    Returns:
    
    property value of code point
  - getUnsignedValue
```
public static int getUnsignedValue(int prop)
```
    Getting the unsigned numeric value of a character embedded in the property argument
    
    Parameters:
    
    prop - the character
    
    Returns:
    
    unsigned numberic value
  - getAdditional
```
public int getAdditional(int codepoint,
                         int column)
```
    Gets the unicode additional properties. C version getUnicodeProperties.
    
    Parameters:
    
    codepoint - codepoint whose additional properties is to be retrieved
    
    column -
    
    Returns:
    
    unicode properties
  - getAge
```
public VersionInfo getAge(int codepoint)
```
    Get the "age" of the code point.
    
    The "age" is the Unicode version when the code point was first designated (as a non-character or for Private Use) or assigned a character.
    
    This can be useful to avoid emitting code points to receiving processes that do not accept newer characters.
    
    The data is from the UCD file DerivedAge.txt.
    
    This API does not check the validity of the codepoint.
    
    Parameters:
    
    codepoint - The code point.
    
    Returns:
    
    the Unicode version number
  - getSource
```
public final int getSource(int which)
```
  - getRawSupplementary
```
public static int getRawSupplementary(char lead,
                                      char trail)
```
    Forms a supplementary code point from the argument character
    Note this is for internal use hence no checks for the validity of the surrogate characters are done
    
    Parameters:
    
    lead - lead surrogate character
    
    trail - trailing surrogate character
    
    Returns:
    
    code point of the supplementary character
  - getInstance
```
public static UCharacterProperty getInstance()
```
    Loads the property data and initialize the UCharacterProperty instance.
    
    Throws:
    
    MissingResourceException - when data is missing or data has been corrupted
  - isRuleWhiteSpace
```
public static boolean isRuleWhiteSpace(int c)
```
    Checks if the argument c is to be treated as a white space in ICU rules. Usually ICU rule white spaces are ignored unless quoted. Equivalent to test for Pattern_White_Space Unicode property. Stable set of characters, won't change. See UAX #31 Identifier and Pattern Syntax: http://www.unicode.org/reports/tr31/
    
    Parameters:
    
    c - codepoint to check
    
    Returns:
    
    true if c is a ICU white space
  - getMaxValues
```
public int getMaxValues(int column)
```
    Get the the maximum values for some enum/int properties.
    
    Returns:
    
    maximum values for the integer properties.
  - getMask
```
public static final int getMask(int type)
```
    Gets the type mask
    
    Parameters:
    
    type - character type
    
    Returns:
    
    mask

Class UCharacterProperty

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_trie_

m_trieIndex_

m_trieData_

m_trieInitialValue_

m_unicodeVersion_

LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE_

LATIN_SMALL_LETTER_DOTLESS_I_

LATIN_SMALL_LETTER_I_

TYPE_MASK

SRC_NONE

SRC_CHAR

SRC_PROPSVEC

SRC_HST

SRC_NAMES

SRC_NORM

SRC_CASE

SRC_BIDI

SRC_CHAR_AND_PROPSVEC

SRC_COUNT

NT_FRACTION

NT_LARGE

NT_COUNT

Method Detail

setIndexData

getProperty

getUnsignedValue

getAdditional

getAge

getSource

getRawSupplementary

getInstance

isRuleWhiteSpace

getMaxValues

getMask