com.ibm.icu.text

Class IdentifierInfo

java.lang.Object

com.ibm.icu.text.IdentifierInfo

Deprecated.

This API is ICU internal only.

public class IdentifierInfo
extends java.lang.Object

This class analyzes a possible identifier for script and identifier status. Use it by calling setIdentifierProfile then setIdentifier. Available methods include:

1. call getScripts for the specific scripts in the identifier. The identifier contains at least one character in each of these.
2. call getAlternates to get cases where a character is not limited to a single script. For example, it could be either Katakana or Hiragana.
3. call getCommonAmongAlternates to find out if any scripts are common to all the alternates.
4. call getNumerics to get a representative character (with value zero) for each of the decimal number systems in the identifier.
5. call getRestrictionLevel to see what the UTS36 restriction level is.

Author:

markdavis

Status:

Internal. This API is ICU internal only.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.util.BitSet>	BITSET_COMPARATOR Deprecated. This API is ICU internal only.

Constructor Summary

Constructors

Constructor and Description
IdentifierInfo() Deprecated. This API is ICU internal only.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	contains(java.util.BitSet container, java.util.BitSet containee) Deprecated. This API is ICU internal only.
static java.lang.String	displayAlternates(java.util.Set<java.util.BitSet> alternates) Deprecated. This API is ICU internal only.
static java.lang.String	displayScripts(java.util.BitSet scripts) Deprecated. This API is ICU internal only.
java.util.Set<java.util.BitSet>	getAlternates() Deprecated. This API is ICU internal only.
java.util.BitSet	getCommonAmongAlternates() Deprecated. This API is ICU internal only.
java.lang.String	getIdentifier() Deprecated. This API is ICU internal only.
UnicodeSet	getIdentifierProfile() Deprecated. This API is ICU internal only.
UnicodeSet	getNumerics() Deprecated. This API is ICU internal only.
SpoofChecker.RestrictionLevel	getRestrictionLevel() Deprecated. This API is ICU internal only.
int	getScriptCount() Deprecated. This API is ICU internal only.
java.util.BitSet	getScripts() Deprecated. This API is ICU internal only.
static java.util.Set<java.util.BitSet>	parseAlternates(java.lang.String scriptsSetString) Deprecated. This API is ICU internal only.
static java.util.BitSet	parseScripts(java.lang.String scriptsString) Deprecated. This API is ICU internal only.
static java.util.BitSet	set(java.util.BitSet bitset, int... values) Deprecated. This API is ICU internal only.
IdentifierInfo	setIdentifier(java.lang.String identifier) Deprecated. This API is ICU internal only.
IdentifierInfo	setIdentifierProfile(UnicodeSet identifierProfile) Deprecated. This API is ICU internal only.
java.lang.String	toString() Deprecated. This API is ICU internal only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BITSET_COMPARATOR

public static final java.util.Comparator<java.util.BitSet> BITSET_COMPARATOR

Deprecated. This API is ICU internal only.

Order BitSets, first by shortest, then by items.

Status:

Internal. This API is ICU internal only.

Constructor Detail

IdentifierInfo

public IdentifierInfo()

Deprecated. This API is ICU internal only.

Create an identifier info object. Subsequently, call setIdentifier(String), etc. setIdentifierProfile(UnicodeSet)

Status:

Internal. This API is ICU internal only.

Method Detail

setIdentifierProfile

public IdentifierInfo setIdentifierProfile(UnicodeSet identifierProfile)

Deprecated. This API is ICU internal only.

Set the identifier profile: the characters that are to be allowed in the identifier.

Parameters:

identifierProfile - the characters that are to be allowed in the identifier

Returns:

self

Status:

Internal. This API is ICU internal only.

getIdentifierProfile

public UnicodeSet getIdentifierProfile()

Deprecated. This API is ICU internal only.

Get the identifier profile: the characters that are to be allowed in the identifier.

Returns:

The characters that are to be allowed in the identifier.

Status:

Internal. This API is ICU internal only.

setIdentifier

public IdentifierInfo setIdentifier(java.lang.String identifier)

Deprecated. This API is ICU internal only.

Set an identifier to analyze. Afterwards, call methods like getScripts()

Parameters:

identifier - the identifier to analyze

Returns:

self

Status:

Internal. This API is ICU internal only.

