ICU-22125 Add note about future deprecation to MeasureUnit createMetricTon/getMetricTon/METRIC_TON

This commit is contained in:
Peter Edberg 2022-09-08 17:07:54 -07:00 committed by Peter Edberg
parent 1dfe456fe8
commit baee21aa7a
2 changed files with 15 additions and 7 deletions

View file

@ -2585,19 +2585,25 @@ class U_I18N_API MeasureUnit: public UObject {
static MeasureUnit getKilogram();
/**
* Returns by pointer, unit of mass: metric-ton.
* (renamed to tonne in CLDR 42 / ICU 72)
* Returns by pointer, unit of mass: metric-ton
* (renamed to tonne in CLDR 42 / ICU 72).
* Caller owns returned value and must free it.
* Also see {@link #getMetricTon()}.
* Note: In ICU 74 this will be deprecated in favor of
* createTonne(), which is currently draft but will
* become stable in ICU 74, and which uses the preferred naming.
* Also see {@link #getMetricTon()} and {@link #createTonne()}.
* @param status ICU error code.
* @stable ICU 54
*/
static MeasureUnit *createMetricTon(UErrorCode &status);
/**
* Returns by value, unit of mass: metric-ton.
* (renamed to tonne in CLDR 42 / ICU 72)
* Also see {@link #createMetricTon()}.
* Returns by value, unit of mass: metric-ton
* (renamed to tonne in CLDR 42 / ICU 72).
* Note: In ICU 74 this will be deprecated in favor of
* getTonne(), which is currently draft but will
* become stable in ICU 74, and which uses the preferred naming.
* Also see {@link #createMetricTon()} and {@link #getTonne()}.
* @stable ICU 64
*/
static MeasureUnit getMetricTon();

View file

@ -1606,7 +1606,9 @@ public class MeasureUnit implements Serializable {
public static final MeasureUnit KILOGRAM = MeasureUnit.internalGetInstance("mass", "kilogram");
/**
* Constant for unit of mass: metric-ton (renamed to tonne in CLDR 42 / ICU 72)
* Constant for unit of mass: metric-ton (renamed to tonne in CLDR 42 / ICU 72).
* Note: In ICU 74 this will be deprecated in favor of TONNE, which is currently
* draft but will become stable in ICU 74, and which uses the preferred naming.
* @stable ICU 54
*/
public static final MeasureUnit METRIC_TON = MeasureUnit.internalGetInstance("mass", "tonne");