NumberFormat Class Reference

Abstract base class for all number formats. More...

#include <numfmt.h>

Inheritance diagram for NumberFormat:
Format UObject UMemory ChoiceFormat DecimalFormat RuleBasedNumberFormat

Public Types

enum  EStyles {
  kNumberStyle, kCurrencyStyle, kPercentStyle, kScientificStyle,
  kIsoCurrencyStyle, kPluralCurrencyStyle, kStyleCount
}
 

Constants for various number format styles.

More...
enum  EAlignmentFields {
  kIntegerField, kFractionField, kDecimalSeparatorField, kExponentSymbolField,
  kExponentSignField, kExponentField, kGroupingSeparatorField, kCurrencyField,
  kPercentField, kPermillField, kSignField, INTEGER_FIELD = kIntegerField,
  FRACTION_FIELD = kFractionField
}
 

Alignment Field constants used to construct a FieldPosition object.

More...

Public Member Functions

virtual ~NumberFormat ()
 Destructor.
virtual UBool operator== (const Format &other) const
 Return true if the given Format objects are semantically equal.
virtual UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
 Format an object to produce a string.
virtual UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator &posIter, UErrorCode &status) const
 Format an object to produce a string.
virtual void parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const
 Parse a string to produce an object.
UnicodeStringformat (double number, UnicodeString &appendTo) const
 Format a double number.
UnicodeStringformat (int32_t number, UnicodeString &appendTo) const
 Format a long number.
UnicodeStringformat (int64_t number, UnicodeString &appendTo) const
 Format an int64 number.
virtual UnicodeStringformat (double number, UnicodeString &appendTo, FieldPosition &pos) const =0
 Format a double number.
virtual UnicodeStringformat (double number, UnicodeString &appendTo, FieldPositionIterator &posIter, UErrorCode &status) const
 Format a double number.
virtual UnicodeStringformat (int32_t number, UnicodeString &appendTo, FieldPosition &pos) const =0
 Format a long number.
virtual UnicodeStringformat (int32_t number, UnicodeString &appendTo, FieldPositionIterator &posIter, UErrorCode &status) const
 Format an int32 number.
virtual UnicodeStringformat (int64_t number, UnicodeString &appendTo, FieldPosition &pos) const
 Format an int64 number.
virtual UnicodeStringformat (int64_t number, UnicodeString &appendTo, FieldPositionIterator &posIter, UErrorCode &status) const
 Format an int64 number.
virtual UnicodeStringformat (const StringPiece &number, UnicodeString &appendTo, FieldPositionIterator &posIter, UErrorCode &status) const
 Format a decimal number.
UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
 Redeclared Format method.
