8266578: Disambiguate BigDecimal description of scale

Reviewed-by: darcy, bpb
This commit is contained in:
Ignasi Marimon-Clos 2021-07-12 16:54:39 +00:00 committed by Brian Burkhalter
parent 92ae6a5123
commit 1aef372ed8

View File

@ -38,11 +38,12 @@ import java.util.Objects;
* Immutable, arbitrary-precision signed decimal numbers. A {@code
* BigDecimal} consists of an arbitrary precision integer
* <i>{@linkplain unscaledValue() unscaled value}</i> and a 32-bit
* integer <i>{@linkplain scale() scale}</i>. If zero or positive,
* the scale is the number of digits to the right of the decimal
* point. If negative, the unscaled value of the number is multiplied
* by ten to the power of the negation of the scale. The value of the
* number represented by the {@code BigDecimal} is therefore
* integer <i>{@linkplain scale() scale}</i>. If the
* scale is zero or positive, the scale is the number of digits to
* the right of the decimal point. If the scale is negative, the
* unscaled value of the number is multiplied by ten to the power of
* the negation of the scale. The value of the number represented by
* the {@code BigDecimal} is therefore
* <code>(unscaledValue &times; 10<sup>-scale</sup>)</code>.
*
* <p>The {@code BigDecimal} class provides operations for