Class IntegerWidth


  • public class IntegerWidth
    extends java.lang.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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) static IntegerWidth DEFAULT  
      (package private) int maxInt  
      (package private) int minInt  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private IntegerWidth​(int minInt, int maxInt)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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
    • Field Detail

      • minInt

        final int minInt
      • maxInt

        final int maxInt
    • Constructor Detail

      • IntegerWidth

        private IntegerWidth​(int minInt,
                             int maxInt)
    • 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:
        java.lang.IllegalArgumentException - if the input number is too big or smaller than 0.
        See Also:
        NumberFormatter
      • 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:
        java.lang.IllegalArgumentException - if the input number is too big or smaller than -1.
        See Also:
        NumberFormatter