com.ibm.icu.text

Class ScientificFormatHelper

java.lang.Object

com.ibm.icu.text.ScientificFormatHelper

public final class ScientificFormatHelper
extends Object

A helper class for formatting in user-friendly scientific notation. ScientificFormatHelper instances are immutable and thread-safe. However, the AttributedCharacterIterator instances that ScientificFormatHelper instances format must not be shared across multiple threads. Sample code:

 DecimalFormat decfmt = (DecimalFormat) NumberFormat.getScientificInstance(new ULocale("en"));
 AttributedCharacterIterator iterator = decfmt.formatToCharacterIterator(1.23456e-78);
 ScientificFormatHelper helper = ScientificFormatHelper.getInstance(
                decfmt.getDecimalFormatSymbols());
 
 // Output: "1.23456×10-78"
  System.out.println(helper.insertMarkup(iterator, "", ""));
 

See Also:

NumberFormat

Status:

Draft ICU 54.

Method Summary

Methods

Modifier and Type	Method and Description
static ScientificFormatHelper	getInstance(DecimalFormatSymbols dfs) Returns a new ScientificFormatHelper.
String	insertMarkup(AttributedCharacterIterator iterator, CharSequence beginMarkup, CharSequence endMarkup) Makes scientific notation user-friendly by surrounding exponent with html to make it superscript.
String	toSuperscriptExponentDigits(AttributedCharacterIterator iterator) Makes scientific notation user-friendly by using specific code points for superscript 0..9, -, and + in the exponent rather than by using html.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ScientificFormatHelper getInstance(DecimalFormatSymbols dfs)

Returns a new ScientificFormatHelper.

Parameters:

dfs - comes from the DecimalFormat instance used for default scientific notation.

Status:

Draft ICU 54.

insertMarkup

public String insertMarkup(AttributedCharacterIterator iterator,
                  CharSequence beginMarkup,
                  CharSequence endMarkup)

Makes scientific notation user-friendly by surrounding exponent with html to make it superscript.

Parameters:

iterator - the value that DecimalFormat.formatToCharacterIterator() returned.

beginMarkup - the start html for the exponent e.g "^"

endMarkup - the end html for the exponent e.g ""

Returns:

the user-friendly scientific notation.

Status:

Draft ICU 54.

toSuperscriptExponentDigits

public String toSuperscriptExponentDigits(AttributedCharacterIterator iterator)

Makes scientific notation user-friendly by using specific code points for superscript 0..9, -, and + in the exponent rather than by using html.

Parameters:

iterator - the value that DecimalFormat.formatToCharacterIterator() returned.

Returns:

the user-friendly scientific notation.

Status:

Draft ICU 54.