getIdentifier

public java.lang.String getIdentifier()

Deprecated. This API is ICU internal only.

Get the identifier that was analyzed.

Returns:

the identifier that was analyzed.

Status:

Internal. This API is ICU internal only.

getScripts

public java.util.BitSet getScripts()

Deprecated. This API is ICU internal only.

Get the scripts found in the identifiers.

Returns:

the set of explicit scripts.

Status:

Internal. This API is ICU internal only.

getAlternates

public java.util.Set<java.util.BitSet> getAlternates()

Deprecated. This API is ICU internal only.

Get the set of alternate scripts found in the identifiers. That is, when a character can be in two scripts, then the set consisting of those scripts will be returned.

Returns:

the set of explicit scripts.

Status:

Internal. This API is ICU internal only.

getNumerics

public UnicodeSet getNumerics()

Deprecated. This API is ICU internal only.

Get the representative characters (zeros) for the numerics found in the identifier.

Returns:

the set of explicit scripts.

Status:

Internal. This API is ICU internal only.

getCommonAmongAlternates

public java.util.BitSet getCommonAmongAlternates()

Deprecated. This API is ICU internal only.

Find out which scripts are in common among the alternates.

Returns:

the set of scripts that are in common among the alternates.

Status:

Internal. This API is ICU internal only.

getRestrictionLevel

public SpoofChecker.RestrictionLevel getRestrictionLevel()

Deprecated. This API is ICU internal only.

Find the "tightest" restriction level that the identifier satisfies.

Returns:

the restriction level.

Status:

Internal. This API is ICU internal only.

getScriptCount

public int getScriptCount()

Deprecated. This API is ICU internal only.

Get the number of scripts appearing in the identifier. Note: Common and Inherited scripts are omitted from the count. Note: If the identifier contains characters with alternate scripts (the character is used with more than one script), minimize the reported number of scripts by considering the character to be of a script that already appears elsewhere in the identifier when possible. The alternate script computation may not be perfect. The distinction between 0, 1 and > 1 scripts will be valid, however.

Returns:

the number of scripts.

Status:

Internal. This API is ICU internal only.

toString

public java.lang.String toString()

Deprecated. This API is ICU internal only.

See Object.toString()

Overrides:

toString in class java.lang.Object

Status:

Internal. This API is ICU internal only.

displayAlternates

public static java.lang.String displayAlternates(java.util.Set<java.util.BitSet> alternates)

Deprecated. This API is ICU internal only.

Produce a readable string of alternates.

Parameters:

alternates - a set of BitSets of script values.

Returns:

display form

Status:

Internal. This API is ICU internal only.

displayScripts

public static java.lang.String displayScripts(java.util.BitSet scripts)

Deprecated. This API is ICU internal only.

Produce a readable string of a set of scripts

Parameters:

scripts - a BitSet of UScript values

Returns:

a readable string of a set of scripts

Status:

Internal. This API is ICU internal only.

parseScripts

public static java.util.BitSet parseScripts(java.lang.String scriptsString)

Deprecated. This API is ICU internal only.

Parse a text list of scripts into a BitSet.

Parameters:

scriptsString - the string to be parsed

Returns:

BitSet of UScript values.

Status:

Internal. This API is ICU internal only.

parseAlternates

public static java.util.Set<java.util.BitSet> parseAlternates(java.lang.String scriptsSetString)

Deprecated. This API is ICU internal only.

Parse a list of alternates into a set of sets of UScript values.

Parameters:

scriptsSetString - a list of alternates, separated by ;

Returns:

a set of BitSets of UScript values

Status:

Internal. This API is ICU internal only.

contains

public static final boolean contains(java.util.BitSet container,
               java.util.BitSet containee)

Deprecated. This API is ICU internal only.

Test containment. Should be a method on BitSet.

Parameters:

container - possible container to be tested

containee - possible containee to be tested

Returns:

true if container contains containee

Status:

Internal. This API is ICU internal only.

set

public static final java.util.BitSet set(java.util.BitSet bitset,
                   int... values)

Deprecated. This API is ICU internal only.

Sets a number of values at once. Should be on BitSet.

Parameters:

bitset - bitset to be affected

values - values to be set in the bitset

Returns:

modified bitset.

Status:

Internal. This API is ICU internal only.