Creates a RuleBasedNumberFormat that behaves according to the description passed in.

The formatter uses the default locale.

Parameters

rules	A description of the formatter's desired behavior. See the class documentation for a complete explanation of the description syntax.
perror	The parse error if an error was encountered.
status	The status indicating whether the constructor succeeded.

Stable:

ICU 3.2

Creates a RuleBasedNumberFormat that behaves according to the description passed in.

The formatter uses the default 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. Arrays are nullptr-terminated.

Parameters

rules	A description of the formatter's desired behavior. See the class documentation for a complete explanation of the description syntax.
localizations	the localization information. names in the description. These will be copied by the constructor.
perror	The parse error if an error was encountered.
status	The status indicating whether the constructor succeeded.

Stable:

ICU 3.2

Creates a RuleBasedNumberFormat that behaves according to the rules passed in.

The formatter uses the specified locale to determine the characters to use when formatting numerals, and to define equivalences for lenient parsing.

Parameters

rules	The formatter rules. See the class documentation for a complete explanation of the rule syntax.
locale	A locale that governs which characters are used for formatting values in numerals and which characters are equivalent in lenient parsing.
perror	The parse error if an error was encountered.
status	The status indicating whether the constructor succeeded.

Stable:

ICU 2.0

Creates a RuleBasedNumberFormat that behaves according to the description passed in.

The formatter uses the default 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. Arrays are nullptr-terminated.

Parameters

rules	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. These will be copied by the constructor.
locale	A locale that governs which characters are used for formatting values in numerals and which characters are equivalent in lenient parsing.
perror	The parse error if an error was encountered.
status	The status indicating whether the constructor succeeded.

Stable:

ICU 3.2

Creates a RuleBasedNumberFormat from a predefined ruleset.

The selector code chose among three possible predefined formats: spellout, ordinal, and duration.

Parameters

tag	A selector code specifying which kind of formatter to create for that locale. There are four legal values: URBNF_SPELLOUT, which creates a formatter that spells out a value in words in the desired language, URBNF_ORDINAL, which attaches an ordinal suffix from the desired language to the end of a number (e.g. "123rd"), URBNF_DURATION, which formats a duration in seconds as hours, minutes, and seconds always rounding down, and URBNF_NUMBERING_SYSTEM, which is used to invoke rules for alternate numbering systems such as the Hebrew numbering system, or for Roman Numerals, etc. NOTE: If you use URBNF_NUMBERING_SYSTEM, you must also call setDefaultRuleSet() to specify the exact numbering system you want to use. If you want the default numbering system for the locale, call NumberFormat::createInstance() instead of creating a RuleBasedNumberFormat directly.
locale	The locale for the formatter.
status	The status indicating whether the constructor succeeded.

Stable:

ICU 2.0

Copy constructor.

Parameters

rhs	the object to be copied from.

Stable:

ICU 2.6

Release memory allocated for a RuleBasedNumberFormat when you are finished with it.

Stable:

ICU 2.6

Sets the decimal format symbols, which is generally not changed by the programmer or user.

The formatter takes ownership of symbolsToAdopt; the client must not delete it.

Parameters

symbolsToAdopt

DecimalFormatSymbols to be adopted.

Stable:

ICU 49

Clone this object polymorphically.

The caller is responsible for deleting the result when done.

Returns

A copy of the object.

Stable:

ICU 2.6

Implements icu::NumberFormat.

Format an object to produce a string.

This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

This method handles Formattable objects with numeric types. If the Formattable object type is not a numeric type, then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

Subclasses should override this method. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format an object to produce a string.

This method handles Formattable objects with numeric types. If the Formattable object type is not a numeric type, then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats an object to produce a string.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
status	Output parameter filled in with success or failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that. Subclasses of NumberFormat that want to specifically handle big decimal numbers must override this method. class DecimalFormat does so.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a decimal number.

The number is a DigitList wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that. Subclasses of NumberFormat that want to specifically handle big decimal numbers must override this method. class DecimalFormat does so.

Parameters

