Alignment Field constants used to construct a FieldPosition object.

Signifies that the position of the integer part or fraction part of a formatted number should be returned.

Note: as of ICU 4.4, the values in this enum have been extended to support identification of all number format fields, not just those pertaining to alignment.

These constants are provided for backwards compatibility only. Please use the C style constants defined in the header file unum.h.

See also

FieldPosition

Stable:

ICU 2.0

Definition at line 234 of file numfmt.h.

Rounding mode.

For more detail on rounding modes, see: https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes

Stable:

ICU 2.4

Definition at line 186 of file numfmt.h.

Destructor.

Stable:

ICU 2.0

Default constructor for subclass use only.

Stable:

ICU 2.0

Copy constructor.

Stable:

ICU 2.0

Clones this object polymorphically.

The caller owns the result and should delete it when done.

Returns

clone, or nullptr if an error occurred

Stable:

ICU 2.0

Implements icu::Format.

Implemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, icu::CompactDecimalFormat, and icu::ChoiceFormat.

Returns a currency format for the specified locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Parameters

inLocale

the given locale.

Stable:

ICU 2.0

Returns a currency format for the current default locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Stable:

ICU 2.0

Create a specific style NumberFormat for the specified locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Parameters

desiredLocale	the given locale.
style	the given style.
errorCode	Output param filled with success/failure status.

Returns

A new NumberFormat instance.

Stable:

ICU 4.8

Create a default style NumberFormat for the specified locale.

The default formatting style is locale dependent.

Parameters

inLocale

the given locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Stable:

ICU 2.0

Create a default style NumberFormat for the current default locale.

The default formatting style is locale dependent.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Stable:

ICU 2.0

Returns a percentage format for the specified locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Parameters

inLocale

the given locale.

Stable:

ICU 2.0

Returns a percentage format for the current default locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Stable:

ICU 2.0

Returns a scientific format for the specified locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Parameters

inLocale

the given locale.

Stable:

ICU 2.0

Returns a scientific format for the current default locale.

NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.

Stable:

ICU 2.0

ICU use only.

Returns handle to the shared, cached NumberFormat instance for given locale. On success, caller must call removeRef() on returned value once it is done with the shared instance.

Internal:

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

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

Implements icu::Format.

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.

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

Reimplemented from icu::Format.

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.

Reimplemented in icu::RuleBasedNumberFormat, and icu::DecimalFormat.

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.

Reimplemented in icu::DecimalFormat.

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

Implemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, and icu::ChoiceFormat.

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.

Reimplemented in icu::DecimalFormat.

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

Reimplemented in icu::DecimalFormat.

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

Implemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, and icu::ChoiceFormat.

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.

Reimplemented in icu::DecimalFormat.

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

Reimplemented in icu::DecimalFormat.

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

Reimplemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, and icu::ChoiceFormat.

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.

Reimplemented in icu::DecimalFormat.

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

Reimplemented in icu::DecimalFormat.

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

Reimplemented in icu::DecimalFormat.

Return a StringEnumeration over the locales available at the time of the call, including registered locales.

Returns

a StringEnumeration over the locales available at the time of the call

Stable:

ICU 2.6

Get the set of Locales for which NumberFormats are installed.

Parameters

count

Output param to receive the size of the locales

Stable:

ICU 2.0

Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.

Parameters

type	The UDisplayContextType whose value to return
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.

Returns

The UDisplayContextValue for the specified type.

Stable:

ICU 53

Gets the currency used to display currency amounts.

This may be an empty string for some subclasses.

Returns

a 3-letter null-terminated ISO code indicating the currency in use, or a pointer to the empty string.

Stable:

ICU 2.6

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.

Returns

The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable:

ICU 2.0

Reimplemented from icu::UObject.

Implemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, icu::CompactDecimalFormat, and icu::ChoiceFormat.

Returns the currency in effect for this formatter.

Subclasses should override this method as needed. Unlike getCurrency(), this method should never return "".

Returns

output parameter for null-terminated result, which must have a capacity of at least 4

Internal:

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

Returns the maximum number of digits allowed in the fraction portion of a number.

