ScientificNumberFormatter

Kotlin |Java

public final class ScientificNumberFormatter
extends Object

java.lang.Object
↳	android.icu.text.ScientificNumberFormatter

A formatter that formats numbers in user-friendly scientific notation. ScientificNumberFormatter instances are immutable and thread-safe. Sample code:

 ULocale en = new ULocale("en");
 ScientificNumberFormatter fmt = ScientificNumberFormatter.getMarkupInstance(
         en, "<sup>", "</sup>");

 // Output: "1.23456×10<sup>-78</sup>"
 System.out.println(fmt.format(1.23456e-78));

Summary

Public methods
`String`	`format(Object number)` Formats a number
`static ScientificNumberFormatter`	`getMarkupInstance(DecimalFormat df, String beginMarkup, String endMarkup)` Gets a ScientificNumberFormatter instance that uses markup for exponents.
`static ScientificNumberFormatter`	`getMarkupInstance(ULocale locale, String beginMarkup, String endMarkup)` Gets a ScientificNumberFormatter instance that uses markup for exponents for this locale.
`static ScientificNumberFormatter`	`getSuperscriptInstance(DecimalFormat df)` Gets a ScientificNumberFormatter instance that uses superscript characters for exponents.
`static ScientificNumberFormatter`	`getSuperscriptInstance(ULocale locale)` Gets a ScientificNumberFormatter instance that uses superscript characters for exponents for this locale.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

format

Added in API level 26

public String format (Object number)

Formats a number

Parameters
`number`	`Object`: Can be a double, int, Number or anything that DecimalFormat#format(Object) accepts.

Returns
`String`	the formatted string.

getMarkupInstance

Added in API level 26

public static ScientificNumberFormatter getMarkupInstance (DecimalFormat df, 
                String beginMarkup, 
                String endMarkup)

Gets a ScientificNumberFormatter instance that uses markup for exponents.

Parameters
`df`	`DecimalFormat`: The DecimalFormat must be configured for scientific notation. Caller may safely change df after this call as this method clones it when creating the ScientificNumberFormatter.
`beginMarkup`	`String`: the markup to start superscript e.g `<sup>`
`endMarkup`	`String`: the markup to end superscript e.g `</sup>`

Returns
`ScientificNumberFormatter`	The ScientificNumberFormatter instance.

getMarkupInstance

Added in API level 26

public static ScientificNumberFormatter getMarkupInstance (ULocale locale, 
                String beginMarkup, 
                String endMarkup)

Gets a ScientificNumberFormatter instance that uses markup for exponents for this locale.

Parameters
`locale`	`ULocale`: The locale
`beginMarkup`	`String`: the markup to start superscript e.g `<sup>`
`endMarkup`	`String`: the markup to end superscript e.g `</sup>`

Returns
`ScientificNumberFormatter`	The ScientificNumberFormatter instance.

getSuperscriptInstance

Added in API level 26

public static ScientificNumberFormatter getSuperscriptInstance (DecimalFormat df)

Gets a ScientificNumberFormatter instance that uses superscript characters for exponents.

Parameters
`df`	`DecimalFormat`: The DecimalFormat must be configured for scientific notation. Caller may safely change df after this call as this method clones it when creating the ScientificNumberFormatter.

Returns
`ScientificNumberFormatter`	the ScientificNumberFormatter instance.

getSuperscriptInstance

Added in API level 26

public static ScientificNumberFormatter getSuperscriptInstance (ULocale locale)

Gets a ScientificNumberFormatter instance that uses superscript characters for exponents for this locale.

Parameters
`locale`	`ULocale`: The locale

Returns
`ScientificNumberFormatter`	The ScientificNumberFormatter instance.