stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8186713: Document default rounding mode in NumberFormat

Browse Source 
Reviewed-by: naoto, bpb
This commit is contained in:
Nishit Jain 2017-08-29 12:16:22 +05:30 committed by Nishit Jain
parent 25c3c626bf
commit 2935665766
2 changed files with 15 additions and 4 deletions
jdk/src/java.base/share/classes/java
text
NumberFormat.java
util
Formatter.java

11
jdk/src/java.base/share/classes/java/text/NumberFormat.java

@ -181,6 +181,17 @@ import sun.util.locale.provider.LocaleServiceProviderPool;
* The subclass may provide its own implementation and specification about
* {@code NullPointerException}.
*
* <p>
* The default implementation provides rounding modes defined
* in {@link java.math.RoundingMode} for formatting numbers. It
* uses the {@linkplain java.math.RoundingMode#HALF_EVEN
* round half-even algorithm}. To change the rounding mode use
* {@link #setRoundingMode(java.math.RoundingMode) setRoundingMode}.
* The {@code NumberFormat} returned by the static factory methods is
* configured to round floating point numbers using half-even
* rounding (see {@link java.math.RoundingMode#HALF_EVEN
* RoundingMode.HALF_EVEN}) for formatting.
*
* @see DecimalFormat
* @see ChoiceFormat
* @author Mark Davis

8
jdk/src/java.base/share/classes/java/util/Formatter.java

@ -1229,7 +1229,7 @@ import jdk.internal.math.FormattedFloatingDecimal;
* than the number of digits which would appear after the decimal point in
* the string returned by {@link Float#toString(float)} or {@link
* Double#toString(double)} respectively, then the value will be rounded
* using the {@linkplain java.math.BigDecimal#ROUND_HALF_UP round half up
* using the {@linkplain java.math.RoundingMode#HALF_UP round half up
* algorithm}. Otherwise, zeros may be appended to reach the precision.
* For a canonical representation of the value, use {@link
* Float#toString(float)} or {@link Double#toString(double)} as
@ -1298,7 +1298,7 @@ import jdk.internal.math.FormattedFloatingDecimal;
* than the number of digits which would appear after the decimal point in
* the string returned by {@link Float#toString(float)} or {@link
* Double#toString(double)} respectively, then the value will be rounded
* using the {@linkplain java.math.BigDecimal#ROUND_HALF_UP round half up
* using the {@linkplain java.math.RoundingMode#HALF_UP round half up
* algorithm}. Otherwise, zeros may be appended to reach the precision.
* For a canonical representation of the value, use {@link
* Float#toString(float)} or {@link Double#toString(double)} as
@ -1461,7 +1461,7 @@ import jdk.internal.math.FormattedFloatingDecimal;
* specified then the default value is {@code 6}. If the precision is
* less than the number of digits to the right of the decimal point then
* the value will be rounded using the
* {@linkplain java.math.BigDecimal#ROUND_HALF_UP round half up
* {@linkplain java.math.RoundingMode#HALF_UP round half up
* algorithm}. Otherwise, zeros may be appended to reach the precision.
* For a canonical representation of the value, use {@link
* BigDecimal#toString()}.
@ -1524,7 +1524,7 @@ import jdk.internal.math.FormattedFloatingDecimal;
* specified then the default value is {@code 6}. If the precision is
* less than the number of digits to the right of the decimal point
* then the value will be rounded using the
* {@linkplain java.math.BigDecimal#ROUND_HALF_UP round half up
* {@linkplain java.math.RoundingMode#HALF_UP round half up
* algorithm}. Otherwise, zeros may be appended to reach the precision.
* For a canonical representation of the value, use {@link
* BigDecimal#toString()}.