Top Description Inners Fields Constructors Methods
com.ibm.icu.number

public Class CompactNotation

extends Notation
Class Inheritance
Imports
java.util.HashMap, .HashSet, .Map, .Set, com.ibm.icu.impl.number.CompactData, .CompactData.CompactType, .DecimalFormatProperties, .DecimalQuantity, .MicroProps, .MicroPropsGenerator, .MutablePatternModifier, .MutablePatternModifier.ImmutablePatternModifier, .PatternStringParser, .PatternStringParser.ParsedPatternInfo, com.ibm.icu.text.CompactDecimalFormat.CompactStyle, .NumberFormat, .PluralRules, com.ibm.icu.util.ULocale
A class that defines the scientific notation style to be used when formatting numbers in NumberFormatter.

This class exposes no public functionality. To create a CompactNotation, use one of the factory methods in Notation.

ICU Status
Stable since ICU 60.
See Also
NumberFormatter

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CompactNotation.CompactHandler

Field Summary

Modifier and TypeField and Description
pack-priv final Map<String, Map<String, String>>
compactCustomData

pack-priv final CompactDecimalFormat.CompactStyle
compactStyle

Constructor Summary

AccessConstructor and Description
pack-priv
CompactNotation(CompactDecimalFormat.CompactStyle compactStyle)

pack-priv
CompactNotation(Map<String, Map<String, String>> compactCustomData)

Method Summary

Modifier and TypeMethod and Description
public static CompactNotation
forCustomData(Map<String, Map<String, String>> compactCustomData)

Deprecated This API is ICU internal only.
Create a compact notation with custom data.
pack-priv MicroPropsGenerator
withLocaleData(ULocale locale, String nsName, CompactData.CompactType compactType, PluralRules rules, MutablePatternModifier buildReference, boolean safe, MicroPropsGenerator parent)

Inherited from com.ibm.icu.number.Notation:
compactLongcompactShortengineeringscientificsimple

Field Detail

compactCustomDataback to summary
pack-priv final Map<String, Map<String, String>> compactCustomData
compactStyleback to summary
pack-priv final CompactDecimalFormat.CompactStyle compactStyle

Constructor Detail

CompactNotationback to summary
pack-priv CompactNotation(CompactDecimalFormat.CompactStyle compactStyle)
CompactNotationback to summary
pack-priv CompactNotation(Map<String, Map<String, String>> compactCustomData)

Method Detail

forCustomDataback to summary
public static CompactNotation forCustomData(Map<String, Map<String, String>> compactCustomData)

Deprecated

This API is ICU internal only.

Create a compact notation with custom data.

Annotations
@Deprecated
ICU Status
Internal ICU component.
See Also
DecimalFormatProperties#setCompactCustomData
withLocaleDataback to summary
pack-priv MicroPropsGenerator withLocaleData(ULocale locale, String nsName, CompactData.CompactType compactType, PluralRules rules, MutablePatternModifier buildReference, boolean safe, MicroPropsGenerator parent)
com.ibm.icu.number back to summary

private Class CompactNotation.CompactHandler

extends Object
implements MicroPropsGenerator
Class Inheritance
All Implemented Interfaces
com.ibm.icu.impl.number.MicroPropsGenerator

Field Summary

Modifier and TypeField and Description
pack-priv final CompactData
data

pack-priv final MicroPropsGenerator
parent

pack-priv final Map<String, MutablePatternModifier.ImmutablePatternModifier>
precomputedMods

pack-priv final PluralRules
rules

pack-priv final MutablePatternModifier
unsafePatternModifier

Constructor Summary

AccessConstructor and Description
private
CompactHandler(CompactNotation notation, ULocale locale, String nsName, CompactData.CompactType compactType, PluralRules rules, MutablePatternModifier buildReference, boolean safe, MicroPropsGenerator parent)

Method Summary

Modifier and TypeMethod and Description
private void
precomputeAllModifiers(MutablePatternModifier buildReference)

Used by the safe code path

public MicroProps
processQuantity(DecimalQuantity
The quantity for consideration and optional mutation.
quantity)

Implements com.ibm.icu.impl.number.MicroPropsGenerator.processQuantity.

Deprecated as a consequence of DecimalQuantity being deprecated.
Considers the given DecimalQuantity, optionally mutates it, and returns a MicroProps.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

databack to summary
pack-priv final CompactData data
parentback to summary
pack-priv final MicroPropsGenerator parent
precomputedModsback to summary
pack-priv final Map<String, MutablePatternModifier.ImmutablePatternModifier> precomputedMods
rulesback to summary
pack-priv final PluralRules rules
unsafePatternModifierback to summary
pack-priv final MutablePatternModifier unsafePatternModifier

Constructor Detail

CompactHandlerback to summary
private CompactHandler(CompactNotation notation, ULocale locale, String nsName, CompactData.CompactType compactType, PluralRules rules, MutablePatternModifier buildReference, boolean safe, MicroPropsGenerator parent)

Method Detail

precomputeAllModifiersback to summary
private void precomputeAllModifiers(MutablePatternModifier buildReference)

Used by the safe code path

processQuantityback to summary
public MicroProps processQuantity(DecimalQuantity quantity)

Implements com.ibm.icu.impl.number.MicroPropsGenerator.processQuantity.

Doc from com.ibm.icu.impl.number.MicroPropsGenerator.processQuantity.

Deprecated

as a consequence of DecimalQuantity being deprecated. See corresponding docs for further information.

Considers the given DecimalQuantity, optionally mutates it, and returns a MicroProps.

Parameters
quantity:DecimalQuantity

The quantity for consideration and optional mutation.

Returns:MicroProps

A MicroProps instance resolved for the quantity.

Annotations
@Override