NumberingSystem
public
class
NumberingSystem
extends Object
java.lang.Object | |
↳ | android.icu.text.NumberingSystem |
NumberingSystem
is the base class for all number
systems. This class provides the interface for setting different numbering
system types, whether it be a simple alternate digit system such as
Thai digits or Devanagari digits, or an algorithmic numbering system such
as Hebrew numbering or Chinese numbering.
Summary
Fields | |
---|---|
public
static
final
NumberingSystem |
LATIN
For convenience, an instance representing the latn numbering system, which corresponds to digits in the ASCII range '0' through '9'. |
Public constructors | |
---|---|
NumberingSystem()
Default constructor. |
Public methods | |
---|---|
static
String[]
|
getAvailableNames()
Returns a string array containing a list of the names of numbering systems currently known to ICU. |
String
|
getDescription()
Returns the description string of the current numbering system. |
static
NumberingSystem
|
getInstance(ULocale locale)
Returns the default numbering system for the specified ULocale. |
static
NumberingSystem
|
getInstance(Locale inLocale)
Returns the default numbering system for the specified locale. |
static
NumberingSystem
|
getInstance()
Returns the default numbering system for the default |
static
NumberingSystem
|
getInstance(int radix_in, boolean isAlgorithmic_in, String desc_in)
Factory method for creating a numbering system. |
static
NumberingSystem
|
getInstanceByName(String name)
Returns a numbering system from one of the predefined numbering systems known to ICU. |
String
|
getName()
Returns the string representing the name of the numbering system. |
int
|
getRadix()
Returns the radix of the current numbering system. |
boolean
|
isAlgorithmic()
Returns the numbering system's algorithmic status. |
static
boolean
|
isValidDigitString(String str)
Convenience method to determine if a given digit string is valid for use as a descriptor of a numeric ( non-algorithmic ) numbering system. |
Inherited methods | |
---|---|
Fields
LATIN
public static final NumberingSystem LATIN
For convenience, an instance representing the latn numbering system, which corresponds to digits in the ASCII range '0' through '9'.
Public constructors
NumberingSystem
public NumberingSystem ()
Default constructor. Returns a numbering system that uses the Latin-script decimal digits 0 through 9. This should be equivalent to NumberingSystem.LATIN.
Public methods
getAvailableNames
public static String[] getAvailableNames ()
Returns a string array containing a list of the names of numbering systems currently known to ICU.
Returns | |
---|---|
String[] |
An array of strings in alphabetical (invariant) order. |
getDescription
public String getDescription ()
Returns the description string of the current numbering system. The description string describes the characteristics of the numbering system. For numeric systems, this string contains the digits used by the numbering system, in order, starting from zero. For algorithmic numbering systems, the string contains the name of the RBNF ruleset in the locale's NumberingSystemRules section that will be used to format numbers using this numbering system.
Returns | |
---|---|
String |
getInstance
public static NumberingSystem getInstance (ULocale locale)
Returns the default numbering system for the specified ULocale.
Parameters | |
---|---|
locale |
ULocale |
Returns | |
---|---|
NumberingSystem |
getInstance
public static NumberingSystem getInstance (Locale inLocale)
Returns the default numbering system for the specified locale.
Parameters | |
---|---|
inLocale |
Locale |
Returns | |
---|---|
NumberingSystem |
getInstance
public static NumberingSystem getInstance ()
Returns the default numbering system for the default FORMAT
locale.
Returns | |
---|---|
NumberingSystem |
See also:
getInstance
public static NumberingSystem getInstance (int radix_in, boolean isAlgorithmic_in, String desc_in)
Factory method for creating a numbering system.
Parameters | |
---|---|
radix_in |
int : The radix for this numbering system. ICU currently
supports only numbering systems whose radix is 10. |
isAlgorithmic_in |
boolean : Specifies whether the numbering system is algorithmic
(true) or numeric (false). |
desc_in |
String : String used to describe the characteristics of the numbering
system. For numeric systems, this string contains the digits used by the
numbering system, in order, starting from zero. For algorithmic numbering
systems, the string contains the name of the RBNF ruleset in the locale's
NumberingSystemRules section that will be used to format numbers using
this numbering system. |
Returns | |
---|---|
NumberingSystem |
getInstanceByName
public static NumberingSystem getInstanceByName (String name)
Returns a numbering system from one of the predefined numbering systems known to ICU. Numbering system names are based on the numbering systems defined in CLDR. To get a list of available numbering systems, use the getAvailableNames method.
Parameters | |
---|---|
name |
String : The name of the desired numbering system. Numbering system
names often correspond with the name of the script they are associated
with. For example, "thai" for Thai digits, "hebr" for Hebrew numerals. |
Returns | |
---|---|
NumberingSystem |
The NumberingSystem instance, or null if not available. |
getName
public String getName ()
Returns the string representing the name of the numbering system.
Returns | |
---|---|
String |
getRadix
public int getRadix ()
Returns the radix of the current numbering system.
Returns | |
---|---|
int |
isAlgorithmic
public boolean isAlgorithmic ()
Returns the numbering system's algorithmic status. If true, the numbering system is algorithmic and uses an RBNF formatter to format numerals. If false, the numbering system is numeric and uses a fixed set of digits.
Returns | |
---|---|
boolean |
isValidDigitString
public static boolean isValidDigitString (String str)
Convenience method to determine if a given digit string is valid for use as a descriptor of a numeric ( non-algorithmic ) numbering system. In order for a digit string to be valid, it must contain exactly ten Unicode code points.
Parameters | |
---|---|
str |
String |
Returns | |
---|---|
boolean |