number	The number, a DigitList format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that. Subclasses of NumberFormat that want to specifically handle big decimal numbers must override this method. class DecimalFormat does so.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Formats the specified number using the named ruleset.

Parameters

number	The number to format.
ruleSetName	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.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition
status	the status

Returns

A textual representation of the number.

Stable:

ICU 2.0

Format a double number.

These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a double number.

Concrete subclasses must implement these pure virtual methods.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a double number.

By default, the parent function simply calls the base class and does not return an error status. Therefore, the status may be ignored in some subclasses.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	error status

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a double number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats the specified number using the default ruleset.

Parameters

number	The number to format.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition

Returns

A textual representation of the number.

Stable:

ICU 2.0

Implements icu::NumberFormat.

Formats the specified number using the named ruleset.

Parameters

number	The number to format.
ruleSetName	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.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition
status	the status

Returns

A textual representation of the number.

Stable:

ICU 2.0

Format a long number.

These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a long number.

Concrete subclasses must implement these pure virtual methods.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a long number.

Concrete subclasses may override this function to provide status return.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	the output status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format an int32 number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats the specified 32-bit number using the default ruleset.

Parameters

number	The number to format.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition

Returns

A textual representation of the number.

Stable:

ICU 2.0

Implements icu::NumberFormat.

Formats the specified 64-bit number using the named ruleset.

Parameters

number	The number to format.
ruleSetName	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.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition
status	the status

Returns

A textual representation of the number.

Stable:

ICU 2.1

Format an int64 number.

These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.8

Format an int64 number.

