ICU-62107.0.1.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / currunit.h

diff --git a/icuSources/i18n/unicode/currunit.h b/icuSources/i18n/unicode/currunit.h
index a4e6df7d1cf19a7a8c5d6e3396e6425b77ec3f07..7df4e3464d1a70724c9e66ba5679dd92a4749bfd 100644 (file)
--- a/icuSources/i18n/unicode/currunit.h
+++ b/icuSources/i18n/unicode/currunit.h
@@ -1,6 +1,8 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
 **********************************************************************
-* Copyright (c) 2004, International Business Machines
+* Copyright (c) 2004-2014, International Business Machines
 * Corporation and others.  All Rights Reserved.
 **********************************************************************
 * Author: Alan Liu
@@ -17,67 +19,85 @@
 
 #include "unicode/measunit.h"
 
+/**
+ * \file 
+ * \brief C++ API: Currency Unit Information.
+ */
+ 
+#if U_SHOW_CPLUSPLUS_API
 U_NAMESPACE_BEGIN
 
 /**
  * A unit of currency, such as USD (U.S. dollars) or JPY (Japanese
- * yen).  This class is a thin wrapper over a UChar string that
+ * yen).  This class is a thin wrapper over a char16_t string that
  * subclasses MeasureUnit, for use with Measure and MeasureFormat.
  *
  * @author Alan Liu
- * @draft ICU 3.0
+ * @stable ICU 3.0
  */
 class U_I18N_API CurrencyUnit: public MeasureUnit {
  public:
+    /**
+     * Default constructor.  Initializes currency code to "XXX" (no currency).
+     * @draft ICU 60
+     */
+    CurrencyUnit();
+
     /**
      * Construct an object with the given ISO currency code.
-     * @param isoCode the 3-letter ISO 4217 currency code; must not be
-     * NULL and must have length 3
+     * @param isoCode the 3-letter ISO 4217 currency code; must have
+     * length 3 and need not be NUL-terminated. If NULL, the currency
+     * is initialized to the unknown currency XXX.
      * @param ec input-output error code. If the isoCode is invalid,
      * then this will be set to a failing value.
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
-    CurrencyUnit(const UChar* isoCode, UErrorCode &ec);
+    CurrencyUnit(ConstChar16Ptr isoCode, UErrorCode &ec);
 
     /**
      * Copy constructor
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     CurrencyUnit(const CurrencyUnit& other);
 
+#ifndef U_HIDE_DRAFT_API
+    /**
+     * Copy constructor from MeasureUnit. This constructor allows you to
+     * restore a CurrencyUnit that was sliced to MeasureUnit.
+     *
+     * @param measureUnit The MeasureUnit to copy from.
+     * @param ec Set to a failing value if the MeasureUnit is not a currency.
+     * @draft ICU 60
+     */
+    CurrencyUnit(const MeasureUnit& measureUnit, UErrorCode &ec);
+#endif  /* U_HIDE_DRAFT_API */
+
     /**
      * Assignment operator
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     CurrencyUnit& operator=(const CurrencyUnit& other);
 
     /**
      * Return a polymorphic clone of this object.  The result will
      * have the same class as returned by getDynamicClassID().
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     virtual UObject* clone() const;
 
     /**
      * Destructor
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     virtual ~CurrencyUnit();
 
-    /**
-     * Equality operator.  Return true if this object is equal
-     * to the given object.
-     * @draft ICU 3.0
-     */
-    UBool operator==(const UObject& other) const;
-
     /**
      * Returns a unique class ID for this object POLYMORPHICALLY.
      * This method implements a simple form of RTTI used by ICU.
      * @return 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.
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     virtual UClassID getDynamicClassID() const;
 
@@ -85,28 +105,29 @@ class U_I18N_API CurrencyUnit: public MeasureUnit {
      * Returns the class ID for this class. This is used to compare to
      * the return value of getDynamicClassID().
      * @return The class ID for all objects of this class.
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
     static UClassID U_EXPORT2 getStaticClassID();
 
     /**
      * Return the ISO currency code of this object.
-     * @draft ICU 3.0
+     * @stable ICU 3.0
      */
-    inline const UChar* getISOCurrency() const;
+    inline const char16_t* getISOCurrency() const;
 
  private:
     /**
      * The ISO 4217 code of this object.
      */
-    UChar isoCode[4];
+    char16_t isoCode[4];
 };
 
-inline const UChar* CurrencyUnit::getISOCurrency() const {
+inline const char16_t* CurrencyUnit::getISOCurrency() const {
     return isoCode;
 }
 
 U_NAMESPACE_END
+#endif // U_SHOW_CPLUSPLUS_API
 
 #endif // !UCONFIG_NO_FORMATTING
 #endif // __CURRENCYUNIT_H__