Returns

the maximum number of digits allowed in the fraction portion of a number.

See also

setMaximumFractionDigits

Stable:

ICU 2.0

Returns the maximum number of digits allowed in the integer portion of a number.

Returns

the maximum number of digits allowed in the integer portion of a number.

See also

setMaximumIntegerDigits

Stable:

ICU 2.0

Returns the minimum number of digits allowed in the fraction portion of a number.

Returns

the minimum number of digits allowed in the fraction portion of a number.

See also

setMinimumFractionDigits

Stable:

ICU 2.0

Returns the minimum number of digits allowed in the integer portion of a number.

Returns

the minimum number of digits allowed in the integer portion of a number.

See also

setMinimumIntegerDigits

Stable:

ICU 2.0

Get the rounding mode.

This will always return NumberFormat::ERoundingMode::kRoundUnnecessary if the subclass does not support rounding.

Returns

A rounding mode

Stable:

ICU 60

Reimplemented in icu::RuleBasedNumberFormat, and icu::DecimalFormat.

Return the class ID for this class.

This is useful for comparing to a return value from getDynamicClassID(). Note that, because NumberFormat is an abstract base class, no fully constructed object will have the class ID returned by NumberFormat::getStaticClassID().

Returns

The class ID for all objects of this class.

Stable:

ICU 2.0

ICU use only.

Creates NumberFormat instance without using the cache.

Internal:

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

Returns true if grouping is used in this format.

For example, in the English locale, with grouping on, the number 1234567 might be formatted as "1,234,567". The grouping separator as well as the size of each group is locale dependent and is determined by sub-classes of NumberFormat.

See also

setGroupingUsed

Stable:

ICU 2.0

Returns whether lenient parsing is enabled (it is off by default).

Returns

true if lenient parsing is enabled, false otherwise.

See also

setLenient

Stable:

ICU 4.8

Reimplemented in icu::RuleBasedNumberFormat.

Definition at line 1274 of file numfmt.h.

Return true if this format will parse numbers as integers only.

For example in the English locale, with ParseIntegerOnly true, the string "1234." would be parsed as the integer value 1234 and parsing would stop at the "." character. Of course, the exact format accepted by the parse operation is locale dependent and determined by sub-classes of NumberFormat.

Returns

true if this format will parse numbers as integers only.

Stable:

ICU 2.0

Definition at line 1268 of file numfmt.h.

Creates the specified number format style of the desired locale.

If mustBeDecimalFormat is true, then the returned pointer is either a DecimalFormat or it is nullptr.

Internal:

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

Assignment operator.

Stable:

ICU 2.0

Return true if the given Format objects are semantically equal.

Objects of different subclasses are considered unequal.

Returns

true if the given Format objects are semantically equal.

Stable:

ICU 2.0

Implements icu::Format.

Reimplemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, and icu::ChoiceFormat.

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

Implemented in icu::RuleBasedNumberFormat, icu::DecimalFormat, icu::CompactDecimalFormat, and icu::ChoiceFormat.

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

Reimplemented in icu::CompactDecimalFormat.

Parses text from the given string as a currency amount.

Unlike the parse() method, this method will attempt to parse a generic currency name, searching for a match of this object's locale's currency display names, or for a 3-letter ISO currency code. This method will fail if this format is not a currency format, that is, if it does not contain the currency pattern symbol (U+00A4) in its prefix or suffix.

Parameters

text	the string to parse
pos	input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output.

Returns

if parse succeeds, a pointer to a newly-created CurrencyAmount object (owned by the caller) containing information about the parsed currency; if parse fails, this is nullptr.

Stable:

ICU 49

Reimplemented in icu::DecimalFormat, and icu::CompactDecimalFormat.

Parse a string to produce an object.

This methods handles parsing of numeric strings into Formattable objects with numeric types.

Before calling, set parse_pos.index to the offset you want to start parsing at in the source. After calling, parse_pos.index indicates the position after the successfully parsed text. If an error occurs, parse_pos.index is unchanged.

When parsing, leading whitespace is discarded (with successful parse), while trailing whitespace is left as is.

See Format::parseObject() for more.

Parameters

