ICU 78.1 78.1 |
Formattable objects can be passed to theFormat class or its subclasses for formatting.More...
#include <fmtable.h>

Public Types | |
| enum | ISDATE {kIsDate } |
| This enum is only used to let callers distinguish between theFormattable(UDate) constructor and theFormattable(double) constructor; the compiler cannot distinguish the signatures, since UDate is currently typedefed to be either double or long.More... | |
| enum | Type { kDate,kDouble,kLong,kString, kArray,kInt64,kObject } |
| Selector for flavor of data type contained within aFormattable object.More... | |
Public Member Functions | |
| Formattable () | |
| Default constructor.More... | |
| Formattable (UDate d,ISDATE flag) | |
| Creates aFormattable object with a UDate instance.More... | |
| Formattable (double d) | |
| Creates aFormattable object with a double number.More... | |
| Formattable (int32_t l) | |
| Creates aFormattable object with a long number.More... | |
| Formattable (int64_t ll) | |
| Creates aFormattable object with an int64_t number.More... | |
| Formattable (const char *strToCopy) | |
| Creates aFormattable object with a char string pointer.More... | |
| Formattable (StringPiece number,UErrorCode &status) | |
| Creates aFormattable object of an appropriate numeric type from a a decimal number in string form.More... | |
| Formattable (constUnicodeString &strToCopy) | |
| Creates aFormattable object with aUnicodeString object to copy from.More... | |
| Formattable (UnicodeString *strToAdopt) | |
| Creates aFormattable object with aUnicodeString object to adopt from.More... | |
| Formattable (constFormattable *arrayToCopy, int32_t count) | |
| Creates aFormattable object with an array ofFormattable objects.More... | |
| Formattable (UObject *objectToAdopt) | |
| Creates aFormattable object that adopts the givenUObject.More... | |
| Formattable (constFormattable &) | |
| Copy constructor.More... | |
| Formattable & | operator= (constFormattable &rhs) |
| Assignment operator.More... | |
| bool | operator== (constFormattable &other) const |
| Equality comparison.More... | |
| bool | operator!= (constFormattable &other) const |
| Equality operator.More... | |
| virtual | ~Formattable () |
| Destructor.More... | |
| Formattable * | clone () const |
| Clone this object.More... | |
| Type | getType () const |
| Gets the data type of thisFormattable object.More... | |
| UBool | isNumeric () const |
| Returns true if the data type of thisFormattable object is kDouble, kLong, or kInt64.More... | |
| double | getDouble () const |
| Gets the double value of this object.More... | |
| double | getDouble (UErrorCode &status) const |
| Gets the double value of this object.More... | |
| int32_t | getLong () const |
| Gets the long value of this object.More... | |
| int32_t | getLong (UErrorCode &status) const |
| Gets the long value of this object.More... | |
| int64_t | getInt64 () const |
| Gets the int64 value of this object.More... | |
| int64_t | getInt64 (UErrorCode &status) const |
| Gets the int64 value of this object.More... | |
| UDate | getDate () const |
| Gets the Date value of this object.More... | |
| UDate | getDate (UErrorCode &status) const |
| Gets the Date value of this object.More... | |
| UnicodeString & | getString (UnicodeString &result) const |
| Gets the string value of this object.More... | |
| UnicodeString & | getString (UnicodeString &result,UErrorCode &status) const |
| Gets the string value of this object.More... | |
| constUnicodeString & | getString () const |
| Gets a const reference to the string value of this object.More... | |
| constUnicodeString & | getString (UErrorCode &status) const |
| Gets a const reference to the string value of this object.More... | |
| UnicodeString & | getString () |
| Gets a reference to the string value of this object.More... | |
| UnicodeString & | getString (UErrorCode &status) |
| Gets a reference to the string value of this object.More... | |
| constFormattable * | getArray (int32_t &count) const |
| Gets the array value and count of this object.More... | |
| constFormattable * | getArray (int32_t &count,UErrorCode &status) const |
| Gets the array value and count of this object.More... | |
| Formattable & | operator[] (int32_t index) |
| Accesses the specified element in the array value of thisFormattable object.More... | |
| constUObject * | getObject () const |
| Returns a pointer to theUObject contained within this formattable, or nullptr if this object does not contain aUObject.More... | |
| StringPiece | getDecimalNumber (UErrorCode &status) |
| Returns a numeric string representation of the number contained within this formattable, or nullptr if this object does not contain numeric type.More... | |
| void | setDouble (double d) |
| Sets the double value of this object and changes the type to kDouble.More... | |
| void | setLong (int32_t l) |
| Sets the long value of this object and changes the type to kLong.More... | |
| void | setInt64 (int64_t ll) |
| Sets the int64 value of this object and changes the type to kInt64.More... | |
| void | setDate (UDate d) |
| Sets the Date value of this object and changes the type to kDate.More... | |
| void | setString (constUnicodeString &stringToCopy) |
| Sets the string value of this object and changes the type to kString.More... | |
| void | setArray (constFormattable *array, int32_t count) |
| Sets the array value and count of this object and changes the type to kArray.More... | |
| void | adoptString (UnicodeString *stringToAdopt) |
| Sets and adopts the string value and count of this object and changes the type to kArray.More... | |
| void | adoptArray (Formattable *array, int32_t count) |
| Sets and adopts the array value and count of this object and changes the type to kArray.More... | |
| void | adoptObject (UObject *objectToAdopt) |
| Sets and adopts theUObject value of this object and changes the type to kObject.More... | |
| void | setDecimalNumber (StringPiece numberString,UErrorCode &status) |
| Sets the numeric value from a decimal number string, and changes the type to to a numeric type appropriate for the number.More... | |
| virtualUClassID | getDynamicClassID () const override |
| ICU "poor man's RTTI", returns a UClassID for the actual class.More... | |
| UFormattable * | toUFormattable () |
| Convert this object pointer to a UFormattable.More... | |
| constUFormattable * | toUFormattable () const |
| Convert this object pointer to a UFormattable.More... | |
| int32_t | getLong (UErrorCode *status) const |
| Deprecated variant of getLong(UErrorCode&).More... | |
| number::impl::DecimalQuantity * | getDecimalQuantity () const |
| Internal function, do not use.More... | |
| void | populateDecimalQuantity (number::impl::DecimalQuantity &output,UErrorCode &status) const |
| Export the value of thisFormattable to a DecimalQuantity.More... | |
| void | adoptDecimalQuantity (number::impl::DecimalQuantity *dq) |
| Adopt, and set value from, a DecimalQuantity Internal Function, do not use.More... | |
| FixedString * | internalGetFixedString (UErrorCode &status) |
| Internal function to return the FixedString pointer.More... | |
Public Member Functions inherited fromicu::UObject | |
| virtual | ~UObject () |
| Destructor.More... | |
Static Public Member Functions | |
| staticUClassID | getStaticClassID () |
| ICU "poor man's RTTI", returns a UClassID for this class.More... | |
| staticFormattable * | fromUFormattable (UFormattable *fmt) |
| Convert the UFormattable to aFormattable.More... | |
| static constFormattable * | fromUFormattable (constUFormattable *fmt) |
| Convert the const UFormattable to a constFormattable.More... | |
Formattable objects can be passed to theFormat class or its subclasses for formatting.
Formattable is a thin wrapper class which interconverts between the primitive numeric types (double, long, etc.) as well as UDate andUnicodeString.
Internally, aFormattable object is a union of primitive types. As such, it can only store one flavor of data at a time. To determine what flavor of data it contains, use the getType method.
As of ICU 3.0,Formattable may also wrap aUObject pointer, which it owns. This allows an instance of any ICU class to be encapsulated in aFormattable. For legacy reasons and for efficiency, primitive numeric types are still stored directly within aFormattable.
TheFormattable class is not suitable for subclassing.
See UFormattable for a C wrapper.
This enum is only used to let callers distinguish between theFormattable(UDate) constructor and theFormattable(double) constructor; the compiler cannot distinguish the signatures, since UDate is currently typedefed to be either double or long.
If UDate is changed later to be a bonafide class or struct, then we no longer need this enum.
Selector for flavor of data type contained within aFormattable object.
Formattable is a union of several different types, and at any time contains exactly one type.
| Enumerator | |
|---|---|
| kDate | Selector indicating a UDate value. Use getDate to retrieve the value.
|
| kDouble | Selector indicating a double value. Use getDouble to retrieve the value.
|
| kLong | Selector indicating a 32-bit integer value. Use getLong to retrieve the value.
|
| kString | Selector indicating aUnicodeString value. Use getString to retrieve the value.
|
| kArray | Selector indicating an array of Formattables. Use getArray to retrieve the value.
|
| kInt64 | Selector indicating a 64-bit integer value. Use getInt64 to retrieve the value.
|
| kObject | Selector indicating aUObject value. Use getObject to retrieve the value.
|
| icu::Formattable::Formattable | ( | ) |
Default constructor.
Creates aFormattable object with a UDate instance.
| d | the UDate instance. |
| flag | the flag to indicate this is a date. Always set it to kIsDate |
| icu::Formattable::Formattable | ( | double | d | ) |
| icu::Formattable::Formattable | ( | int32_t | l | ) |
| icu::Formattable::Formattable | ( | int64_t | ll | ) |
| icu::Formattable::Formattable | ( | const char * | strToCopy | ) |
Creates aFormattable object with a char string pointer.
Assumes that the char string is null terminated.
| strToCopy | the char string. |
| icu::Formattable::Formattable | ( | StringPiece | number, |
| UErrorCode & | status | ||
| ) |
Creates aFormattable object of an appropriate numeric type from a a decimal number in string form.
TheFormattable will retain the full precision of the input in decimal format, even when it exceeds what can be represented by a double or int64_t.
| number | the unformatted (not localized) string representation of the Decimal number. |
| status | the error code. Possible errors include U_INVALID_FORMAT_ERROR if the format of the string does not conform to that of a decimal number. |
| icu::Formattable::Formattable | ( | constUnicodeString & | strToCopy | ) |
Creates aFormattable object with aUnicodeString object to copy from.
| strToCopy | theUnicodeString string. |
| icu::Formattable::Formattable | ( | UnicodeString * | strToAdopt | ) |
Creates aFormattable object with aUnicodeString object to adopt from.
| strToAdopt | theUnicodeString string. |
| icu::Formattable::Formattable | ( | constFormattable * | arrayToCopy, |
| int32_t | count | ||
| ) |
Creates aFormattable object with an array ofFormattable objects.
| arrayToCopy | theFormattable object array. |
| count | the array count. |
| icu::Formattable::Formattable | ( | UObject * | objectToAdopt | ) |
Creates aFormattable object that adopts the givenUObject.
| objectToAdopt | theUObject to set this object to |
| icu::Formattable::Formattable | ( | constFormattable & | ) |
Copy constructor.
| virtual |
Destructor.
| void icu::Formattable::adoptArray | ( | Formattable * | array, |
| int32_t | count | ||
| ) |
Sets and adopts the array value and count of this object and changes the type to kArray.
| void icu::Formattable::adoptDecimalQuantity | ( | number::impl::DecimalQuantity * | dq | ) |
Adopt, and set value from, a DecimalQuantity Internal Function, do not use.
| dq | the DecimalQuantity to be adopted |
| void icu::Formattable::adoptObject | ( | UObject * | objectToAdopt | ) |
| void icu::Formattable::adoptString | ( | UnicodeString * | stringToAdopt | ) |
Sets and adopts the string value and count of this object and changes the type to kArray.
| stringToAdopt | the new string value to be adopted. |
| Formattable* icu::Formattable::clone | ( | ) | const |
Clone this object.
Clones can be used concurrently in multiple threads. If an error occurs, then nullptr is returned. The caller must delete the clone.
| inlinestatic |
Convert the const UFormattable to a constFormattable.
Internally, this is a reinterpret_cast.
| fmt | a valid UFormattable |
| inlinestatic |
Convert the UFormattable to aFormattable.
Internally, this is a reinterpret_cast.
| fmt | a valid UFormattable |
| inline |
| constFormattable* icu::Formattable::getArray | ( | int32_t & | count, |
| UErrorCode & | status | ||
| ) | const |
Gets the array value and count of this object.
If the type is not an array, status is set to U_INVALID_FORMAT_ERROR, count is set to 0, and the result is nullptr.
| count | fill-in with the count of this object. |
| status | the error code. |
| inline |
| inline |
Gets the Date value of this object.
If the type is not a date, status is set to U_INVALID_FORMAT_ERROR and the return value is undefined.
| status | the error code. |
Definition at line711 of filefmtable.h.
ReferencesU_INVALID_FORMAT_ERROR, andU_SUCCESS.
| StringPiece icu::Formattable::getDecimalNumber | ( | UErrorCode & | status | ) |
Returns a numeric string representation of the number contained within this formattable, or nullptr if this object does not contain numeric type.
For values obtained by parsing, the returned decimal number retains the full precision and range of the original input, unconstrained by the limits of a double floating point or a 64 bit int.
This function is not thread safe, and therefore is not declared const, even though it is logically const.
Possible errors include U_MEMORY_ALLOCATION_ERROR, and U_INVALID_STATE if the formattable object has not been set to a numeric type.
| status | the error code. |
| inline |
Internal function, do not use.
TODO: figure out how to make this be non-public.NumberFormat::format(Formattable, ... needs to get at the DecimalQuantity, if it exists, for big decimal formatting.
| inline |
| double icu::Formattable::getDouble | ( | UErrorCode & | status | ) | const |
Gets the double value of this object.
If this object is of type long, int64 or Decimal Number then a conversion is performed, with possible loss of precision. If the type is kObject and the object is aMeasure, then the result of getNumber().getDouble(status) is returned. If this object is neither a numeric type nor aMeasure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR.
| status | the error code |
| overridevirtual |
ICU "poor man's RTTI", returns a UClassID for the actual class.
Reimplemented fromicu::UObject.
| inline |
| int64_t icu::Formattable::getInt64 | ( | UErrorCode & | status | ) | const |
Gets the int64 value of this object.
If this object is of a numeric type and the magnitude is too large to fit in an int64, then the maximum or minimum int64 value, as appropriate, is returned and the status is set to U_INVALID_FORMAT_ERROR. If the magnitude fits in an int64, then a casting conversion is performed, with truncation of any fractional part. If the type is kObject and the object is aMeasure, then the result of getNumber().getDouble(status) is returned. If this object is neither a numeric type nor aMeasure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR.
| status | the error code |
| inline |
| int32_t icu::Formattable::getLong | ( | UErrorCode & | status | ) | const |
Gets the long value of this object.
If the magnitude is too large to fit in a long, then the maximum or minimum long value, as appropriate, is returned and the status is set to U_INVALID_FORMAT_ERROR. If this object is of type kInt64 and it fits within a long, then no precision is lost. If it is of type kDouble, then a conversion is performed, with truncation of any fractional part. If the type is kObject and the object is aMeasure, then the result of getNumber().getLong(status) is returned. If this object is neither a numeric type nor aMeasure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR.
| status | the error code |
| inline |
Deprecated variant of getLong(UErrorCode&).
| status | the error code |
| constUObject* icu::Formattable::getObject | ( | ) | const |
| static |
ICU "poor man's RTTI", returns a UClassID for this class.
| inline |
| inline |
| UnicodeString& icu::Formattable::getString | ( | UErrorCode & | status | ) |
Gets a reference to the string value of this object.
If the type is not a string, status is set to U_INVALID_FORMAT_ERROR and the result is a bogus string.
| status | the error code. |
| constUnicodeString& icu::Formattable::getString | ( | UErrorCode & | status | ) | const |
Gets a const reference to the string value of this object.
If the type is not a string, status is set to U_INVALID_FORMAT_ERROR and the result is a bogus string.
| status | the error code. |
| inline |
| UnicodeString& icu::Formattable::getString | ( | UnicodeString & | result, |
| UErrorCode & | status | ||
| ) | const |
Gets the string value of this object.
If the type is not a string, status is set to U_INVALID_FORMAT_ERROR and a bogus string is returned.
| result | Output param to receive the Date value of this object. |
| status | the error code. |
| Type icu::Formattable::getType | ( | ) | const |
Gets the data type of thisFormattable object.
| FixedString* icu::Formattable::internalGetFixedString | ( | UErrorCode & | status | ) |
Internal function to return the FixedString pointer.
| status | error code |
| UBool icu::Formattable::isNumeric | ( | ) | const |
Returns true if the data type of thisFormattable object is kDouble, kLong, or kInt64.
| inline |
Equality operator.
| other | the object to be compared with. |
Definition at line192 of filefmtable.h.
Referencesicu::operator==().
| Formattable& icu::Formattable::operator= | ( | constFormattable & | rhs | ) |
| bool icu::Formattable::operator== | ( | constFormattable & | other | ) | const |
Equality comparison.
| other | the object to be compared with. |
| inline |
Accesses the specified element in the array value of thisFormattable object.
If this object is not of type kArray then the result is undefined.
| index | the specified index. |
| void icu::Formattable::populateDecimalQuantity | ( | number::impl::DecimalQuantity & | output, |
| UErrorCode & | status | ||
| ) | const |
Export the value of thisFormattable to a DecimalQuantity.
| void icu::Formattable::setArray | ( | constFormattable * | array, |
| int32_t | count | ||
| ) |
Sets the array value and count of this object and changes the type to kArray.
| array | the array value. |
| count | the number of array elements to be copied. |
| void icu::Formattable::setDate | ( | UDate | d | ) |
Sets the Date value of this object and changes the type to kDate.
| d | the new Date value to be set. |
| void icu::Formattable::setDecimalNumber | ( | StringPiece | numberString, |
| UErrorCode & | status | ||
| ) |
Sets the numeric value from a decimal number string, and changes the type to to a numeric type appropriate for the number.
The syntax of the number is a "numeric string" as defined in the Decimal Arithmetic Specification, available athttp://speleotrove.com/decimal The full precision and range of the input number will be retained, even when it exceeds what can be represented by a double or an int64.
| numberString | a string representation of the unformatted decimal number. |
| status | the error code. Set to U_INVALID_FORMAT_ERROR if the incoming string is not a valid decimal number. |
| void icu::Formattable::setDouble | ( | double | d | ) |
Sets the double value of this object and changes the type to kDouble.
| d | the new double value to be set. |
| void icu::Formattable::setInt64 | ( | int64_t | ll | ) |
Sets the int64 value of this object and changes the type to kInt64.
| ll | the new int64 value to be set. |
| void icu::Formattable::setLong | ( | int32_t | l | ) |
Sets the long value of this object and changes the type to kLong.
| l | the new long value to be set. |
| void icu::Formattable::setString | ( | constUnicodeString & | stringToCopy | ) |
Sets the string value of this object and changes the type to kString.
| stringToCopy | the new string value to be set. |
| inline |
| inline |