Class ScientificNotation

java.lang.Object

com.ibm.icu.number.Notation

com.ibm.icu.number.ScientificNotation

public class ScientificNotation
extends Notation

A class that defines the scientific notation style to be used when formatting numbers in NumberFormatter.

To create a ScientificNotation, use one of the factory methods in Notation.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

Method Summary

Modifier and Type	Method	Description
ScientificNotation	withExponentSignDisplay(NumberFormatter.SignDisplay exponentSignDisplay)	Sets whether to show the sign on positive and negative exponents in scientific notation.
ScientificNotation	withMinExponentDigits(int minExponentDigits)	Sets the minimum number of digits to show in the exponent of scientific notation, padding with zeros if necessary.

Methods inherited from class Notation

compactLong, compactShort, engineering, scientific, simple

Modifier and Type	Method	Description
static CompactNotation	compactLong()	Print the number using long-form compact notation.
static CompactNotation	compactShort()	Print the number using short-form compact notation.
static ScientificNotation	engineering()	Print the number using engineering notation, a variant of scientific notation in which the exponent must be divisible by 3.
static ScientificNotation	scientific()	Print the number using scientific notation (also known as scientific form, standard index form, or standard form in the UK).
static SimpleNotation	simple()	Print the number using simple notation without any scaling by powers of ten.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withMinExponentDigits

public ScientificNotation withMinExponentDigits(int minExponentDigits)

Sets the minimum number of digits to show in the exponent of scientific notation, padding with zeros if necessary. Useful for fixed-width display.

For example, with minExponentDigits=2, the number 123 will be printed as "1.23E02" in en-US instead of the default "1.23E2".

Parameters:

minExponentDigits - The minimum number of digits to show in the exponent.

Returns:

A ScientificNotation, for chaining.

Throws:

IllegalArgumentException - if minExponentDigits is too big or smaller than 1

See Also:

• NumberFormatter

Status:

Stable ICU 60.

withExponentSignDisplay

public ScientificNotation withExponentSignDisplay(NumberFormatter.SignDisplay exponentSignDisplay)

Sets whether to show the sign on positive and negative exponents in scientific notation. The default is AUTO, showing the minus sign but not the plus sign.

For example, with exponentSignDisplay=ALWAYS, the number 123 will be printed as "1.23E+2" in en-US instead of the default "1.23E2".

Parameters:

exponentSignDisplay - The strategy for displaying the sign in the exponent.

Returns:

A ScientificNotation, for chaining.

See Also:

• NumberFormatter

Status:

Stable ICU 60.