source	The string to be parsed into an object.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
parse_pos	The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged.

Returns

A newly created Formattable* object, or nullptr on failure. The caller owns this and should delete it when done.

Stable:

ICU 2.0

Implements icu::Format.

Register a new NumberFormatFactory.

The factory will be adopted. Because ICU may choose to cache NumberFormat objects internally, this must be called at application startup, prior to any calls to NumberFormat::createInstance to avoid undefined behavior.

Parameters

toAdopt	the NumberFormatFactory instance to be adopted
status	the in/out status code, no special meanings are assigned

Returns

a registry key that can be used to unregister this factory

Stable:

ICU 2.6

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

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 in icu::RuleBasedNumberFormat.

Sets the currency used to display currency amounts.

This takes effect immediately, if this format is a currency format. If this format is not a currency format, then the currency is used if and when this object becomes a currency format.

Parameters

theCurrency	a 3-letter ISO code indicating new currency to use. It need not be null-terminated. May be the empty string or nullptr to indicate no currency.
ec	input-output error code

Stable:

ICU 3.0

Reimplemented in icu::DecimalFormat.

Set whether or not grouping will be used in this format.

Parameters

newValue

True, grouping will be used in this format.

See also

getGroupingUsed

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Sets whether lenient parsing should be enabled (it is off by default).

Parameters

enable

true if lenient parsing should be used, false otherwise.

Stable:

ICU 4.8

Reimplemented in icu::RuleBasedNumberFormat, and icu::DecimalFormat.

Sets the maximum number of digits allowed in the fraction portion of a number.

maximumFractionDigits must be >= minimumFractionDigits. If the new value for maximumFractionDigits is less than the current value of minimumFractionDigits, then minimumFractionDigits will also be set to the new value.

Parameters

newValue

the new value to be set.

See also

getMaximumFractionDigits

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Sets the maximum number of digits allowed in the integer portion of a number.

maximumIntegerDigits must be >= minimumIntegerDigits. If the new value for maximumIntegerDigits is less than the current value of minimumIntegerDigits, then minimumIntegerDigits will also be set to the new value.

Parameters

newValue

the new value for the maximum number of digits allowed in the integer portion of a number.

See also

getMaximumIntegerDigits

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Sets the minimum number of digits allowed in the fraction portion of a number.

minimumFractionDigits must be <= maximumFractionDigits. If the new value for minimumFractionDigits exceeds the current value of maximumFractionDigits, then maximumIntegerDigits will also be set to the new value

Parameters

newValue

the new value to be set.

See also

getMinimumFractionDigits

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Sets the minimum number of digits allowed in the integer portion of a number.

minimumIntegerDigits must be <= maximumIntegerDigits. If the new value for minimumIntegerDigits exceeds the current value of maximumIntegerDigits, then maximumIntegerDigits will also be set to the new value.

Parameters

newValue

the new value to be set.

See also

getMinimumIntegerDigits

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Sets whether or not numbers should be parsed as integers only.

Parameters

value

set True, this format will parse numbers as integers only.

See also

isParseIntegerOnly

Stable:

ICU 2.0

Reimplemented in icu::DecimalFormat.

Set the rounding mode.

If a subclass does not support rounding, this will do nothing.

Parameters

roundingMode

A rounding mode

Stable:

ICU 60

Reimplemented in icu::RuleBasedNumberFormat, and icu::DecimalFormat.

Unregister a previously-registered NumberFormatFactory using the key returned from the register call.

Key becomes invalid after a successful call and should not be used again. The NumberFormatFactory corresponding to the key will be deleted. Because ICU may choose to cache NumberFormat objects internally, this should be called during application shutdown, after all calls to NumberFormat::createInstance to avoid undefined behavior.

Parameters

key	the registry key returned by a previous call to registerFactory
status	the in/out status code, no special meanings are assigned

Returns

true if the factory for the key was successfully unregistered

Stable:

ICU 2.6

Internal:

Do not use.

This API is for internal use only.

Definition at line 1163 of file numfmt.h.

Internal:

Do not use.

This API is for internal use only.

Definition at line 1165 of file numfmt.h.