Added in API level 30

IntegerWidth


open class IntegerWidth
kotlin.Any
   ↳ android.icu.number.IntegerWidth

A class that defines the strategy for padding and truncating integers before the decimal separator.

To create an IntegerWidth, use one of the factory methods.

Summary

Public methods
open IntegerWidth!
truncateAt(maxInt: Int)

Truncate numbers exceeding a certain number of numerals before the decimal separator.

open static IntegerWidth!
zeroFillTo(minInt: Int)

Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator.

Public methods

truncateAt

Added in API level 30
open fun truncateAt(maxInt: Int): IntegerWidth!

Truncate numbers exceeding a certain number of numerals before the decimal separator. For example, with maxInt=3, the number 1234 will get printed as "234".

Parameters
maxInt Int: The maximum number of places before the decimal separator. maxInt == -1 means no truncation.
Return
IntegerWidth! An IntegerWidth for passing to the NumberFormatter integerWidth() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than -1.

zeroFillTo

Added in API level 30
open static fun zeroFillTo(minInt: Int): IntegerWidth!

Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator.

For example, with minInt=3, the number 55 will get printed as "055".

Parameters
minInt Int: The minimum number of places before the decimal separator.
Return
IntegerWidth! An IntegerWidth for chaining or passing to the NumberFormatter integerWidth() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 0.