public class RuleBasedNumberFormat extends NumberFormat
A class that formats numbers according to a set of rules. This number formatter is typically used for spelling out numeric values in words (e.g., 25,3476 as "twenty-five thousand three hundred seventy-six" or "vingt-cinq mille trois cents soixante-seize" or "funfundzwanzigtausenddreihundertsechsundsiebzig"), but can also be used for other complicated formatting tasks, such as formatting a number of seconds as hours, minutes and seconds (e.g., 3,730 as "1:02:10").
The resources contain three predefined formatters for each locale: spellout, which spells out a value in words (123 is "one hundred twenty-three"); ordinal, which appends an ordinal suffix to the end of a numeral (123 is "123rd"); and duration, which shows a duration in seconds as hours, minutes, and seconds (123 is "2:03"). The client can also define more specialized RuleBasedNumberFormats by supplying programmer-defined rule sets.
The behavior of a RuleBasedNumberFormat is specified by a textual description that is either passed to the constructor as a String or loaded from a resource bundle. In its simplest form, the description consists of a semicolon-delimited list of rules. Each rule has a string of output text and a value or range of values it is applicable to. In a typical spellout rule set, the first twenty rules are the words for the numbers from 0 to 19:
zero; one; two; three; four; five; six; seven; eight; nine; ten; eleven; twelve; thirteen; fourteen; fifteen; sixteen; seventeen; eighteen; nineteen;
For larger numbers, we can use the preceding set of rules to format the ones place, and we only have to supply the words for the multiples of 10:
20: twenty[->>];
30: thirty{->>];
40: forty[->>];
50: fifty[->>];
60: sixty[->>];
70: seventy[->>];
80: eighty[->>];
90: ninety[->>];
In these rules, the base value is spelled out explicitly and set off from the rule's output text with a colon. The rules are in a sorted list, and a rule is applicable to all numbers from its own base value to one less than the next rule's base value. The ">>" token is called a substitution and tells the formatter to isolate the number's ones digit, format it using this same set of rules, and place the result at the position of the ">>" token. Text in brackets is omitted if the number being formatted is an even multiple of 10 (the hyphen is a literal hyphen; 24 is "twenty-four," not "twenty four").
For even larger numbers, we can actually look up several parts of the number in the list:
100: << hundred[ >>];
The "<<" represents a new kind of substitution. The << isolates the hundreds digit (and any digits to its left), formats it using this same rule set, and places the result where the "<<" was. Notice also that the meaning of >> has changed: it now refers to both the tens and the ones digits. The meaning of both substitutions depends on the rule's base value. The base value determines the rule's divisor, which is the highest power of 10 that is less than or equal to the base value (the user can change this). To fill in the substitutions, the formatter divides the number being formatted by the divisor. The integral quotient is used to fill in the << substitution, and the remainder is used to fill in the >> substitution. The meaning of the brackets changes similarly: text in brackets is omitted if the value being formatted is an even multiple of the rule's divisor. The rules are applied recursively, so if a substitution is filled in with text that includes another substitution, that substitution is also filled in.
This rule covers values up to 999, at which point we add another rule:
1000: << thousand[ >>];
Again, the meanings of the brackets and substitution tokens shift because the rule's base value is a higher power of 10, changing the rule's divisor. This rule can actually be used all the way up to 999,999. This allows us to finish out the rules as follows:
1,000,000: << million[ >>]; 1,000,000,000: << billion[ >>]; 1,000,000,000,000: << trillion[ >>]; 1,000,000,000,000,000: OUT OF RANGE!;
Commas, periods, and spaces can be used in the base values to improve legibility and are ignored by the rule parser. The last rule in the list is customarily treated as an "overflow rule," applying to everything from its base value on up, and often (as in this example) being used to print out an error message or default representation. Notice also that the size of the major groupings in large numbers is controlled by the spacing of the rules: because in English we group numbers by thousand, the higher rules are separated from each other by a factor of 1,000.
To see how these rules actually work in practice, consider the following example: Formatting 25,430 with this rule set would work like this:
| << thousand >> | [the rule whose base value is 1,000 is applicable to 25,340] | |
| twenty->> thousand >> | [25,340 over 1,000 is 25. The rule for 20 applies.] | |
| twenty-five thousand >> | [25 mod 10 is 5. The rule for 5 is "five." | |
| twenty-five thousand << hundred >> | [25,340 mod 1,000 is 340. The rule for 100 applies.] | |
| twenty-five thousand three hundred >> | [340 over 100 is 3. The rule for 3 is "three."] | |
| twenty-five thousand three hundred forty | [340 mod 100 is 40. The rule for 40 applies. Since 40 divides evenly by 10, the hyphen and substitution in the brackets are omitted.] |
The above syntax suffices only to format positive integers. To format negative numbers, we add a special rule:
-x: minus >>;
This is called a negative-number rule, and is identified by "-x" where the base value would be. This rule is used to format all negative numbers. the >> token here means "find the number's absolute value, format it with these rules, and put the result here."
We also add a special rule called a fraction rule for numbers with fractional parts:
x.x: << point >>;
This rule is used for all positive non-integers (negative non-integers pass through the negative-number rule first and then through this rule). Here, the << token refers to the number's integral part, and the >> to the number's fractional part. The fractional part is formatted as a series of single-digit numbers (e.g., 123.456 would be formatted as "one hundred twenty-three point four five six").
To see how this rule syntax is applied to various languages, examine the resource data.
There is actually much more flexibility built into the rule language than the description above shows. A formatter may own multiple rule sets, which can be selected by the caller, and which can use each other to fill in their substitutions. Substitutions can also be filled in with digits, using a DecimalFormat object. There is syntax that can be used to alter a rule's divisor in various ways. And there is provision for much more flexible fraction handling. A complete description of the rule syntax follows:
The description of a RuleBasedNumberFormat's behavior consists of one or more rule sets. Each rule set consists of a name, a colon, and a list of rules. A rule set name must begin with a % sign. Rule sets with names that begin with a single % sign are public: the caller can specify that they be used to format and parse numbers. Rule sets with names that begin with %% are private: they exist only for the use of other rule sets. If a formatter only has one rule set, the name may be omitted.
The user can also specify a special "rule set" named %%lenient-parse. The body of %%lenient-parse isn't a set of number-formatting rules, but a RuleBasedCollator description which is used to define equivalences for lenient parsing. For more information on the syntax, see RuleBasedCollator. For more information on lenient parsing, see setLenientParse(). Note: symbols that have syntactic meaning in collation rules, such as '&', have no particular meaning when appearing outside of the lenient-parse rule set.
The body of a rule set consists of an ordered, semicolon-delimited list of rules. Internally, every rule has a base value, a divisor, rule text, and zero, one, or two substitutions. These parameters are controlled by the description syntax, which consists of a rule descriptor, a colon, and a rule body.
A rule descriptor can take one of the following forms (text in italics is the name of a token):
| bv: | bv specifies the rule's base value. bv is a decimal number expressed using ASCII digits. bv may contain spaces, period, and commas, which are ignored. The rule's divisor is the highest power of 10 less than or equal to the base value. | |
| bv/rad: | bv specifies the rule's base value. The rule's divisor is the highest power of rad less than or equal to the base value. | |
| bv>: | bv specifies the rule's base value. To calculate the divisor, let the radix be 10, and the exponent be the highest exponent of the radix that yields a result less than or equal to the base value. Every > character after the base value decreases the exponent by 1. If the exponent is positive or 0, the divisor is the radix raised to the power of the exponent; otherwise, the divisor is 1. | |
| bv/rad>: | bv specifies the rule's base value. To calculate the divisor, let the radix be rad, and the exponent be the highest exponent of the radix that yields a result less than or equal to the base value. Every > character after the radix decreases the exponent by 1. If the exponent is positive or 0, the divisor is the radix raised to the power of the exponent; otherwise, the divisor is 1. | |
| -x: | The rule is a negative-number rule. | |
| x.x: | The rule is an improper fraction rule. If the full stop in the middle of the rule name is replaced with the decimal point that is used in the language or DecimalFormatSymbols, then that rule will have precedence when formatting and parsing this rule. For example, some languages use the comma, and can thus be written as x,x instead. For example, you can use "x.x: << point >>;x,x: << comma >>;" to handle the decimal point that matches the language's natural spelling of the punctuation of either the full stop or comma. | |
| 0.x: | The rule is a proper fraction rule. If the full stop in the middle of the rule name is replaced with the decimal point that is used in the language or DecimalFormatSymbols, then that rule will have precedence when formatting and parsing this rule. For example, some languages use the comma, and can thus be written as 0,x instead. For example, you can use "0.x: point >>;0,x: comma >>;" to handle the decimal point that matches the language's natural spelling of the punctuation of either the full stop or comma | |
| x.0: | The rule is a default rule. If the full stop in the middle of the rule name is replaced with the decimal point that is used in the language or DecimalFormatSymbols, then that rule will have precedence when formatting and parsing this rule. For example, some languages use the comma, and can thus be written as x,0 instead. For example, you can use "x.0: << point;x,0: << comma;" to handle the decimal point that matches the language's natural spelling of the punctuation of either the full stop or comma | |
| Inf: | The rule for infinity. | |
| NaN: | The rule for an IEEE 754 NaN (not a number). | |
| nothing | If the rule's rule descriptor is left out, the base value is one plus the preceding rule's base value (or zero if this is the first rule in the list) in a normal rule set. In a fraction rule set, the base value is the same as the preceding rule's base value. |
A rule set may be either a regular rule set or a fraction rule set, depending on whether it is used to format a number's integral part (or the whole number) or a number's fractional part. Using a rule set to format a rule's fractional part makes it a fraction rule set.
Which rule is used to format a number is defined according to one of the following algorithms: If the rule set is a regular rule set, do the following:
If the rule set is a fraction rule set, do the following:
A rule's body consists of a string of characters terminated by a semicolon. The rule may include zero, one, or two substitution tokens, and a range of text in brackets. The brackets denote optional text (and may also include one or both substitutions). The exact meanings of the substitution tokens, and under what conditions optional text is omitted, depend on the syntax of the substitution token and the context. The rest of the text in a rule body is literal text that is output when the rule matches the number being formatted.
A substitution token begins and ends with a token character. The token character and the context together specify a mathematical operation to be performed on the number being formatted. An optional substitution descriptor specifies how the value resulting from that operation is used to fill in the substitution. The position of the substitution token in the rule body specifies the location of the resultant text in the original rule text.
The meanings of the substitution token characters are as follows:
| >> | in normal rule | Divide the number by the rule's divisor and format the remainder | |
| in negative-number rule | Find the absolute value of the number and format the result | ||
| in fraction or default rule | Isolate the number's fractional part and format it. | ||
| in rule in fraction rule set | Not allowed. | ||
| >>> | in normal rule | Divide the number by the rule's divisor and format the remainder, but bypass the normal rule-selection process and just use the rule that precedes this one in this rule list. | |
| in all other rules | Not allowed. | ||
| << | in normal rule | Divide the number by the rule's divisor and format the quotient | |
| in negative-number rule | Not allowed. | ||
| in fraction or default rule | Isolate the number's integral part and format it. | ||
| in rule in fraction rule set | Multiply the number by the rule's base value and format the result. | ||
| == | in all rule sets | Format the number unchanged | |
| [] | in normal rule | Omit the optional text if the number is an even multiple of the rule's divisor | |
| in negative-number rule | Not allowed. | ||
| in improper-fraction rule | Omit the optional text if the number is between 0 and 1 (same as specifying both an x.x rule and a 0.x rule) | ||
| in default rule | Omit the optional text if the number is an integer (same as specifying both an x.x rule and an x.0 rule) | ||
| in proper-fraction rule | Not allowed. | ||
| in rule in fraction rule set | Omit the optional text if multiplying the number by the rule's base value yields 1. | ||
| $(cardinal,plural syntax)$ | in all rule sets | This provides the ability to choose a word based on the number divided by the radix to the power of the exponent of the base value for the specified locale, which is normally equivalent to the << value. This uses the cardinal plural rules from PluralFormat. All strings used in the plural format are treated as the same base value for parsing. | |
| $(ordinal,plural syntax)$ | in all rule sets | This provides the ability to choose a word based on the number divided by the radix to the power of the exponent of the base value for the specified locale, which is normally equivalent to the << value. This uses the ordinal plural rules from PluralFormat. All strings used in the plural format are treated as the same base value for parsing. |
The substitution descriptor (i.e., the text between the token characters) may take one of three forms:
| a rule set name | Perform the mathematical operation on the number, and format the result using the named rule set. | |
| a DecimalFormat pattern | Perform the mathematical operation on the number, and format the result using a DecimalFormat with the specified pattern. The pattern must begin with 0 or #. | |
| nothing | Perform the mathematical operation on the number, and format the result using the rule
set containing the current rule, except:
|
Whitespace is ignored between a rule set name and a rule set body, between a rule descriptor and a rule body, or between rules. If a rule body begins with an apostrophe, the apostrophe is ignored, but all text after it becomes significant (this is how you can have a rule's rule text begin with whitespace). There is no escape function: the semicolon is not allowed in rule set names or in rule text, and the colon is not allowed in rule set names. The characters beginning a substitution token are always treated as the beginning of a substitution token.
See the resource data and the demo program for annotated examples of real rule sets using these features.
NumberFormat,
DecimalFormat,
PluralFormat,
PluralRules,
Serialized FormNumberFormat.Field, NumberFormat.NumberFormatFactory, NumberFormat.SimpleNumberFormatFactoryUFormat.SpanField| Modifier and Type | Field and Description |
|---|---|
static int |
NUMBERING_SYSTEM
Selector code that tells the constructor to create a numbering system formatter
|
static int |
ORDINAL
Selector code that tells the constructor to create an ordinal formatter
|
static int |
SPELLOUT
Selector code that tells the constructor to create a spellout formatter
|
ACCOUNTINGCURRENCYSTYLE, CASHCURRENCYSTYLE, CURRENCYSTYLE, FRACTION_FIELD, INTEGER_FIELD, INTEGERSTYLE, ISOCURRENCYSTYLE, NUMBERSTYLE, PERCENTSTYLE, PLURALCURRENCYSTYLE, SCIENTIFICSTYLE, STANDARDCURRENCYSTYLE| Constructor and Description |
|---|
RuleBasedNumberFormat(int format)
Creates a RuleBasedNumberFormat from a predefined description.
|
RuleBasedNumberFormat(Locale locale,
int format)
Creates a RuleBasedNumberFormat from a predefined description.
|
RuleBasedNumberFormat(String description)
Creates a RuleBasedNumberFormat that behaves according to the description
passed in.
|
RuleBasedNumberFormat(String description,
Locale locale)
Creates a RuleBasedNumberFormat that behaves according to the description
passed in.
|
RuleBasedNumberFormat(String description,
String[][] localizations)
Creates a RuleBasedNumberFormat that behaves according to the description
passed in.
|
RuleBasedNumberFormat(String description,
String[][] localizations,
ULocale locale)
Creates a RuleBasedNumberFormat that behaves according to the description
passed in.
|
RuleBasedNumberFormat(String description,
ULocale locale)
Creates a RuleBasedNumberFormat that behaves according to the description
passed in.
|
RuleBasedNumberFormat(ULocale locale,
int format)
Creates a RuleBasedNumberFormat from a predefined description.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Duplicates this formatter.
|
boolean |
equals(Object that)
Tests two RuleBasedNumberFormats for equality.
|
StringBuffer |
format(BigDecimal number,
StringBuffer toAppendTo,
FieldPosition pos)
NEW
Implement org.graalvm.shadowed.com.ibm.icu.text.NumberFormat:
Format a BigDecimal.
|
StringBuffer |
format(BigDecimal number,
StringBuffer toAppendTo,
FieldPosition pos)
NEW
Implement org.graalvm.shadowed.com.ibm.icu.text.NumberFormat:
Format a BigDecimal.
|
StringBuffer |
format(BigInteger number,
StringBuffer toAppendTo,
FieldPosition pos)
NEW
Implement org.graalvm.shadowed.com.ibm.icu.text.NumberFormat:
Format a BigInteger.
|
String |
format(double number,
String ruleSet)
Formats the specified number according to the specified rule set.
|
StringBuffer |
format(double number,
StringBuffer toAppendTo,
FieldPosition ignore)
Formats the specified number using the formatter's default rule set.
|
String |
format(long number,
String ruleSet)
Formats the specified number according to the specified rule set.
|
StringBuffer |
format(long number,
StringBuffer toAppendTo,
FieldPosition ignore)
Formats the specified number using the formatter's default rule set.
|
String |
getDefaultRuleSetName()
Return the name of the current default rule set.
|
RbnfLenientScannerProvider |
getLenientScannerProvider()
Returns the lenient scanner provider.
|
int |
getRoundingMode()
Returns the rounding mode.
|
String |
getRuleSetDisplayName(String ruleSetName)
Return the rule set display name for the provided rule set in the current default
DISPLAY locale. |
String |
getRuleSetDisplayName(String ruleSetName,
ULocale loc)
Return the rule set display name for the provided rule set and locale.
|
ULocale[] |
getRuleSetDisplayNameLocales()
Return a list of locales for which there are locale-specific display names
for the rule sets in this formatter.
|
String[] |
getRuleSetDisplayNames()
Return the rule set display names for the current default
DISPLAY locale. |
String[] |
getRuleSetDisplayNames(ULocale loc)
Return the rule set display names for the provided locale.
|
String[] |
getRuleSetNames()
Returns a list of the names of all of this formatter's public rule sets.
|
int |
hashCode() |
boolean |
lenientParseEnabled()
Returns true if lenient-parse mode is turned on.
|
Number |
parse(String text,
ParsePosition parsePosition)
Parses the specified string, beginning at the specified position, according
to this formatter's rules.
|
void |
setContext(DisplayContext context)
Set a particular DisplayContext value in the formatter,
such as CAPITALIZATION_FOR_STANDALONE.
|
void |
setDecimalFormatSymbols(DecimalFormatSymbols newSymbols)
Sets the decimal format symbols used by this formatter.
|
void |
setDefaultRuleSet(String ruleSetName)
Override the default rule set to use.
|
void |
setLenientParseMode(boolean enabled)
Turns lenient parse mode on and off.
|
void |
setLenientScannerProvider(RbnfLenientScannerProvider scannerProvider)
Sets the provider for the lenient scanner.
|
void |
setRoundingMode(int roundingMode)
Sets the rounding mode.
|
String |
toString()
Generates a textual description of this formatter.
|
format, format, format, format, format, format, format, format, getAvailableLocales, getAvailableULocales, getContext, getCurrency, getCurrencyInstance, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getNumberInstance, getPattern, getPercentInstance, getPercentInstance, getPercentInstance, getScientificInstance, getScientificInstance, getScientificInstance, isGroupingUsed, isParseIntegerOnly, isParseStrict, parse, parseCurrency, parseObject, registerFactory, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setParseStrict, unregisterformat, formatToCharacterIterator, parseObjectpublic static final int SPELLOUT
public static final int ORDINAL
public static final int NUMBERING_SYSTEM
public RuleBasedNumberFormat(String description)
FORMAT locale.description - A description of the formatter's desired behavior.
See the class documentation for a complete explanation of the description
syntax.ULocale.Category.FORMATpublic RuleBasedNumberFormat(String description, String[][] localizations)
FORMAT locale.
The localizations data provides information about the public rule sets and their localized display names for different locales. The first element in the list is an array of the names of the public rule sets. The first element in this array is the initial default ruleset. The remaining elements in the list are arrays of localizations of the names of the public rule sets. Each of these is one longer than the initial array, with the first String being the ULocale ID, and the remaining Strings being the localizations of the rule set names, in the same order as the initial array.
description - A description of the formatter's desired behavior.
See the class documentation for a complete explanation of the description
syntax.localizations - a list of localizations for the rule set
names in the description.ULocale.Category.FORMATpublic RuleBasedNumberFormat(String description, Locale locale)
description - A description of the formatter's desired behavior.
See the class documentation for a complete explanation of the description
syntax.locale - A locale, which governs which characters are used for
formatting values in numerals, and which characters are equivalent in
lenient parsing.public RuleBasedNumberFormat(String description, ULocale locale)
description - A description of the formatter's desired behavior.
See the class documentation for a complete explanation of the description
syntax.locale - A locale, which governs which characters are used for
formatting values in numerals, and which characters are equivalent in
lenient parsing.public RuleBasedNumberFormat(String description, String[][] localizations, ULocale locale)
The localizations data provides information about the public rule sets and their localized display names for different locales. The first element in the list is an array of the names of the public rule sets. The first element in this array is the initial default ruleset. The remaining elements in the list are arrays of localizations of the names of the public rule sets. Each of these is one longer than the initial array, with the first String being the ULocale ID, and the remaining Strings being the localizations of the rule set names, in the same order as the initial array.
description - A description of the formatter's desired behavior.
See the class documentation for a complete explanation of the description
syntax.localizations - a list of localizations for the rule set names in the description.locale - A ULocale that governs which characters are used for
formatting values in numerals, and determines which characters are equivalent in
lenient parsing.public RuleBasedNumberFormat(Locale locale, int format)
locale - The locale for the formatter.format - A selector code specifying which kind of formatter to create for that
locale. There are three legal values: SPELLOUT, which creates a formatter that
spells out a value in words in the desired language, ORDINAL, which attaches
an ordinal suffix from the desired language to the end of a number (e.g. "123rd"),
and DURATION, which formats a duration in seconds as hours, minutes, and seconds.public RuleBasedNumberFormat(ULocale locale, int format)
locale - The locale for the formatter.format - A selector code specifying which kind of formatter to create for that
locale. There are four legal values: SPELLOUT, which creates a formatter that
spells out a value in words in the desired language, ORDINAL, which attaches
an ordinal suffix from the desired language to the end of a number (e.g. "123rd"),
DURATION, which formats a duration in seconds as hours, minutes, and seconds, and
NUMBERING_SYSTEM, which is used to invoke rules for alternate numbering
systems such as the Hebrew numbering system, or for Roman numerals, etc..public RuleBasedNumberFormat(int format)
FORMAT locale.format - A selector code specifying which kind of formatter to create.
There are three legal values: SPELLOUT, which creates a formatter that spells
out a value in words in the default locale's language, ORDINAL, which attaches
an ordinal suffix from the default locale's language to a numeral, and
DURATION, which formats a duration in seconds as hours, minutes, and seconds always rounding down.
or NUMBERING_SYSTEM, which is used for alternate numbering systems such as Hebrew.ULocale.Category.FORMATpublic Object clone()
clone in class NumberFormatpublic boolean equals(Object that)
equals in class NumberFormatthat - The formatter to compare against this one.public int hashCode()
hashCode in class NumberFormatpublic String toString()
public String[] getRuleSetNames()
public ULocale[] getRuleSetDisplayNameLocales()
public String[] getRuleSetDisplayNames(ULocale loc)
RuleBasedNumberFormat.getRuleSetNames()public String[] getRuleSetDisplayNames()
DISPLAY locale.RuleBasedNumberFormat.getRuleSetDisplayNames(ULocale),
ULocale.Category.DISPLAYpublic String getRuleSetDisplayName(String ruleSetName, ULocale loc)
IllegalArgumentException - if ruleSetName is not a valid rule set name for this formatRuleBasedNumberFormat.getRuleSetDisplayNames(org.graalvm.shadowed.com.ibm.icu.util.ULocale)public String getRuleSetDisplayName(String ruleSetName)
DISPLAY locale.RuleBasedNumberFormat.getRuleSetDisplayName(String,ULocale),
ULocale.Category.DISPLAYpublic String format(double number, String ruleSet) throws IllegalArgumentException
number - The number to format.ruleSet - The name of the rule set to format the number with.
This must be the name of a valid public rule set for this formatter.IllegalArgumentExceptionpublic String format(long number, String ruleSet) throws IllegalArgumentException
number - The number to format.ruleSet - The name of the rule set to format the number with.
This must be the name of a valid public rule set for this formatter.IllegalArgumentExceptionpublic StringBuffer format(double number, StringBuffer toAppendTo, FieldPosition ignore)
format in class NumberFormatnumber - The number to format.toAppendTo - A StringBuffer that the result should be appended to.ignore - This function doesn't examine or update the field position.Format.format(Object, StringBuffer, FieldPosition)public StringBuffer format(long number, StringBuffer toAppendTo, FieldPosition ignore)
format in class NumberFormatnumber - The number to format.toAppendTo - A StringBuffer that the result should be appended to.ignore - This function doesn't examine or update the field position.Format.format(Object, StringBuffer, FieldPosition)public StringBuffer format(BigInteger number, StringBuffer toAppendTo, FieldPosition pos)
format in class NumberFormatFormat.format(Object, StringBuffer, FieldPosition)public StringBuffer format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)
format in class NumberFormatFormat.format(Object, StringBuffer, FieldPosition)public StringBuffer format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)
format in class NumberFormatFormat.format(Object, StringBuffer, FieldPosition)public Number parse(String text, ParsePosition parsePosition)
parse in class NumberFormattext - The string to parseparsePosition - On entry, contains the position of the first character
in "text" to examine. On exit, has been updated to contain the position
of the first character in "text" that wasn't consumed by the parse.RuleBasedNumberFormat.setLenientParseMode(boolean)public void setLenientParseMode(boolean enabled)
RbnfLenientScannerProviderImpl will be set if
it is available on the classpath. Otherwise this will have no effect.enabled - If true, turns lenient-parse mode on; if false, turns it off.RbnfLenientScanner,
RbnfLenientScannerProviderpublic boolean lenientParseEnabled()
RuleBasedNumberFormat.setLenientParseMode(boolean)public void setLenientScannerProvider(RbnfLenientScannerProvider scannerProvider)
RuleBasedNumberFormat.setLenientParseMode(boolean)
has no effect. This is necessary to decouple collation from format code.scannerProvider - the providerRuleBasedNumberFormat.setLenientParseMode(boolean),
RuleBasedNumberFormat.getLenientScannerProvider()public RbnfLenientScannerProvider getLenientScannerProvider()
public void setDefaultRuleSet(String ruleSetName)
ruleSetName - the name of the rule set, or null to reset the initial default.IllegalArgumentException - if ruleSetName is not the name of a public ruleset.public String getDefaultRuleSetName()
public void setDecimalFormatSymbols(DecimalFormatSymbols newSymbols)
newSymbols - desired DecimalFormatSymbolsDecimalFormatSymbolspublic void setContext(DisplayContext context)
setContext in class NumberFormatcontext - The DisplayContext value to set.public int getRoundingMode()
getRoundingMode in class NumberFormatBigDecimal.ROUND_UP and
BigDecimal.ROUND_UNNECESSARY.RuleBasedNumberFormat.setRoundingMode(int),
BigDecimalpublic void setRoundingMode(int roundingMode)
setRoundingMode in class NumberFormatroundingMode - A rounding mode, between BigDecimal.ROUND_UP and
BigDecimal.ROUND_UNNECESSARY.IllegalArgumentException - if roundingMode is unrecognized.RuleBasedNumberFormat.getRoundingMode(),
BigDecimal