ICU 52.1  52.1
compactdecimalformat.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 2012-2013, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ********************************************************************************
6 *
7 * File COMPACTDECIMALFORMAT.H
8 ********************************************************************************
9 */
10 
11 #ifndef __COMPACT_DECIMAL_FORMAT_H__
12 #define __COMPACT_DECIMAL_FORMAT_H__
13 
14 #include "unicode/utypes.h"
20 #if !UCONFIG_NO_FORMATTING
21 #ifndef U_HIDE_DRAFT_API
22 
23 #include "unicode/decimfmt.h"
24 
25 struct UHashtable;
26 
28 
29 class PluralRules;
30 
54 public:
55 
63  static CompactDecimalFormat* U_EXPORT2 createInstance(
64  const Locale& inLocale, UNumberCompactStyle style, UErrorCode& status);
65 
73 
78  virtual ~CompactDecimalFormat();
79 
87 
95  virtual Format* clone() const;
96 
105  virtual UBool operator==(const Format& other) const;
106 
107 
108  using DecimalFormat::format;
109 
121  virtual UnicodeString& format(double number,
122  UnicodeString& appendTo,
123  FieldPosition& pos) const;
124 
139  virtual UnicodeString& format(double number,
140  UnicodeString& appendTo,
141  FieldPositionIterator* posIter,
142  UErrorCode& status) const;
143 
155  virtual UnicodeString& format(int64_t number,
156  UnicodeString& appendTo,
157  FieldPosition& pos) const;
158 
173  virtual UnicodeString& format(int64_t number,
174  UnicodeString& appendTo,
175  FieldPositionIterator* posIter,
176  UErrorCode& status) const;
177 
194  virtual UnicodeString& format(const StringPiece &number,
195  UnicodeString& appendTo,
196  FieldPositionIterator* posIter,
197  UErrorCode& status) const;
198 
214  virtual UnicodeString& format(const DigitList &number,
215  UnicodeString& appendTo,
216  FieldPositionIterator* posIter,
217  UErrorCode& status) const;
218 
234  virtual UnicodeString& format(const DigitList &number,
235  UnicodeString& appendTo,
236  FieldPosition& pos,
237  UErrorCode& status) const;
238 
248  virtual void parse(const UnicodeString& text,
249  Formattable& result,
250  ParsePosition& parsePosition) const;
251 
261  virtual void parse(const UnicodeString& text,
262  Formattable& result,
263  UErrorCode& status) const;
264 
265 /* Cannot use #ifndef U_HIDE_INTERNAL_API for the following draft method since it is virtual */
286  virtual CurrencyAmount* parseCurrency(const UnicodeString& text,
287  ParsePosition& pos) const;
288 
300  static UClassID U_EXPORT2 getStaticClassID();
301 
313  virtual UClassID getDynamicClassID() const;
314 
315 private:
316 
317  const UHashtable* _unitsByVariant;
318  const double* _divisors;
319  PluralRules* _pluralRules;
320 
321  // Default constructor not implemented.
322  CompactDecimalFormat(const DecimalFormat &, const UHashtable* unitsByVariant, const double* divisors, PluralRules* pluralRules);
323 
324  UBool eqHelper(const CompactDecimalFormat& that) const;
325 };
326 
328 
329 #endif /* U_HIDE_DRAFT_API */
330 #endif /* #if !UCONFIG_NO_FORMATTING */
331 
332 #endif // __COMPACT_DECIMAL_FORMAT_H__
333 //eof
Base class for all formats.
Definition: format.h:94
DecimalFormat & operator=(const DecimalFormat &rhs)
Assignment operator.
DecimalFormat is a concrete subclass of NumberFormat that formats decimal numbers.
Definition: decimfmt.h:663
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:91
static NumberFormat * createInstance(UErrorCode &)
Returns the default number format for the current default locale.
Defines rules for mapping non-negative numeric values onto a small set of keywords.
Definition: plurrule.h:190
The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will limi...
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:358
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...
Definition: fpositer.h:53
virtual UClassID getDynamicClassID(void) const
Returns a unique class ID POLYMORPHICALLY.
virtual CurrencyAmount * parseCurrency(const UnicodeString &text, ParsePosition &pos) const
Parses text from the given string as a currency amount.
virtual UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos) const
Format a double or long number using base-10 representation.
virtual Format * clone(void) const
Clone this Format object polymorphically.
static UClassID getStaticClassID(void)
Return the class ID for this class.
virtual void parse(const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const
Parse the given string using this object's choices.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
UNumberCompactStyle
Constants for specifying short or long format.
Definition: unum.h:260
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition: fieldpos.h:106
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:47
virtual UBool operator==(const Format &other) const
Return true if the given Format objects are semantically equal.
C++ API: Formats decimal numbers.
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:245
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:66
A string-like object that points to a sized piece of memory.
Definition: stringpiece.h:52
A currency together with a numeric amount, such as 200 USD.
Definition: curramt.h:35
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:185