diff options
author | Victor Chang <vichang@google.com> | 2018-08-21 18:04:37 +0100 |
---|---|---|
committer | Victor Chang <vichang@google.com> | 2018-08-22 10:14:20 +0100 |
commit | 40ab78910d1c947df3f78fe916a3162acd7645b7 (patch) | |
tree | d5901a5834ca2655377e312d3d3f258a8bc8e147 | |
parent | 1a2d918ad7532ad8692f3bfca3e00a767a3f2c12 (diff) | |
download | android_external_icu-40ab78910d1c947df3f78fe916a3162acd7645b7.tar.gz android_external_icu-40ab78910d1c947df3f78fe916a3162acd7645b7.tar.bz2 android_external_icu-40ab78910d1c947df3f78fe916a3162acd7645b7.zip |
Remove public javadoc linking to NumberFormatter
- NumberFormatter is hidden API. We should hide it in Android's documentation.
Bug: 112536599
Test: ./generate_android_icu4j.sh
Change-Id: Ia4814537822be2627a5a559ab451445cc279a244
8 files changed, 277 insertions, 87 deletions
diff --git a/android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java b/android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java index 03bac8817..690b2419c 100644 --- a/android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java +++ b/android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java @@ -21,12 +21,6 @@ import android.icu.util.ULocale; /** * Formats numbers in compact (abbreviated) notation, like "1.2K" instead of "1200". * - * <p> - * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if - * {@link NumberFormatter} fits their use case. Although not deprecated, this - * class, CompactDecimalFormat, is provided for backwards compatibility only. - * <hr> - * * The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will * limited real estate. For example, 'Hits: 1.2B' instead of 'Hits: 1,200,000,000'. The format will * be appropriate for the given language, such as "1,2 Mrd." for German. @@ -73,9 +67,6 @@ public class CompactDecimalFormat extends DecimalFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Creates a CompactDecimalFormat appropriate for a locale. The result may be affected by the * number system in the locale, such as ar-u-nu-latn. * @@ -87,9 +78,6 @@ public class CompactDecimalFormat extends DecimalFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Creates a CompactDecimalFormat appropriate for a locale. The result may be affected by the * number system in the locale, such as ar-u-nu-latn. * diff --git a/android_icu4j/src/main/java/android/icu/text/DecimalFormat.java b/android_icu4j/src/main/java/android/icu/text/DecimalFormat.java index dcea91df4..d8682ada1 100644 --- a/android_icu4j/src/main/java/android/icu/text/DecimalFormat.java +++ b/android_icu4j/src/main/java/android/icu/text/DecimalFormat.java @@ -38,12 +38,6 @@ import android.icu.util.ULocale.Category; /** * <strong>[icu enhancement]</strong> ICU's replacement for {@link java.text.DecimalFormat}. Methods, fields, and other functionality specific to ICU are labeled '<strong>[icu]</strong>'. * - * <p> - * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if - * {@link NumberFormatter} fits their use case. Although not deprecated, this - * class, DecimalFormat, is only provided for java.text.DecimalFormat compatibility. - * <hr> - * * <code>DecimalFormat</code> is the primary * concrete subclass of {@link NumberFormat}. 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 diff --git a/android_icu4j/src/main/java/android/icu/text/MeasureFormat.java b/android_icu4j/src/main/java/android/icu/text/MeasureFormat.java index 1fbac7127..8725345a5 100644 --- a/android_icu4j/src/main/java/android/icu/text/MeasureFormat.java +++ b/android_icu4j/src/main/java/android/icu/text/MeasureFormat.java @@ -57,12 +57,6 @@ import android.icu.util.UResourceBundle; * A formatter for Measure objects. * * <p> - * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if - * {@link NumberFormatter} fits their use case. Although not deprecated, this - * class, MeasureFormat, is provided for backwards compatibility only. - * <hr> - * - * <p> * To format a Measure object, first create a formatter object using a MeasureFormat factory method. Then * use that object's format or formatMeasures methods. * diff --git a/android_icu4j/src/main/java/android/icu/text/NumberFormat.java b/android_icu4j/src/main/java/android/icu/text/NumberFormat.java index 78f1e39e4..c20a55dd7 100644 --- a/android_icu4j/src/main/java/android/icu/text/NumberFormat.java +++ b/android_icu4j/src/main/java/android/icu/text/NumberFormat.java @@ -551,9 +551,6 @@ public abstract class NumberFormat extends UFormat { //============== Locale Stuff ===================== /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns the default number format for the current default <code>FORMAT</code> locale. * The default format is one of the styles provided by the other * factory methods: getNumberInstance, getIntegerInstance, @@ -567,9 +564,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns the default number format for the specified locale. * The default format is one of the styles provided by the other * factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. @@ -580,9 +574,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns the default number format for the specified locale. * The default format is one of the styles provided by the other * factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. @@ -593,9 +584,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a specific style number format for default <code>FORMAT</code> locale. * @param style number format style * @see Category#FORMAT @@ -605,9 +593,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a specific style number format for a specific locale. * @param inLocale the specific locale. * @param style number format style @@ -618,9 +603,6 @@ public abstract class NumberFormat extends UFormat { /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a general-purpose number format for the current default <code>FORMAT</code> locale. * @see Category#FORMAT */ @@ -629,9 +611,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a general-purpose number format for the specified locale. */ public static NumberFormat getNumberInstance(Locale inLocale) { @@ -639,9 +618,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a general-purpose number format for the specified locale. */ public static NumberFormat getNumberInstance(ULocale inLocale) { @@ -649,9 +625,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns an integer number format for the current default <code>FORMAT</code> locale. The * returned number format is configured to round floating point numbers * to the nearest integer using IEEE half-even rounding (see {@link @@ -668,9 +641,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns an integer number format for the specified locale. The * returned number format is configured to round floating point numbers * to the nearest integer using IEEE half-even rounding (see {@link @@ -687,9 +657,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns an integer number format for the specified locale. The * returned number format is configured to round floating point numbers * to the nearest integer using IEEE half-even rounding (see {@link @@ -705,9 +672,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a currency format for the current default <code>FORMAT</code> locale. * @return a number format for currency * @see Category#FORMAT @@ -717,9 +681,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a currency format for the specified locale. * @return a number format for currency */ @@ -728,9 +689,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a currency format for the specified locale. * @return a number format for currency */ @@ -739,9 +697,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a percentage format for the current default <code>FORMAT</code> locale. * @return a number format for percents * @see Category#FORMAT @@ -751,9 +706,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a percentage format for the specified locale. * @return a number format for percents */ @@ -762,9 +714,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a percentage format for the specified locale. * @return a number format for percents */ @@ -773,9 +722,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a scientific format for the current default <code>FORMAT</code> locale. * @return a scientific number format * @see Category#FORMAT @@ -785,9 +731,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a scientific format for the specified locale. * @return a scientific number format */ @@ -796,9 +739,6 @@ public abstract class NumberFormat extends UFormat { } /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * <strong>[icu]</strong> Returns a scientific format for the specified locale. * @return a scientific number format */ @@ -1316,9 +1256,6 @@ public abstract class NumberFormat extends UFormat { /** - * <strong>NOTE:</strong> New users are strongly encouraged to use - * {@link NumberFormatter} instead of NumberFormat. - * <hr> * Returns a specific style number format for a specific locale. * @param desiredLocale the specific locale. * @param choice number format style diff --git a/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/CompactDecimalFormat.java.patch b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/CompactDecimalFormat.java.patch new file mode 100644 index 000000000..b059215bc --- /dev/null +++ b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/CompactDecimalFormat.java.patch @@ -0,0 +1,35 @@ +--- android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java 2018-08-21 18:04:13.950636392 +0100 ++++ android_icu4j/src/main/java/android/icu/text/CompactDecimalFormat.java 2018-08-21 18:03:41.790480466 +0100 +@@ -21,12 +21,6 @@ + /** + * Formats numbers in compact (abbreviated) notation, like "1.2K" instead of "1200". + * +- * <p> +- * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if +- * {@link NumberFormatter} fits their use case. Although not deprecated, this +- * class, CompactDecimalFormat, is provided for backwards compatibility only. +- * <hr> +- * + * The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will + * limited real estate. For example, 'Hits: 1.2B' instead of 'Hits: 1,200,000,000'. The format will + * be appropriate for the given language, such as "1,2 Mrd." for German. +@@ -73,9 +67,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Creates a CompactDecimalFormat appropriate for a locale. The result may be affected by the + * number system in the locale, such as ar-u-nu-latn. + * +@@ -87,9 +78,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Creates a CompactDecimalFormat appropriate for a locale. The result may be affected by the + * number system in the locale, such as ar-u-nu-latn. + * diff --git a/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/DecimalFormat.java.patch b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/DecimalFormat.java.patch new file mode 100644 index 000000000..f73ab6701 --- /dev/null +++ b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/DecimalFormat.java.patch @@ -0,0 +1,15 @@ +--- android_icu4j/src/main/java/android/icu/text/DecimalFormat.java 2018-08-21 18:04:14.254637865 +0100 ++++ android_icu4j/src/main/java/android/icu/text/DecimalFormat.java 2018-08-21 18:01:56.273968869 +0100 +@@ -38,12 +38,6 @@ + /** + * <strong>[icu enhancement]</strong> ICU's replacement for {@link java.text.DecimalFormat}. Methods, fields, and other functionality specific to ICU are labeled '<strong>[icu]</strong>'. + * +- * <p> +- * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if +- * {@link NumberFormatter} fits their use case. Although not deprecated, this +- * class, DecimalFormat, is only provided for java.text.DecimalFormat compatibility. +- * <hr> +- * + * <code>DecimalFormat</code> is the primary + * concrete subclass of {@link NumberFormat}. 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 diff --git a/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/MeasureFormat.java.patch b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/MeasureFormat.java.patch new file mode 100644 index 000000000..bc5a0991e --- /dev/null +++ b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/MeasureFormat.java.patch @@ -0,0 +1,15 @@ +--- android_icu4j/src/main/java/android/icu/text/MeasureFormat.java 2018-08-21 18:04:14.282638002 +0100 ++++ android_icu4j/src/main/java/android/icu/text/MeasureFormat.java 2018-08-21 18:02:29.502129978 +0100 +@@ -57,12 +57,6 @@ + * A formatter for Measure objects. + * + * <p> +- * <strong>IMPORTANT:</strong> New users are strongly encouraged to see if +- * {@link NumberFormatter} fits their use case. Although not deprecated, this +- * class, MeasureFormat, is provided for backwards compatibility only. +- * <hr> +- * +- * <p> + * To format a Measure object, first create a formatter object using a MeasureFormat factory method. Then + * use that object's format or formatMeasures methods. + * diff --git a/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/NumberFormat.java.patch b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/NumberFormat.java.patch new file mode 100644 index 000000000..d9b3b713e --- /dev/null +++ b/tools/srcgen/javadoc_patches/patches/src/main/java/android/icu/text/NumberFormat.java.patch @@ -0,0 +1,212 @@ +--- android_icu4j/src/main/java/android/icu/text/NumberFormat.java 2018-08-21 18:04:14.310638137 +0100 ++++ android_icu4j/src/main/java/android/icu/text/NumberFormat.java 2018-08-21 18:00:48.769641569 +0100 +@@ -551,9 +551,6 @@ + //============== Locale Stuff ===================== + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns the default number format for the current default <code>FORMAT</code> locale. + * The default format is one of the styles provided by the other + * factory methods: getNumberInstance, getIntegerInstance, +@@ -567,9 +564,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns the default number format for the specified locale. + * The default format is one of the styles provided by the other + * factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. +@@ -580,9 +574,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns the default number format for the specified locale. + * The default format is one of the styles provided by the other + * factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. +@@ -593,9 +584,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a specific style number format for default <code>FORMAT</code> locale. + * @param style number format style + * @see Category#FORMAT +@@ -605,9 +593,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a specific style number format for a specific locale. + * @param inLocale the specific locale. + * @param style number format style +@@ -618,9 +603,6 @@ + + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a general-purpose number format for the current default <code>FORMAT</code> locale. + * @see Category#FORMAT + */ +@@ -629,9 +611,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a general-purpose number format for the specified locale. + */ + public static NumberFormat getNumberInstance(Locale inLocale) { +@@ -639,9 +618,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a general-purpose number format for the specified locale. + */ + public static NumberFormat getNumberInstance(ULocale inLocale) { +@@ -649,9 +625,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns an integer number format for the current default <code>FORMAT</code> locale. The + * returned number format is configured to round floating point numbers + * to the nearest integer using IEEE half-even rounding (see {@link +@@ -668,9 +641,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns an integer number format for the specified locale. The + * returned number format is configured to round floating point numbers + * to the nearest integer using IEEE half-even rounding (see {@link +@@ -687,9 +657,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns an integer number format for the specified locale. The + * returned number format is configured to round floating point numbers + * to the nearest integer using IEEE half-even rounding (see {@link +@@ -705,9 +672,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a currency format for the current default <code>FORMAT</code> locale. + * @return a number format for currency + * @see Category#FORMAT +@@ -717,9 +681,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a currency format for the specified locale. + * @return a number format for currency + */ +@@ -728,9 +689,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a currency format for the specified locale. + * @return a number format for currency + */ +@@ -739,9 +697,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a percentage format for the current default <code>FORMAT</code> locale. + * @return a number format for percents + * @see Category#FORMAT +@@ -751,9 +706,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a percentage format for the specified locale. + * @return a number format for percents + */ +@@ -762,9 +714,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a percentage format for the specified locale. + * @return a number format for percents + */ +@@ -773,9 +722,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a scientific format for the current default <code>FORMAT</code> locale. + * @return a scientific number format + * @see Category#FORMAT +@@ -785,9 +731,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a scientific format for the specified locale. + * @return a scientific number format + */ +@@ -796,9 +739,6 @@ + } + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * <strong>[icu]</strong> Returns a scientific format for the specified locale. + * @return a scientific number format + */ +@@ -1316,9 +1256,6 @@ + + + /** +- * <strong>NOTE:</strong> New users are strongly encouraged to use +- * {@link NumberFormatter} instead of NumberFormat. +- * <hr> + * Returns a specific style number format for a specific locale. + * @param desiredLocale the specific locale. + * @param choice number format style |