International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.number.Scale

Field Summary

Modifier and Type	Field and Description
pack-priv final BigDecimal	arbitrary
private static final BigDecimal	BIG_DECIMAL_100
private static final BigDecimal	BIG_DECIMAL_1000
private static final Scale	DEFAULT
private static final Scale	HUNDRED
pack-priv final int	magnitude
pack-priv final MathContext	mc
pack-priv final BigDecimal	reciprocal
private static final Scale	THOUSAND

Access	Constructor and Description
private	Scale(int magnitude, BigDecimal arbitrary)
private	Scale(int magnitude, BigDecimal arbitrary, MathContext mc)

Method Summary

Modifier and Type	Method and Description
public void	applyReciprocalTo(DecimalQuantity quantity) Deprecated ICU 62 This API is ICU internal only.
public void	applyTo(DecimalQuantity quantity) Deprecated ICU 62 This API is ICU internal only.
public static Scale	Returns: A Multiplier for passing to the setter in NumberFormatter. byBigDecimal(BigDecimal multiplicand) Multiply numbers by an arbitrary value before formatting.
public static Scale	Returns: A Multiplier for passing to the setter in NumberFormatter. byDouble(double multiplicand) Multiply numbers by an arbitrary value before formatting.
public static Scale	Returns: A Multiplier for passing to the setter in NumberFormatter. byDoubleAndPowerOfTen(double multiplicand, int power) Multiply a number by both a power of ten and by an arbitrary double value before formatting.
pack-priv boolean	isValid() Returns whether the multiplier will change the number.
public static Scale	Returns: A Multiplier to prevent any multiplication. none() Do not change the value of numbers when formatting or parsing.
public static Scale	Returns: A Multiplier for passing to the setter in NumberFormatter. powerOfTen(int power) Multiply numbers by 100 before formatting.
public Scale	withMathContext(MathContext mc) Deprecated ICU 62 This API is ICU internal only.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

arbitrary	back to summary
pack-priv final BigDecimal arbitrary

BIG_DECIMAL_100	back to summary
private static final BigDecimal BIG_DECIMAL_100

BIG_DECIMAL_1000	back to summary
private static final BigDecimal BIG_DECIMAL_1000

DEFAULT	back to summary
private static final Scale DEFAULT

HUNDRED	back to summary
private static final Scale HUNDRED

magnitude	back to summary
pack-priv final int magnitude

mc	back to summary
pack-priv final MathContext mc

reciprocal	back to summary
pack-priv final BigDecimal reciprocal

THOUSAND	back to summary
private static final Scale THOUSAND

Constructor Detail

Scale	back to summary
private Scale(int magnitude, BigDecimal arbitrary)

Scale	back to summary
private Scale(int magnitude, BigDecimal arbitrary, MathContext mc)

Method Detail

applyReciprocalTo	back to summary
public void applyReciprocalTo(DecimalQuantity quantity) Deprecated ICU 62 This API is ICU internal only. Annotations @Deprecated ICU Status Internal ICU component.

applyTo	back to summary
public void applyTo(DecimalQuantity quantity) Deprecated ICU 62 This API is ICU internal only. Annotations @Deprecated ICU Status Internal ICU component.

byBigDecimal back to summary

byBigDecimal	back to summary
public static Scale byBigDecimal(BigDecimal multiplicand) Multiply numbers by an arbitrary value before formatting. Useful for unit conversions. This method takes a BigDecimal; also see the version that takes a double. Returns:Scale A Multiplier for passing to the setter in NumberFormatter. ICU Status Stable since ICU 62. See Also `NumberFormatter`

public static Scale byBigDecimal(BigDecimal multiplicand)

Multiply numbers by an arbitrary value before formatting. Useful for unit conversions.

This method takes a BigDecimal; also see the version that takes a double.

Returns:Scale: A Multiplier for passing to the setter in NumberFormatter.
ICU Status: Stable since ICU 62.
See Also: NumberFormatter

byDouble back to summary

byDouble	back to summary
public static Scale byDouble(double multiplicand) Multiply numbers by an arbitrary value before formatting. Useful for unit conversions. This method takes a double; also see the version that takes a BigDecimal. Returns:Scale A Multiplier for passing to the setter in NumberFormatter. ICU Status Stable since ICU 62. See Also `NumberFormatter`

public static Scale byDouble(double multiplicand)

Multiply numbers by an arbitrary value before formatting. Useful for unit conversions.

This method takes a double; also see the version that takes a BigDecimal.

Returns:Scale: A Multiplier for passing to the setter in NumberFormatter.
ICU Status: Stable since ICU 62.
See Also: NumberFormatter

byDoubleAndPowerOfTen back to summary

byDoubleAndPowerOfTen	back to summary
public static Scale byDoubleAndPowerOfTen(double multiplicand, int power) Multiply a number by both a power of ten and by an arbitrary double value before formatting. Returns:Scale A Multiplier for passing to the setter in NumberFormatter. ICU Status Stable since ICU 62. See Also `NumberFormatter`

public static Scale byDoubleAndPowerOfTen(double multiplicand, int power)

Multiply a number by both a power of ten and by an arbitrary double value before formatting.

Returns:Scale: A Multiplier for passing to the setter in NumberFormatter.
ICU Status: Stable since ICU 62.
See Also: NumberFormatter

isValid	back to summary
pack-priv boolean isValid() Returns whether the multiplier will change the number.

none back to summary

none	back to summary
public static Scale none() Do not change the value of numbers when formatting or parsing. Returns:Scale A Multiplier to prevent any multiplication. ICU Status Stable since ICU 62. See Also `NumberFormatter`

public static Scale none()

Do not change the value of numbers when formatting or parsing.

Returns:Scale: A Multiplier to prevent any multiplication.
ICU Status: Stable since ICU 62.
See Also: NumberFormatter

powerOfTen back to summary

powerOfTen	back to summary
public static Scale powerOfTen(int power) Multiply numbers by 100 before formatting. Useful for combining with a percent unit: NumberFormatter.with().unit(NoUnit.PERCENT).multiplier(Multiplier.powerOfTen(2)) Returns:Scale A Multiplier for passing to the setter in NumberFormatter. ICU Status Stable since ICU 62. See Also `NumberFormatter`

public static Scale powerOfTen(int power)

Multiply numbers by 100 before formatting. Useful for combining with a percent unit:

NumberFormatter.with().unit(NoUnit.PERCENT).multiplier(Multiplier.powerOfTen(2))

Returns:Scale: A Multiplier for passing to the setter in NumberFormatter.
ICU Status: Stable since ICU 62.
See Also: NumberFormatter

withMathContext	back to summary
public Scale withMathContext(MathContext mc) Deprecated ICU 62 This API is ICU internal only. Annotations @Deprecated ICU Status Internal ICU component.

public Class Scale

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail