#include <decimfmt.h>
Inheritance diagram for DecimalFormat:
Public Types | |
enum | ERoundingMode { kRoundCeiling, kRoundFloor, kRoundDown, kRoundUp, kRoundHalfEven, kRoundHalfDown, kRoundHalfUp } |
Rounding mode. More... | |
enum | EPadPosition { kPadBeforePrefix, kPadAfterPrefix, kPadBeforeSuffix, kPadAfterSuffix } |
Pad position. More... | |
Public Member Functions | |
DecimalFormat (UErrorCode &status) | |
Create a DecimalFormat using the default pattern and symbols for the default locale. | |
DecimalFormat (const UnicodeString &pattern, UErrorCode &status) | |
Create a DecimalFormat from the given pattern and the symbols for the default locale. | |
DecimalFormat (const UnicodeString &pattern, DecimalFormatSymbols *symbolsToAdopt, UErrorCode &status) | |
Create a DecimalFormat from the given pattern and symbols. | |
DecimalFormat (const UnicodeString &pattern, DecimalFormatSymbols *symbolsToAdopt, UParseError &parseError, UErrorCode &status) | |
Create a DecimalFormat from the given pattern and symbols. | |
DecimalFormat (const UnicodeString &pattern, const DecimalFormatSymbols &symbols, UErrorCode &status) | |
Create a DecimalFormat from the given pattern and symbols. | |
DecimalFormat (const DecimalFormat &source) | |
Copy constructor. | |
DecimalFormat & | operator= (const DecimalFormat &rhs) |
Assignment operator. | |
virtual | ~DecimalFormat () |
Destructor. | |
virtual Format * | clone (void) const |
Clone this Format object polymorphically. | |
virtual UBool | operator== (const Format &other) const |
Return true if the given Format objects are semantically equal. | |
virtual UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos) const |
Format a double or long number using base-10 representation. | |
virtual UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos) const |
Format a long number using base-10 representation. | |
virtual UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos) const |
Format an int64 number using base-10 representation. | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format a Formattable using base-10 representation. | |
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const |
Redeclared NumberFormat method. | |
UnicodeString & | format (double number, UnicodeString &appendTo) const |
Redeclared NumberFormat method. | |
UnicodeString & | format (int32_t number, UnicodeString &appendTo) const |
Redeclared NumberFormat method. | |
UnicodeString & | format (int64_t number, UnicodeString &appendTo) const |
Redeclared NumberFormat method. | |
virtual void | parse (const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const |
Parse the given string using this object's choices. | |
virtual void | parse (const UnicodeString &text, Formattable &result, UErrorCode &status) const |
Parse the given string using this object's choices. | |
virtual Formattable & | parseCurrency (const UnicodeString &text, Formattable &result, ParsePosition &pos) const |
Parses text from the given string as a currency amount. | |
virtual const DecimalFormatSymbols * | getDecimalFormatSymbols (void) const |
Returns the decimal format symbols, which is generally not changed by the programmer or user. | |
virtual void | adoptDecimalFormatSymbols (DecimalFormatSymbols *symbolsToAdopt) |
Sets the decimal format symbols, which is generally not changed by the programmer or user. | |
virtual void | setDecimalFormatSymbols (const DecimalFormatSymbols &symbols) |
Sets the decimal format symbols, which is generally not changed by the programmer or user. | |
UnicodeString & | getPositivePrefix (UnicodeString &result) const |
Get the positive prefix. | |
virtual void | setPositivePrefix (const UnicodeString &newValue) |
Set the positive prefix. | |
UnicodeString & | getNegativePrefix (UnicodeString &result) const |
Get the negative prefix. | |
virtual void | setNegativePrefix (const UnicodeString &newValue) |
Set the negative prefix. | |
UnicodeString & | getPositiveSuffix (UnicodeString &result) const |
Get the positive suffix. | |
virtual void | setPositiveSuffix (const UnicodeString &newValue) |
Set the positive suffix. | |
UnicodeString & | getNegativeSuffix (UnicodeString &result) const |
Get the negative suffix. | |
virtual void | setNegativeSuffix (const UnicodeString &newValue) |
Set the negative suffix. | |
int32_t | getMultiplier (void) const |
Get the multiplier for use in percent, permill, etc. | |
virtual void | setMultiplier (int32_t newValue) |
Set the multiplier for use in percent, permill, etc. | |
virtual double | getRoundingIncrement (void) const |
Get the rounding increment. | |
virtual void | setRoundingIncrement (double newValue) |
Set the rounding increment. | |
virtual ERoundingMode | getRoundingMode (void) const |
Get the rounding mode. | |
virtual void | setRoundingMode (ERoundingMode roundingMode) |
Set the rounding mode. | |
virtual int32_t | getFormatWidth (void) const |
Get the width to which the output of format() is padded. | |
virtual void | setFormatWidth (int32_t width) |
Set the width to which the output of format() is padded. | |
virtual UnicodeString | getPadCharacterString () const |
Get the pad character used to pad to the format width. | |
virtual void | setPadCharacter (const UnicodeString &padChar) |
Set the character used to pad to the format width. | |
virtual EPadPosition | getPadPosition (void) const |
Get the position at which padding will take place. | |
virtual void | setPadPosition (EPadPosition padPos) |
Set the position at which padding will take place. | |
virtual UBool | isScientificNotation (void) |
Return whether or not scientific notation is used. | |
virtual void | setScientificNotation (UBool useScientific) |
Set whether or not scientific notation is used. | |
virtual int8_t | getMinimumExponentDigits (void) const |
Return the minimum exponent digits that will be shown. | |
virtual void | setMinimumExponentDigits (int8_t minExpDig) |
Set the minimum exponent digits that will be shown. | |
virtual UBool | isExponentSignAlwaysShown (void) |
Return whether the exponent sign is always shown. | |
virtual void | setExponentSignAlwaysShown (UBool expSignAlways) |
Set whether the exponent sign is always shown. | |
int32_t | getGroupingSize (void) const |
Return the grouping size. | |
virtual void | setGroupingSize (int32_t newValue) |
Set the grouping size. | |
int32_t | getSecondaryGroupingSize (void) const |
Return the secondary grouping size. | |
virtual void | setSecondaryGroupingSize (int32_t newValue) |
Set the secondary grouping size. | |
UBool | isDecimalSeparatorAlwaysShown (void) const |
Allows you to get the behavior of the decimal separator with integers. | |
virtual void | setDecimalSeparatorAlwaysShown (UBool newValue) |
Allows you to set the behavior of the decimal separator with integers. | |
virtual UnicodeString & | toPattern (UnicodeString &result) const |
Synthesizes a pattern string that represents the current state of this Format object. | |
virtual UnicodeString & | toLocalizedPattern (UnicodeString &result) const |
Synthesizes a localized pattern string that represents the current state of this Format object. | |
virtual void | applyPattern (const UnicodeString &pattern, UParseError &parseError, UErrorCode &status) |
Apply the given pattern to this Format object. | |
virtual void | applyPattern (const UnicodeString &pattern, UErrorCode &status) |
Sets the pattern. | |
virtual void | applyLocalizedPattern (const UnicodeString &pattern, UParseError &parseError, UErrorCode &status) |
Apply the given pattern to this Format object. | |
virtual void | applyLocalizedPattern (const UnicodeString &pattern, UErrorCode &status) |
Apply the given pattern to this Format object. | |
virtual void | setMaximumIntegerDigits (int32_t newValue) |
Sets the maximum 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. | |
virtual void | setMaximumFractionDigits (int32_t newValue) |
Sets the maximum 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. | |
int32_t | getMinimumSignificantDigits () const |
Returns the minimum number of significant digits that will be displayed. | |
int32_t | getMaximumSignificantDigits () const |
Returns the maximum number of significant digits that will be displayed. | |
void | setMinimumSignificantDigits (int32_t min) |
Sets the minimum number of significant digits that will be displayed. | |
void | setMaximumSignificantDigits (int32_t max) |
Sets the maximum number of significant digits that will be displayed. | |
UBool | areSignificantDigitsUsed () const |
Returns true if significant digits are in use, or false if integer and fraction digit counts are in use. | |
void | setSignificantDigitsUsed (UBool useSignificantDigits) |
Sets whether significant digits are in use, or integer and fraction digit counts are in use. | |
virtual void | setCurrency (const UChar *theCurrency, UErrorCode &ec) |
Sets the currency used to display currency amounts. | |
virtual void | setCurrency (const UChar *theCurrency) |
Sets the currency used to display currency amounts. | |
virtual UClassID | getDynamicClassID (void) const |
Returns a unique class ID POLYMORPHICALLY. | |
Static Public Member Functions | |
static UClassID | getStaticClassID (void) |
Return the class ID for this class. | |
Static Public Attributes | |
static const char | fgNumberPatterns [] |
The resource tags we use to retrieve decimal format data from locale resource bundles. | |
Protected Member Functions | |
virtual void | getEffectiveCurrency (UChar *result, UErrorCode &ec) const |
Returns the currency in effect for this formatter. | |
Static Protected Attributes | |
static const int32_t | kDoubleIntegerDigits |
number of integer digits | |
static const int32_t | kDoubleFractionDigits |
number of fraction digits | |
static const int32_t | kMaxScientificIntegerDigits |
When someone turns on scientific mode, we assume that more than this number of digits is due to flipping from some other mode that didn't restrict the maximum, and so we force 1 integer digit. |
It has a variety of features designed to make it possible to parse and format numbers in any locale, including support for Western, Arabic, or Indic digits. It also supports different flavors of numbers, including integers ("123"), fixed-point numbers ("123.4"), scientific notation ("1.23E4"), percentages ("12%"), and currency amounts ("$123"). All of these flavors can be easily localized.
To obtain a NumberFormat for a specific locale (including the default locale) call one of NumberFormat's factory methods such as createInstance(). Do not call the DecimalFormat constructors directly, unless you know what you are doing, since the NumberFormat factory methods may return subclasses other than DecimalFormat.
Example Usage
// Normally we would have a GUI with a menu for this int32_t locCount; const Locale* locales = NumberFormat::getAvailableLocales(locCount); double myNumber = -1234.56; UErrorCode success = U_ZERO_ERROR; NumberFormat* form; // Print out a number with the localized number, currency and percent // format for each locale. UnicodeString countryName; UnicodeString displayName; UnicodeString str; UnicodeString pattern; Formattable fmtable; for (int32_t j = 0; j < 3; ++j) { cout << endl << "FORMAT " << j << endl; for (int32_t i = 0; i < locCount; ++i) { if (locales[i].getCountry(countryName).size() == 0) { // skip language-only continue; } switch (j) { case 0: form = NumberFormat::createInstance(locales[i], success ); break; case 1: form = NumberFormat::createCurrencyInstance(locales[i], success ); break; default: form = NumberFormat::createPercentInstance(locales[i], success ); break; } if (form) { str.remove(); pattern = ((DecimalFormat*)form)->toPattern(pattern); cout << locales[i].getDisplayName(displayName) << ": " << pattern; cout << " -> " << form->format(myNumber,str) << endl; form->parse(form->format(myNumber,str), fmtable, success); delete form; } } }
Patterns
A DecimalFormat consists of a pattern and a set of symbols. The pattern may be set directly using applyPattern(), or indirectly using other API methods which manipulate aspects of the pattern, such as the minimum number of integer digits. The symbols are stored in a DecimalFormatSymbols object. When using the NumberFormat factory methods, the pattern and symbols are read from ICU's locale data.
Special Pattern Characters
Many characters in a pattern are taken literally; they are matched during parsing and output unchanged during formatting. Special characters, on the other hand, stand for other characters, strings, or classes of characters. For example, the '#' character is replaced by a localized digit. Often the replacement character is the same as the pattern character; in the U.S. locale, the ',' grouping character is replaced by ','. However, the replacement is still happening, and if the symbols are modified, the grouping character changes. Some special characters affect the behavior of the formatter by their presence; for example, if the percent character is seen, then the value is multiplied by 100 before being displayed.
To insert a special character in a pattern as a literal, that is, without any special meaning, the character must be quoted. There are some exceptions to this which are noted below.
The characters listed here are used in non-localized patterns. Localized patterns use the corresponding characters taken from this formatter's DecimalFormatSymbols object instead, and these characters lose their special status. Two exceptions are the currency sign and quote, which are not localized.
Symbol | Location | Localized? | Meaning |
0 | Number | Yes | Digit |
1-9 | Number | Yes | '1' through '9' indicate rounding. |
@ | Number | No | Significant digit |
# | Number | Yes | Digit, zero shows as absent |
. | Number | Yes | Decimal separator or monetary decimal separator |
- | Number | Yes | Minus sign |
, | Number | Yes | Grouping separator |
E | Number | Yes | Separates mantissa and exponent in scientific notation. Need not be quoted in prefix or suffix. |
+ | Exponent | Yes | Prefix positive exponents with localized plus sign. Need not be quoted in prefix or suffix. |
; | Subpattern boundary | Yes | Separates positive and negative subpatterns |
% | Prefix or suffix | Yes | Multiply by 100 and show as percentage |
\u2030 | Prefix or suffix | Yes | Multiply by 1000 and show as per mille |
¤ (\u00A4 ) | Prefix or suffix | No | Currency sign, replaced by currency symbol. If doubled, replaced by international currency symbol. If present in a pattern, the monetary decimal separator is used instead of the decimal separator. |
' | Prefix or suffix | No | Used to quote special characters in a prefix or suffix, for example, "'#'#" formats 123 to "#123" . To create a single quote itself, use two in a row: "# o''clock" . |
* | Prefix or suffix boundary | Yes | Pad escape, precedes pad character |
A DecimalFormat pattern contains a postive and negative subpattern, for example, "#,##0.00;(#,##0.00)". Each subpattern has a prefix, a numeric part, and a suffix. If there is no explicit negative subpattern, the negative subpattern is the localized minus sign prefixed to the positive subpattern. That is, "0.00" alone is equivalent to "0.00;-0.00". If there is an explicit negative subpattern, it serves only to specify the negative prefix and suffix; the number of digits, minimal digits, and other characteristics are ignored in the negative subpattern. That means that "#,##0.0#;(#)" has precisely the same result as "#,##0.0#;(#,##0.0#)".
The prefixes, suffixes, and various symbols used for infinity, digits, thousands separators, decimal separators, etc. may be set to arbitrary values, and they will appear properly during formatting. However, care must be taken that the symbols and strings do not conflict, or parsing will be unreliable. For example, either the positive and negative prefixes or the suffixes must be distinct for parse() to be able to distinguish positive from negative values. Another example is that the decimal separator and thousands separator should be distinct characters, or parsing will be impossible.
The grouping separator is a character that separates clusters of integer digits to make large numbers more legible. It commonly used for thousands, but in some locales it separates ten-thousands. The grouping size is the number of digits between the grouping separators, such as 3 for "100,000,000" or 4 for "1 0000 0000". There are actually two different grouping sizes: One used for the least significant integer digits, the primary grouping size, and one used for all others, the secondary grouping size. In most locales these are the same, but sometimes they are different. For example, if the primary grouping interval is 3, and the secondary is 2, then this corresponds to the pattern "#,##,##0", and the number 123456789 is formatted as "12,34,56,789". If a pattern contains multiple grouping separators, the interval between the last one and the end of the integer defines the primary grouping size, and the interval between the last two defines the secondary grouping size. All others are ignored, so "#,##,###,####" == "###,###,####" == "##,#,###,####".
Illegal patterns, such as "#.#.#" or "#.###,###", will cause DecimalFormat to set a failing UErrorCode.
Pattern BNF
pattern := subpattern (';' subpattern)? subpattern := prefix? number exponent? suffix? number := (integer ('.' fraction)?) | sigDigits prefix := '\u0000'..'\uFFFD' - specialCharacters suffix := '\u0000'..'\uFFFD' - specialCharacters integer := '#'* '0'* '0' fraction := '0'* '#'* sigDigits := '#'* '@' '@'* '#'* exponent := 'E' '+'? '0'* '0' padSpec := '*' padChar padChar := '\u0000'..'\uFFFD' - quote Notation: X* 0 or more instances of X X? 0 or 1 instances of X X|Y either X or Y C..D any character from C up to D, inclusive S-T characters in S, except those in TThe first subpattern is for positive numbers. The second (optional) subpattern is for negative numbers.
Not indicated in the BNF syntax above:
padSpec
may appear before the prefix, after the prefix, before the suffix, after the suffix, or not at all.
Parsing
DecimalFormat parses all Unicode characters that represent decimal digits, as defined by u_charDigitValue(). In addition, DecimalFormat also recognizes as digits the ten consecutive characters starting with the localized zero digit defined in the DecimalFormatSymbols object. During formatting, the DecimalFormatSymbols-based digits are output.
During parsing, grouping separators are ignored.
If parse(UnicodeString&,Formattable&,ParsePosition&) fails to parse a string, it leaves the parse position unchanged. The convenience method parse(UnicodeString&,Formattable&,UErrorCode&) indicates parse failure by setting a failing UErrorCode.
Formatting
Formatting is guided by several parameters, all of which can be specified either using a pattern or using the API. The following description applies to formats that do not use scientific notation or significant digits.
Special Values
NaN
is represented as a single character, typically \uFFFD
. This character is determined by the DecimalFormatSymbols object. This is the only value for which the prefixes and suffixes are not used.
Infinity is represented as a single character, typically \u221E
, with the positive or negative prefixes and suffixes applied. The infinity character is determined by the DecimalFormatSymbols object.
Numbers in scientific notation are expressed as the product of a mantissa and a power of ten, for example, 1234 can be expressed as 1.234 x 103. The mantissa is typically in the half-open interval [1.0, 10.0) or sometimes [0.0, 1.0), but it need not be. DecimalFormat supports arbitrary mantissas. DecimalFormat can be instructed to use scientific notation through the API or through the pattern. In a pattern, the exponent character immediately followed by one or more digit characters indicates scientific notation. Example: "0.###E0" formats the number 1234 as "1.234E3".
DecimalFormat
has two ways of controlling how many digits are shows: (a) significant digits counts, or (b) integer and fraction digit counts. Integer and fraction digit counts are described above. When a formatter is using significant digits counts, the number of integer and fraction digits is not specified directly, and the formatter settings for these counts are ignored. Instead, the formatter uses however many integer and fraction digits are required to display the specified number of significant digits. Examples:
Pattern | Minimum significant digits | Maximum significant digits | Number | Output of format() |
@@@ | 3 | 3 | 12345 | 12300 |
@@@ | 3 | 3 | 0.12345 | 0.123 |
@@## | 2 | 4 | 3.14159 | 3.142 |
@@## | 2 | 4 | 1.23004 | 1.23 |
'@'
and '#'
characters. The minimum number of significant digits is the number of '@'
characters. The maximum number of significant digits is the number of '@'
characters plus the number of '#'
characters following on the right. For example, the pattern "@@@"
indicates exactly 3 significant digits. The pattern "@##"
indicates from 1 to 3 significant digits. Trailing zero digits to the right of the decimal separator are suppressed after the minimum number of significant digits have been shown. For example, the pattern "@##"
formats the number 0.1203 as "0.12"
.
'0'
pattern character. Patterns such as "@00"
or "@.###"
are disallowed.
'#'
characters may be prepended to the left of the leftmost '@'
character. These have no effect on the minimum and maximum significant digits counts, but may be used to position grouping separators. For example, "#,#@#"
indicates a minimum of one significant digits, a maximum of two significant digits, and a grouping size of three.
'@'
pattern character. Alternatively, call setSignificantDigitsUsed(TRUE).
'@'
pattern character. Alternatively, call setSignificantDigitsUsed(FALSE).
getMinimumSignificantDigits() - 1
, and a maximum fraction digit count of getMaximumSignificantDigits() - 1
. For example, the pattern "@@###E0"
is equivalent to "0.0###E0"
.
Padding
DecimalFormat supports padding the result of format() to a specific width. Padding may be specified either through the API or through the pattern syntax. In a pattern the pad escape character, followed by a single pad character, causes padding to be parsed and formatted. The pad escape character is '*' in unlocalized patterns, and can be localized using DecimalFormatSymbols::setSymbol() with a DecimalFormatSymbols::kPadEscapeSymbol selector. For example, "$*x#,##0.00"
formats 123 to "$xx123.00"
, and 1234 to "$1,234.00"
.
"* #0 o''clock"
, the format width is 10.
Rounding
DecimalFormat supports rounding to a specific increment. For example, 1230 rounded to the nearest 50 is 1250. 1.234 rounded to the nearest 0.65 is 1.3. The rounding increment may be specified through the API or in a pattern. To specify a rounding increment in a pattern, include the increment in the pattern itself. "#,#50" specifies a rounding increment of 50. "#,##0.05" specifies a rounding increment of 0.05.
Synchronization
DecimalFormat objects are not synchronized. Multiple threads should not access one formatter concurrently.
Subclassing
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.
Definition at line 603 of file decimfmt.h.
Rounding mode.
Definition at line 609 of file decimfmt.h.
DecimalFormat::DecimalFormat | ( | UErrorCode & | status | ) |
Create a DecimalFormat using the default pattern and symbols for the default locale.
This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern.
To obtain standard formats for a given locale, use the factory methods on NumberFormat such as createInstance. These factories will return the most appropriate sub-class of NumberFormat for a given locale.
status | Output param set to success/failure code. If the pattern is invalid this will be set to a failure code. |
DecimalFormat::DecimalFormat | ( | const UnicodeString & | pattern, | |
UErrorCode & | status | |||
) |
Create a DecimalFormat from the given pattern and the symbols for the default locale.
This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern.
To obtain standard formats for a given locale, use the factory methods on NumberFormat such as createInstance. These factories will return the most appropriate sub-class of NumberFormat for a given locale.
pattern | A non-localized pattern string. | |
status | Output param set to success/failure code. If the pattern is invalid this will be set to a failure code. |
DecimalFormat::DecimalFormat | ( | const UnicodeString & | pattern, | |
DecimalFormatSymbols * | symbolsToAdopt, | |||
UErrorCode & | status | |||
) |
Create a DecimalFormat from the given pattern and symbols.
Use this constructor when you need to completely customize the behavior of the format.
To obtain standard formats for a given locale, use the factory methods on NumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by a NumberFormat factory method.
pattern | a non-localized pattern string | |
symbolsToAdopt | the set of symbols to be used. The caller should not delete this object after making this call. | |
status | Output param set to success/failure code. If the pattern is invalid this will be set to a failure code. |
DecimalFormat::DecimalFormat | ( | const UnicodeString & | pattern, | |
DecimalFormatSymbols * | symbolsToAdopt, | |||
UParseError & | parseError, | |||
UErrorCode & | status | |||
) |
Create a DecimalFormat from the given pattern and symbols.
Use this constructor when you need to completely customize the behavior of the format.
To obtain standard formats for a given locale, use the factory methods on NumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by a NumberFormat factory method.
pattern | a non-localized pattern string | |
symbolsToAdopt | the set of symbols to be used. The caller should not delete this object after making this call. | |
parseError | Output param to receive errors occured during parsing | |
status | Output param set to success/failure code. If the pattern is invalid this will be set to a failure code. |
DecimalFormat::DecimalFormat | ( | const UnicodeString & | pattern, | |
const DecimalFormatSymbols & | symbols, | |||
UErrorCode & | status | |||
) |
Create a DecimalFormat from the given pattern and symbols.
Use this constructor when you need to completely customize the behavior of the format.
To obtain standard formats for a given locale, use the factory methods on NumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by a NumberFormat factory method.
pattern | a non-localized pattern string | |
symbols | the set of symbols to be used | |
status | Output param set to success/failure code. If the pattern is invalid this will be set to a failure code. |
DecimalFormat::DecimalFormat | ( | const DecimalFormat & | source | ) |
virtual DecimalFormat::~DecimalFormat | ( | ) | [virtual] |
DecimalFormat& DecimalFormat::operator= | ( | const DecimalFormat & | rhs | ) |
virtual Format* DecimalFormat::clone | ( | void | ) | const [virtual] |
Clone this Format object polymorphically.
The caller owns the result and should delete it when done.
Implements Format.
Return true if the given Format objects are semantically equal.
Objects of different subclasses are considered unequal.
other | the object to be compared with. |
Reimplemented from NumberFormat.
virtual UnicodeString& DecimalFormat::format | ( | double | number, | |
UnicodeString & | appendTo, | |||
FieldPosition & | pos | |||
) | const [virtual] |
Format a double or long number using base-10 representation.
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. |
Implements NumberFormat.
Referenced by format().
virtual UnicodeString& DecimalFormat::format | ( | int32_t | number, | |
UnicodeString & | appendTo, | |||
FieldPosition & | pos | |||
) | const [virtual] |
Format a long number using base-10 representation.
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. |
Implements NumberFormat.
virtual UnicodeString& DecimalFormat::format | ( | int64_t | number, | |
UnicodeString & | appendTo, | |||
FieldPosition & | pos | |||
) | const [virtual] |
Format an int64 number using base-10 representation.
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. |
Reimplemented from NumberFormat.
virtual UnicodeString& DecimalFormat::format | ( | const Formattable & | obj, | |
UnicodeString & | appendTo, | |||
FieldPosition & | pos, | |||
UErrorCode & | status | |||
) | const [virtual] |
Format a Formattable using base-10 representation.
obj | 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 code indicating success or failure. |
Reimplemented from NumberFormat.
UnicodeString & DecimalFormat::format | ( | const Formattable & | obj, | |
UnicodeString & | appendTo, | |||
UErrorCode & | status | |||
) | const [inline] |
Redeclared NumberFormat method.
Formats an object to produce a string.
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. |
Reimplemented from NumberFormat.
Definition at line 1870 of file decimfmt.h.
References NumberFormat::format().
UnicodeString & DecimalFormat::format | ( | double | number, | |
UnicodeString & | appendTo | |||
) | const [inline] |
Redeclared NumberFormat method.
Format a double number.
number | The value to be formatted. | |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
Reimplemented from NumberFormat.
Definition at line 1879 of file decimfmt.h.
References format().
UnicodeString & DecimalFormat::format | ( | int32_t | number, | |
UnicodeString & | appendTo | |||
) | const [inline] |
Redeclared NumberFormat method.
Format a long number. These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.
number | The value to be formatted. | |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
Reimplemented from NumberFormat.
Definition at line 1886 of file decimfmt.h.
References format().
UnicodeString& DecimalFormat::format | ( | int64_t | number, | |
UnicodeString & | appendTo | |||
) | const |
Redeclared NumberFormat method.
Format an int64 number. These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.
number | The value to be formatted. | |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
Reimplemented from NumberFormat.
virtual void DecimalFormat::parse | ( | const UnicodeString & | text, | |
Formattable & | result, | |||
ParsePosition & | parsePosition | |||
) | const [virtual] |
Parse the given string using this object's choices.
The method does string comparisons to try to find an optimal match. If no object can be parsed, index is unchanged, and NULL is returned. The result is returned as the most parsimonious type of Formattable that will accomodate all of the necessary precision. For example, if the result is exactly 12, it will be returned as a long. However, if it is 1.5, it will be returned as a double.
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. |
Implements NumberFormat.
virtual void DecimalFormat::parse | ( | const UnicodeString & | text, | |
Formattable & | result, | |||
UErrorCode & | status | |||
) | const [virtual] |
Parse the given string using this object's choices.
text | The text to be parsed. | |
result | Formattable to be set to the parse result. | |
status | Output parameter filled in with success or failure status. |
Reimplemented from NumberFormat.
virtual Formattable& DecimalFormat::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.
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. |
Reimplemented from NumberFormat.
virtual const DecimalFormatSymbols* DecimalFormat::getDecimalFormatSymbols | ( | void | ) | const [virtual] |
Returns the decimal format symbols, which is generally not changed by the programmer or user.
virtual void DecimalFormat::adoptDecimalFormatSymbols | ( | DecimalFormatSymbols * | symbolsToAdopt | ) | [virtual] |
Sets the decimal format symbols, which is generally not changed by the programmer or user.
symbolsToAdopt | DecimalFormatSymbols to be adopted. |
virtual void DecimalFormat::setDecimalFormatSymbols | ( | const DecimalFormatSymbols & | symbols | ) | [virtual] |
Sets the decimal format symbols, which is generally not changed by the programmer or user.
symbols | DecimalFormatSymbols. |
UnicodeString& DecimalFormat::getPositivePrefix | ( | UnicodeString & | result | ) | const |
Get the positive prefix.
result | Output param which will receive the positive prefix. |
virtual void DecimalFormat::setPositivePrefix | ( | const UnicodeString & | newValue | ) | [virtual] |
Set the positive prefix.
newValue | the new value of the the positive prefix to be set. Examples: +123, $123, sFr123 |
UnicodeString& DecimalFormat::getNegativePrefix | ( | UnicodeString & | result | ) | const |
Get the negative prefix.
result | Output param which will receive the negative prefix. |
virtual void DecimalFormat::setNegativePrefix | ( | const UnicodeString & | newValue | ) | [virtual] |
Set the negative prefix.
newValue | the new value of the the negative prefix to be set. Examples: -123, ($123) (with negative suffix), sFr-123 |
UnicodeString& DecimalFormat::getPositiveSuffix | ( | UnicodeString & | result | ) | const |
Get the positive suffix.
result | Output param which will receive the positive suffix. |
virtual void DecimalFormat::setPositiveSuffix | ( | const UnicodeString & | newValue | ) | [virtual] |
Set the positive suffix.
newValue | the new value of the positive suffix to be set. Example: 123% |
UnicodeString& DecimalFormat::getNegativeSuffix | ( | UnicodeString & | result | ) | const |
Get the negative suffix.
result | Output param which will receive the negative suffix. |
virtual void DecimalFormat::setNegativeSuffix | ( | const UnicodeString & | newValue | ) | [virtual] |
Set the negative suffix.
newValue | the new value of the negative suffix to be set. Examples: 123% |
int32_t DecimalFormat::getMultiplier | ( | void | ) | const |
Get the multiplier for use in percent, permill, etc.
For a percentage, set the suffixes to have "%" and the multiplier to be 100. (For Arabic, use arabic percent symbol). For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000.
virtual void DecimalFormat::setMultiplier | ( | int32_t | newValue | ) | [virtual] |
Set the multiplier for use in percent, permill, etc.
For a percentage, set the suffixes to have "%" and the multiplier to be 100. (For Arabic, use arabic percent symbol). For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000.
newValue | the new value of the multiplier for use in percent, permill, etc. Examples: with 100, 1.23 -> "123", and "123" -> 1.23 |
virtual double DecimalFormat::getRoundingIncrement | ( | void | ) | const [virtual] |
Get the rounding increment.
virtual void DecimalFormat::setRoundingIncrement | ( | double | newValue | ) | [virtual] |
Set the rounding increment.
This method also controls whether rounding is enabled.
newValue | A positive rounding increment, or 0.0 to disable rounding. Negative increments are equivalent to 0.0. |
virtual ERoundingMode DecimalFormat::getRoundingMode | ( | void | ) | const [virtual] |
virtual void DecimalFormat::setRoundingMode | ( | ERoundingMode | roundingMode | ) | [virtual] |
Set the rounding mode.
This has no effect unless the rounding increment is greater than zero.
roundingMode | A rounding mode |
virtual int32_t DecimalFormat::getFormatWidth | ( | void | ) | const [virtual] |
virtual void DecimalFormat::setFormatWidth | ( | int32_t | width | ) | [virtual] |
Set the width to which the output of format() is padded.
The width is counted in 16-bit code units. This method also controls whether padding is enabled.
width | the width to which to pad the result of format(), or zero to disable padding. A negative width is equivalent to 0. |
virtual UnicodeString DecimalFormat::getPadCharacterString | ( | ) | const [virtual] |
Get the pad character used to pad to the format width.
The default is ' '.
virtual void DecimalFormat::setPadCharacter | ( | const UnicodeString & | padChar | ) | [virtual] |
Set the character used to pad to the format width.
If padding is not enabled, then this will take effect if padding is later enabled.
padChar | a string containing the pad charcter. If the string has length 0, then the pad characer is set to ' '. Otherwise padChar.char32At(0) will be used as the pad character. |
virtual EPadPosition DecimalFormat::getPadPosition | ( | void | ) | const [virtual] |
Get the position at which padding will take place.
This is the location at which padding will be inserted if the result of format() is shorter than the format width.
virtual void DecimalFormat::setPadPosition | ( | EPadPosition | padPos | ) | [virtual] |
Set the position at which padding will take place.
This is the location at which padding will be inserted if the result of format() is shorter than the format width. This has no effect unless padding is enabled.
padPos | the pad position, one of kPadBeforePrefix, kPadAfterPrefix, kPadBeforeSuffix, or kPadAfterSuffix. |
virtual UBool DecimalFormat::isScientificNotation | ( | void | ) | [virtual] |
Return whether or not scientific notation is used.
virtual void DecimalFormat::setScientificNotation | ( | UBool | useScientific | ) | [virtual] |
Set whether or not scientific notation is used.
When scientific notation is used, the effective maximum number of integer digits is <= 8. If the maximum number of integer digits is set to more than 8, the effective maximum will be 1. This allows this call to generate a 'default' scientific number format without additional changes.
useScientific | TRUE if this object formats and parses scientific notation |
virtual int8_t DecimalFormat::getMinimumExponentDigits | ( | void | ) | const [virtual] |
Return the minimum exponent digits that will be shown.
virtual void DecimalFormat::setMinimumExponentDigits | ( | int8_t | minExpDig | ) | [virtual] |
Set the minimum exponent digits that will be shown.
This has no effect unless scientific notation is in use.
minExpDig | a value >= 1 indicating the fewest exponent digits that will be shown. Values less than 1 will be treated as 1. |
virtual UBool DecimalFormat::isExponentSignAlwaysShown | ( | void | ) | [virtual] |
Return whether the exponent sign is always shown.
virtual void DecimalFormat::setExponentSignAlwaysShown | ( | UBool | expSignAlways | ) | [virtual] |
Set whether the exponent sign is always shown.
This has no effect unless scientific notation is in use.
expSignAlways | TRUE if the exponent is always prefixed with either the localized minus sign or the localized plus sign, false if only negative exponents are prefixed with the localized minus sign. |
int32_t DecimalFormat::getGroupingSize | ( | void | ) | const |
Return the grouping size.
Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3.
DecimalFormatSymbols::getGroupingSeparator
virtual void DecimalFormat::setGroupingSize | ( | int32_t | newValue | ) | [virtual] |
Set the grouping size.
Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3.
newValue | the new value of the grouping size. |
DecimalFormatSymbols::setGroupingSeparator
int32_t DecimalFormat::getSecondaryGroupingSize | ( | void | ) | const |
Return the secondary grouping size.
In some locales one grouping interval is used for the least significant integer digits (the primary grouping size), and another is used for all others (the secondary grouping size). A formatter supporting a secondary grouping size will return a positive integer unequal to the primary grouping size returned by getGroupingSize(). For example, if the primary grouping size is 4, and the secondary grouping size is 2, then the number 123456789 formats as "1,23,45,6789", and the pattern appears as "#,##,###0".
DecimalFormatSymbols::getGroupingSeparator
virtual void DecimalFormat::setSecondaryGroupingSize | ( | int32_t | newValue | ) | [virtual] |
Set the secondary grouping size.
If set to a value less than 1, then secondary grouping is turned off, and the primary grouping size is used for all intervals, not just the least significant.
newValue | the new value of the secondary grouping size. |
DecimalFormatSymbols::setGroupingSeparator
UBool DecimalFormat::isDecimalSeparatorAlwaysShown | ( | void | ) | const |
Allows you to get the behavior of the decimal separator with integers.
(The decimal separator will always appear with decimals.)
virtual void DecimalFormat::setDecimalSeparatorAlwaysShown | ( | UBool | newValue | ) | [virtual] |
Allows you to set the behavior of the decimal separator with integers.
(The decimal separator will always appear with decimals.)
newValue | set TRUE if the decimal separator will always appear with decimals. Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345 |
virtual UnicodeString& DecimalFormat::toPattern | ( | UnicodeString & | result | ) | const [virtual] |
Synthesizes a pattern string that represents the current state of this Format object.
result | Output param which will receive the pattern. Previous contents are deleted. |
virtual UnicodeString& DecimalFormat::toLocalizedPattern | ( | UnicodeString & | result | ) | const [virtual] |
Synthesizes a localized pattern string that represents the current state of this Format object.
result | Output param which will receive the localized pattern. Previous contents are deleted. |
virtual void DecimalFormat::applyPattern | ( | const UnicodeString & | pattern, | |
UParseError & | parseError, | |||
UErrorCode & | status | |||
) | [virtual] |
Apply the given pattern to this Format object.
A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.
There is no limit to integer digits are set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon
. Example "#,#00.0#" -> 1,234.56This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.
. Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses.In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.
pattern | The pattern to be applied. | |
parseError | Struct to recieve information on position of error if an error is encountered | |
status | Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result. |
virtual void DecimalFormat::applyPattern | ( | const UnicodeString & | pattern, | |
UErrorCode & | status | |||
) | [virtual] |
Sets the pattern.
pattern | The pattern to be applied. | |
status | Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result. |
virtual void DecimalFormat::applyLocalizedPattern | ( | const UnicodeString & | pattern, | |
UParseError & | parseError, | |||
UErrorCode & | status | |||
) | [virtual] |
Apply the given pattern to this Format object.
The pattern is assumed to be in a localized notation. A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.
There is no limit to integer digits are set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon
. Example "#,#00.0#" -> 1,234.56This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.
Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses.
In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.
pattern | The localized pattern to be applied. | |
parseError | Struct to recieve information on position of error if an error is encountered | |
status | Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result. |
virtual void DecimalFormat::applyLocalizedPattern | ( | const UnicodeString & | pattern, | |
UErrorCode & | status | |||
) | [virtual] |
virtual void DecimalFormat::setMaximumIntegerDigits | ( | int32_t | newValue | ) | [virtual] |
Sets the maximum number of digits allowed in the integer portion of a number.
This override limits the integer digit count to 309.
newValue | the new value of the maximum number of digits allowed in the integer portion of a number. |
Reimplemented from NumberFormat.
virtual void DecimalFormat::setMinimumIntegerDigits | ( | int32_t | newValue | ) | [virtual] |
Sets the minimum number of digits allowed in the integer portion of a number.
This override limits the integer digit count to 309.
newValue | the new value of the minimum number of digits allowed in the integer portion of a number. |
Reimplemented from NumberFormat.
virtual void DecimalFormat::setMaximumFractionDigits | ( | int32_t | newValue | ) | [virtual] |
Sets the maximum number of digits allowed in the fraction portion of a number.
This override limits the fraction digit count to 340.
newValue | the new value of the maximum number of digits allowed in the fraction portion of a number. |
Reimplemented from NumberFormat.
virtual void DecimalFormat::setMinimumFractionDigits | ( | int32_t | newValue | ) | [virtual] |
Sets the minimum number of digits allowed in the fraction portion of a number.
This override limits the fraction digit count to 340.
newValue | the new value of the minimum number of digits allowed in the fraction portion of a number. |
Reimplemented from NumberFormat.
int32_t DecimalFormat::getMinimumSignificantDigits | ( | ) | const |
Returns the minimum number of significant digits that will be displayed.
This value has no effect unless areSignificantDigitsUsed() returns true.
int32_t DecimalFormat::getMaximumSignificantDigits | ( | ) | const |
Returns the maximum number of significant digits that will be displayed.
This value has no effect unless areSignificantDigitsUsed() returns true.
void DecimalFormat::setMinimumSignificantDigits | ( | int32_t | min | ) |
Sets the minimum number of significant digits that will be displayed.
If min
is less than one then it is set to one. If the maximum significant digits count is less than min
, then it is set to min
. This value has no effect unless areSignificantDigits() returns true.
min | the fewest significant digits to be shown |
void DecimalFormat::setMaximumSignificantDigits | ( | int32_t | max | ) |
Sets the maximum number of significant digits that will be displayed.
If max
is less than one then it is set to one. If the minimum significant digits count is greater than max
, then it is set to max
. This value has no effect unless areSignificantDigits() returns true.
max | the most significant digits to be shown |
UBool DecimalFormat::areSignificantDigitsUsed | ( | ) | const |
Returns true if significant digits are in use, or false if integer and fraction digit counts are in use.
void DecimalFormat::setSignificantDigitsUsed | ( | UBool | useSignificantDigits | ) |
Sets whether significant digits are in use, or integer and fraction digit counts are in use.
useSignificantDigits | true to use significant digits, or false to use integer and fraction digit counts |
virtual void DecimalFormat::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 through the application of a new pattern.
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 |
Reimplemented from NumberFormat.
virtual void DecimalFormat::setCurrency | ( | const UChar * | theCurrency | ) | [virtual] |
Sets the currency used to display currency amounts.
See setCurrency(const UChar*, UErrorCode&).
static UClassID DecimalFormat::getStaticClassID | ( | void | ) | [static] |
Return the class ID for this class.
This is useful only for comparing to a return value from getDynamicClassID(). For example:
. Base* polymorphic_pointer = createPolymorphicObject(); . if (polymorphic_pointer->getDynamicClassID() == . Derived::getStaticClassID()) ...
Reimplemented from NumberFormat.
virtual UClassID DecimalFormat::getDynamicClassID | ( | void | ) | const [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.
Implements NumberFormat.
virtual void DecimalFormat::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 "".
Reimplemented from NumberFormat.
const char DecimalFormat::fgNumberPatterns[] [static] |
The resource tags we use to retrieve decimal format data from locale resource bundles.
Definition at line 1623 of file decimfmt.h.
const int32_t DecimalFormat::kDoubleIntegerDigits [static, protected] |
const int32_t DecimalFormat::kDoubleFractionDigits [static, protected] |
const int32_t DecimalFormat::kMaxScientificIntegerDigits [static, protected] |
When someone turns on scientific mode, we assume that more than this number of digits is due to flipping from some other mode that didn't restrict the maximum, and so we force 1 integer digit.
We don't bother to track and see if someone is using exponential notation with more than this number, it wouldn't make sense anyway, and this is just to make sure that someone turning on scientific mode with default settings doesn't end up with lots of zeroes.
Definition at line 1866 of file decimfmt.h.