virtual void parse (const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const =0
 Return a long if possible (e.g.
virtual void parse (const UnicodeString &text, Formattable &result, UErrorCode &status) const
 Parse a string as a numeric value, and return a Formattable numeric object.
virtual FormattableparseCurrency (const UnicodeString &text, Formattable &result, ParsePosition &pos) const
 Parses text from the given string as a currency amount.
UBool isParseIntegerOnly (void) const
 Return true if this format will parse numbers as integers only.
virtual void setParseIntegerOnly (UBool value)
 Sets whether or not numbers should be parsed as integers only.
UBool isGroupingUsed (void) const
 Returns true if grouping is used in this format.
virtual void setGroupingUsed (UBool newValue)
 Set whether or not grouping will be used in this format.
int32_t getMaximumIntegerDigits (void) const
 Returns the maximum number of digits allowed in the integer portion of a number.
virtual void setMaximumIntegerDigits (int32_t newValue)
 Sets the maximum number of digits allowed in the integer portion of a number.
int32_t getMinimumIntegerDigits (void) const
 Returns the minimum number of digits allowed in the integer portion of a number.
virtual void setMinimumIntegerDigits (int32_t newValue)
 Sets the minimum number of digits allowed in the integer portion of a number.
int32_t getMaximumFractionDigits (void) const
 Returns the maximum number of digits allowed in the fraction portion of a number.
virtual void setMaximumFractionDigits (int32_t newValue)
 Sets the maximum number of digits allowed in the fraction portion of a number.
int32_t getMinimumFractionDigits (void) const
 Returns the minimum number of digits allowed in the fraction portion of a number.
virtual void setMinimumFractionDigits (int32_t newValue)
 Sets the minimum number of digits allowed in the fraction portion of a number.
virtual void setCurrency (const UChar *theCurrency, UErrorCode &ec)
 Sets the currency used to display currency amounts.
const UChargetCurrency () const
 Gets the currency used to display currency amounts.
virtual UClassID getDynamicClassID (void) const =0
 Returns a unique class ID POLYMORPHICALLY.

Static Public Member Functions

static NumberFormatcreateInstance (UErrorCode &)
 Returns the default number format for the current default locale.
static NumberFormatcreateInstance (const Locale &inLocale, UErrorCode &)
 Returns the default number format for the specified locale.
static NumberFormatcreateInstance (const Locale &desiredLocale, EStyles choice, UErrorCode &success)
 Creates the specified decimal format style of the desired locale.
static NumberFormatcreateCurrencyInstance (UErrorCode &)
 Returns a currency format for the current default locale.
static NumberFormatcreateCurrencyInstance (const Locale &inLocale, UErrorCode &)
 Returns a currency format for the specified locale.
static NumberFormatcreatePercentInstance (UErrorCode &)
 Returns a percentage format for the current default locale.
static NumberFormatcreatePercentInstance (const Locale &inLocale, UErrorCode &)
 Returns a percentage format for the specified locale.
static NumberFormatcreateScientificInstance (UErrorCode &)
 Returns a scientific format for the current default locale.
static NumberFormatcreateScientificInstance (const Locale &inLocale, UErrorCode &)
 Returns a scientific format for the specified locale.
static const LocalegetAvailableLocales (int32_t &count)
 Get the set of Locales for which NumberFormats are installed.
static URegistryKey registerFactory (NumberFormatFactory *toAdopt, UErrorCode &status)
 Register a new NumberFormatFactory.
static UBool unregister (URegistryKey key, UErrorCode &status)
 Unregister a previously-registered NumberFormatFactory using the key returned from the register call.
static StringEnumerationgetAvailableLocales (void)
 Return a StringEnumeration over the locales available at the time of the call, including registered locales.
static UClassID getStaticClassID (void)
 Return the class ID for this class.

Protected Member Functions

 NumberFormat ()
 Default constructor for subclass use only.
 NumberFormat (const NumberFormat &)
 Copy constructor.
NumberFormatoperator= (const NumberFormat &)
 Assignment operator.
virtual void getEffectiveCurrency (UChar *result, UErrorCode &ec) const
 Returns the currency in effect for this formatter.

Friends

class ICUNumberFormatFactory
class ICUNumberFormatService

Detailed Description

Abstract base class for all number formats.

Provides interface for formatting and parsing a number. Also provides methods for determining which locales have number formats, and what their names are.

NumberFormat helps you to format and parse numbers for any locale. Your code can be completely independent of the locale conventions for decimal points, thousands-separators, or even the particular decimal digits used, or whether the number format is even decimal.

To format a number for the current Locale, use one of the static factory methods:

 
    double myNumber = 7.0;
    UnicodeString myString;
    UErrorCode success = U_ZERO_ERROR;
    NumberFormat* nf = NumberFormat::createInstance(success)
    nf->format(myNumber, myString);
    cout << " Example 1: " << myString << endl;

If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.

 
     UnicodeString myString;
     UErrorCode success = U_ZERO_ERROR;
     nf = NumberFormat::createInstance( success );
     int32_t a[] = { 123, 3333, -1234567 };
     const int32_t a_len = sizeof(a) / sizeof(a[0]);
     myString.remove();
     for (int32_t i = 0; i < a_len; i++) {
         nf->format(a[i], myString);
         myString += " ; ";
     }
     cout << " Example 2: " << myString << endl;

To format a number for a different Locale, specify it in the call to createInstance().

 
     nf = NumberFormat::createInstance( Locale::FRENCH, success );

You can use a NumberFormat to parse also.

 
    UErrorCode success;
    Formattable result(-999);  // initialized with error code
    nf->parse(myString, result, success);

Use createInstance to get the normal number format for that country. There are other static factory methods available. Use getCurrency to get the currency number format for that country. Use getPercent to get a format for displaying percentages. With this format, a fraction from 0.53 is displayed as 53%.

Starting from ICU 4.2, you can use createInstance() by passing in a 'style' as parameter to get the correct instance. For example, use createInstance(...kNumberStyle...) to get the normal number format, createInstance(...kPercentStyle...) to get a format for displaying percentage, createInstance(...kScientificStyle...) to get a format for displaying scientific number, createInstance(...kCurrencyStyle...) to get the currency number format, in which the currency is represented by its symbol, for example, "$3.00". createInstance(...kIsoCurrencyStyle...) to get the currency number format, in which the currency is represented by its ISO code, for example "USD3.00". createInstance(...kPluralCurrencyStyle...) to get the currency number format, in which the currency is represented by its full name in plural format, for example, "3.00 US dollars" or "1.00 US dollar".

You can also control the display of numbers with such methods as getMinimumFractionDigits. If you want even more control over the format or parsing, or want to give your users more control, you can try casting the NumberFormat you get from the factory methods to a DecimalNumberFormat. This will work for the vast majority of countries; just remember to put it in a try block in case you encounter an unusual one.

You can also use forms of the parse and format methods with ParsePosition and FieldPosition to allow you to:

For example, you can align numbers in two ways.

If you are using a monospaced font with spacing for alignment, you can pass the FieldPosition in your format call, with field = INTEGER_FIELD. On output, getEndIndex will be set to the offset between the last character of the integer and the decimal. Add (desiredSpaceCount - getEndIndex) spaces at the front of the string.

If you are using proportional fonts, instead of padding with spaces, measure the width of the string in pixels from the start to getEndIndex. Then move the pen by (desiredPixelWidth - widthToAlignmentPoint) before drawing the text. It also works where there is no decimal, but possibly additional characters at the end, e.g. with parentheses in negative numbers: "(12)" for -12.

User subclasses are not supported. While clients may write subclasses, such code will not necessarily work and will not be guaranteed to work stably from release to release.

Stable:
ICU 2.0

Definition at line 163 of file numfmt.h.


Member Enumeration Documentation

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.

See also:
FieldPosition
Stable:
ICU 2.0
Enumerator:
INTEGER_FIELD 

These constants are provided for backwards compatibility only.

Please use the C++ style constants defined above.

Stable:
ICU 2.0

Definition at line 201 of file numfmt.h.

Constants for various number format styles.

kNumberStyle specifies a normal number style of format. kCurrencyStyle specifies a currency format using currency symbol name, such as in "$1.00". kPercentStyle specifies a style of format to display percent. kScientificStyle specifies a style of format to display scientific number. kISOCurrencyStyle specifies a currency format using ISO currency code, such as in "USD1.00". kPluralCurrencyStyle specifies a currency format using currency plural names, such as in "1.00 US dollar" and "3.00 US dollars".

Draft:
This API may be changed in the future versions and was introduced in ICU 4.2

Definition at line 179 of file numfmt.h.


Constructor & Destructor Documentation

virtual NumberFormat::~NumberFormat (  )  [virtual]

Destructor.

Stable:
ICU 2.0
NumberFormat::NumberFormat (  )  [protected]

Default constructor for subclass use only.

Stable:
ICU 2.0
NumberFormat::NumberFormat ( const NumberFormat  )  [protected]

Copy constructor.

Stable:
ICU 2.0

Member Function Documentation

static NumberFormat* NumberFormat::createCurrencyInstance ( const Locale inLocale,
UErrorCode  
) [static]

Returns a currency format for the specified locale.

Parameters:
inLocale the given locale.
Stable:
ICU 2.0
static NumberFormat* NumberFormat::createCurrencyInstance ( UErrorCode  )  [static]

Returns a currency format for the current default locale.

Stable:
ICU 2.0
static NumberFormat* NumberFormat::createInstance ( const Locale desiredLocale,
EStyles  choice,
UErrorCode success 
) [static]

Creates the specified decimal format style of the desired locale.

Parameters:
desiredLocale the given locale.
choice the given style.
success Output param filled with success/failure status.
Returns:
A new NumberFormat instance.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.2
static NumberFormat* NumberFormat::createInstance ( const Locale inLocale,
UErrorCode  
) [static]

Returns the default number format for the specified locale.

The default format is one of the styles provided by the other factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. Exactly which one is locale dependant.

Parameters:
inLocale the given locale.
Stable:
ICU 2.0
static NumberFormat* NumberFormat::createInstance ( UErrorCode  )  [static]

Returns the default number format for the current default locale.

The default format is one of the styles provided by the other factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. Exactly which one is locale dependant.

Stable:
ICU 2.0
static NumberFormat* NumberFormat::createPercentInstance ( const Locale inLocale,
UErrorCode  
) [static]

Returns a percentage format for the specified locale.

Parameters:
inLocale the given locale.
Stable:
ICU 2.0
static NumberFormat* NumberFormat::createPercentInstance ( UErrorCode  )  [static]

Returns a percentage format for the current default locale.

Stable:
ICU 2.0
static NumberFormat* NumberFormat::createScientificInstance ( const Locale inLocale,
UErrorCode  
) [static]

Returns a scientific format for the specified locale.

Parameters:
inLocale the given locale.
Stable:
ICU 2.0
static NumberFormat* NumberFormat::createScientificInstance ( UErrorCode  )  [static]

Returns a scientific format for the current default locale.

Stable:
ICU 2.0
UnicodeString & NumberFormat::format ( const Formattable obj,
UnicodeString appendTo,
UErrorCode status 
) const [inline]

Redeclared Format method.

Parameters:
obj The object to be formatted.
appendTo Output parameter to receive result. Result is appended to existing contents.
status Output parameter set to a failure error code when a failure occurs.
Returns:
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Reimplemented from Format.

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

Definition at line 989 of file numfmt.h.

References format().

virtual UnicodeString& NumberFormat::format ( const StringPiece number,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const [virtual]

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 http://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.
status Output param filled with success/failure status.
Returns:
Reference to 'appendTo' parameter.
Draft:
This API may be changed in the future versions and was introduced in 4.4

Reimplemented in DecimalFormat.

virtual UnicodeString& NumberFormat::format ( int64_t  number,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const [virtual]

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.
status Output param filled with success/failure status.
Returns:
Reference to 'appendTo' parameter.
Draft:
This API may be changed in the future versions and was introduced in 4.4

Reimplemented in DecimalFormat.

virtual UnicodeString& NumberFormat::format ( int64_t  number,
UnicodeString appendTo,
FieldPosition pos 
) const [virtual]

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 ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual UnicodeString& NumberFormat::format ( int32_t  number,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const [virtual]

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.
status Output param filled with success/failure status.
Returns:
Reference to 'appendTo' parameter.
Draft:
This API may be changed in the future versions and was introduced in 4.4

Reimplemented in DecimalFormat.

virtual UnicodeString& NumberFormat::format ( int32_t  number,
UnicodeString appendTo,
FieldPosition pos 
) const [pure virtual]

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 ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual UnicodeString& NumberFormat::format ( double  number,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const [virtual]

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.
status Output param filled with success/failure status.
Returns:
Reference to 'appendTo' parameter.
Draft:
This API may be changed in the future versions and was introduced in 4.4

Reimplemented in DecimalFormat.

virtual UnicodeString& NumberFormat::format ( double  number,
UnicodeString appendTo,
FieldPosition pos 
) const [pure virtual]

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 ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

UnicodeString& NumberFormat::format ( int64_t  number,
UnicodeString appendTo 
) const

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

Reimplemented in DecimalFormat.

UnicodeString& NumberFormat::format ( int32_t  number,
UnicodeString appendTo 
) const

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

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

UnicodeString& NumberFormat::format ( double  number,
UnicodeString appendTo 
) const

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

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual UnicodeString& NumberFormat::format ( const Formattable obj,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const [virtual]

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.
status Output param filled with success/failure status.
Returns:
Reference to 'appendTo' parameter.
Draft:
This API may be changed in the future versions and was introduced in 4.4

Reimplemented from Format.

virtual UnicodeString& NumberFormat::format ( const Formattable obj,
UnicodeString appendTo,
FieldPosition pos,
UErrorCode status 
) const [virtual]

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 Format.

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

Referenced by format().

static StringEnumeration* NumberFormat::getAvailableLocales ( void   )  [static]

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
static const Locale* NumberFormat::getAvailableLocales ( int32_t &  count  )  [static]

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
const UChar* NumberFormat::getCurrency (  )  const

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
virtual UClassID NumberFormat::getDynamicClassID ( void   )  const [pure virtual]

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

Implements Format.

Implemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual void NumberFormat::getEffectiveCurrency ( UChar result,
UErrorCode ec 
) const [protected, virtual]

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.

Reimplemented in DecimalFormat.

int32_t NumberFormat::getMaximumFractionDigits ( void   )  const

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
int32_t NumberFormat::getMaximumIntegerDigits ( void   )  const

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
int32_t NumberFormat::getMinimumFractionDigits ( void   )  const

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
int32_t NumberFormat::getMinimumIntegerDigits ( void   )  const

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
static UClassID NumberFormat::getStaticClassID ( void   )  [static]

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

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

UBool NumberFormat::isGroupingUsed ( void   )  const

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 dependant and is determined by sub-classes of NumberFormat.

See also:
setGroupingUsed
Stable:
ICU 2.0
UBool NumberFormat::isParseIntegerOnly ( void   )  const [inline]

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 dependant 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 983 of file numfmt.h.

NumberFormat& NumberFormat::operator= ( const NumberFormat  )  [protected]

Assignment operator.

Stable:
ICU 2.0

Reimplemented from Format.

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual UBool NumberFormat::operator== ( const Format other  )  const [virtual]

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

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual void NumberFormat::parse ( const UnicodeString text,
Formattable result,
UErrorCode status 
) const [virtual]

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.
Returns:
A Formattable object of numeric type. The caller owns this an must delete it. NULL on failure.
See also:
NumberFormat::isParseIntegerOnly
Stable:
ICU 2.0

Reimplemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual void NumberFormat::parse ( const UnicodeString text,
Formattable result,
ParsePosition parsePosition 
) const [pure virtual]

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 NULL 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.
Returns:
A Formattable object of numeric type. The caller owns this an must delete it. NULL on failure.
Stable:
ICU 2.0

Implemented in ChoiceFormat, DecimalFormat, and RuleBasedNumberFormat.

virtual Formattable& NumberFormat::parseCurrency ( const UnicodeString text,
Formattable result,
ParsePosition pos 
) const [virtual]

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
result output parameter to receive result. This will have its currency set to the parsed ISO currency code.
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:
a reference to result
Internal:
Do not use. This API is for internal use only.

Reimplemented in DecimalFormat.

virtual void NumberFormat::parseObject ( const UnicodeString source,
Formattable result,
ParsePosition parse_pos 
) const [virtual]

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 NULL on failure. The caller owns this and should delete it when done.
Stable:
ICU 2.0

Implements Format.

static URegistryKey NumberFormat::registerFactory ( NumberFormatFactory toAdopt,
UErrorCode status 
) [static]

Register a new NumberFormatFactory.

The factory will be adopted.

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
virtual void NumberFormat::setCurrency ( const UChar theCurrency,
UErrorCode ec 
) [virtual]

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 NULL to indicate no currency.
ec input-output error code
Stable:
ICU 3.0

Reimplemented in DecimalFormat.

virtual void NumberFormat::setGroupingUsed ( UBool  newValue  )  [virtual]

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
virtual void NumberFormat::setMaximumFractionDigits ( int32_t  newValue  )  [virtual]

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 DecimalFormat.

virtual void NumberFormat::setMaximumIntegerDigits ( int32_t  newValue  )  [virtual]

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 DecimalFormat.

virtual void NumberFormat::setMinimumFractionDigits ( int32_t  newValue  )  [virtual]

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 DecimalFormat.

virtual void NumberFormat::setMinimumIntegerDigits ( int32_t  newValue  )  [virtual]

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 DecimalFormat.

virtual void NumberFormat::setParseIntegerOnly ( UBool  value  )  [virtual]

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
static UBool NumberFormat::unregister ( URegistryKey  key,
UErrorCode status 
) [static]

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.

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

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sat Jan 23 15:17:43 2010 for ICU 4.3.4 by  doxygen 1.6.1