(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.8

Format an int64 number.

(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format an int64 number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats the specified 64-bit number using the default ruleset.

Parameters

number	The number to format.
toAppendTo	the string that will hold the (appended) result
pos	the fieldposition

Returns

A textual representation of the number.

Stable:

ICU 2.1

Reimplemented from icu::NumberFormat.

Format a decimal number.

Subclasses must implement this method. The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at https://speleotrove.com/decimal

Parameters

number	The unformatted number, as a string, to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Return the name of the current default rule set.

If the current rule set is not public, returns a bogus (and empty) UnicodeString.

Returns

the name of the current default rule set

Stable:

ICU 3.0

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:

ICU 2.8

Implements icu::NumberFormat.

Return the number of locales for which we have localized rule set display names.

Returns

the number of locales for which we have localized rule set display names.

Stable:

ICU 3.2

Return the number of public rule set names.

Returns

the number of public rule set names.

Stable:

ICU 2.0

Get the rounding mode.

Returns

A rounding mode

Stable:

ICU 60

Reimplemented from icu::NumberFormat.

return the rules that were provided to the RuleBasedNumberFormat.

Returns

the result String that was passed in

Stable:

ICU 2.0

Return the rule set display name for the provided rule set and locale.

The locale is matched against the locales for which there is display name data, using normal fallback rules. If no locale matches, the default display name is returned.

Returns

the display name for the rule set

Stable:

ICU 3.2

See also

getRuleSetDisplayName

Return the rule set display names for the provided locale.

These are in the same order as those returned by getRuleSetName. The locale is matched against the locales for which there is display name data, using normal fallback rules. If no locale matches, the default display names are returned. (These are the internal rule set names minus the leading ''.)

Parameters

index	the index of the rule set
locale	the locale (returned by getRuleSetDisplayNameLocales) for which the localized display name is desired

Returns

the display name for the given index, which might be bogus if there is an error

See also

getRuleSetName

Stable:

ICU 3.2

Return the index'th display name locale.

Parameters

index	the index of the locale
status	set to a failure code when this function fails

Returns

the locale

See also

getNumberOfRuleSetDisplayNameLocales

Stable:

ICU 3.2

Return the name of the index'th public ruleSet.

If index is not valid, the function returns null.

Parameters

index

the index of the ruleset

Returns

the name of the index'th public ruleSet.

Stable:

ICU 2.0

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:

ICU 2.8

Returns true if lenient-parse mode is turned on.

Lenient parsing is off by default.

Returns

true if lenient-parse mode is turned on.

See also

setLenient

Stable:

ICU 2.0

Reimplemented from icu::NumberFormat.

Definition at line 1167 of file rbnf.h.

Assignment operator.

Parameters

rhs	the object to be copied from.

Stable:

ICU 2.6

Return true if the given Format objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters

other

the object to be compared with.

Returns

true if the given Format objects are semantically equal.

Stable:

ICU 2.6

Reimplemented from icu::NumberFormat.

Parses the specified string, beginning at the specified position, according to this formatter's rules.

This will match the string against all of the formatter's public rule sets and return the value corresponding to the longest parseable substring. This function's behavior is affected by the lenient parse mode.

Parameters

text	The string to parse
result	the result of the parse, either a double or a long.
parsePosition	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.

See also

setLenient

Stable:

ICU 2.0

Implements icu::NumberFormat.

Return a long if possible (e.g.

within range LONG_MAX, LONG_MAX], and with no decimals), otherwise a double. If IntegerOnly is set, will stop at a decimal point (or equivalent; e.g. for rational numbers "1 2/3", will stop after the 1).

If no object can be parsed, index is unchanged, and nullptr is returned.

This is a pure virtual which concrete subclasses must implement.

Parameters

text	The text to be parsed.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
parsePosition	The position to start parsing at on input. On output, moved to after the last successfully parse character. On parse failure, does not change.

Stable:

ICU 2.0

Parse a string as a numeric value, and return a Formattable numeric object.

This method parses integers only if IntegerOnly is set.

Parameters

text	The text to be parsed.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
status	Output parameter set to a failure error code when a failure occurs. The error code when the string fails to parse is U_INVALID_FORMAT_ERROR, unless overridden by a subclass.

See also

NumberFormat::isParseIntegerOnly

Stable:

ICU 2.0

Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.

Note: For getContext, see NumberFormat.

Parameters

value	The UDisplayContext value to set.
status	Input/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function.

Stable:

ICU 53

Reimplemented from icu::NumberFormat.

Sets the decimal format symbols, which is generally not changed by the programmer or user.

A clone of the symbols is created and the symbols is not adopted; the client is still responsible for deleting it.

Parameters

symbols

DecimalFormatSymbols.

Stable:

ICU 49

Override the default rule set to use.

If ruleSetName is null, reset to the initial default rule set. If the rule set is not a public rule set name, U_ILLEGAL_ARGUMENT_ERROR is returned in status.

Parameters

ruleSetName	the name of the rule set, or null to reset the initial default.
status	set to failure code when a problem occurs.

Stable:

ICU 2.6

Turns lenient parse mode on and off.

When in lenient parse mode, the formatter uses a Collator for parsing the text. Only primary differences are treated as significant. This means that case differences, accent differences, alternate spellings of the same letter (e.g., ae and a-umlaut in German), ignorable characters, etc. are ignored in matching the text. In many cases, numerals will be accepted in place of words or phrases as well.

For example, all of the following will correctly parse as 255 in English in lenient-parse mode:
"two hundred fifty-five"
"two hundred fifty five"
"TWO HUNDRED FIFTY-FIVE"
"twohundredfiftyfive"
"2 hundred fifty-5"

The Collator used is determined by the locale that was passed to this object on construction. The description passed to this object on construction may supply additional collation rules that are appended to the end of the default collator for the locale, enabling additional equivalences (such as adding more ignorable characters or permitting spelled-out version of symbols; see the demo program for examples).

It's important to emphasize that even strict parsing is relatively lenient: it will accept some text that it won't produce as output. In English, for example, it will correctly parse "two hundred zero" and "fifteen hundred".

Parameters

enabled

If true, turns lenient-parse mode on; if false, turns it off.

See also

RuleBasedCollator

Stable:

ICU 2.0

Reimplemented from icu::NumberFormat.

Set the rounding mode.

Parameters

roundingMode

A rounding mode

Stable:

ICU 60

Reimplemented from icu::NumberFormat.