com.ibm.icu.number

Class IntegerWidth

java.lang.Object

com.ibm.icu.number.IntegerWidth

public class IntegerWidth
extends Object

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

Method Summary

Modifier and Type	Method and Description
IntegerWidth	truncateAt(int maxInt) Truncate numbers exceeding a certain number of numerals before the decimal separator.
static IntegerWidth	zeroFillTo(int minInt) Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator.

Methods inherited from class java.lang.Object

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

Method Detail

zeroFillTo

public static IntegerWidth zeroFillTo(int minInt)

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 - The minimum number of places before the decimal separator.

Returns:

An IntegerWidth for chaining or passing to the NumberFormatter integerWidth() setter.

Throws:

IllegalArgumentException - if the input number is too big or smaller than 0.

See Also:

NumberFormatter

Status:

Stable ICU 60.

truncateAt

public IntegerWidth truncateAt(int maxInt)

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 - The maximum number of places before the decimal separator. maxInt == -1 means no truncation.

Returns:

An IntegerWidth for passing to the NumberFormatter integerWidth() setter.

Throws:

IllegalArgumentException - if the input number is too big or smaller than -1.

See Also:

NumberFormatter

Status:

Stable ICU 60.