Package java.util

Interface Formattable

public interface Formattable
Classes that handle custom formatting for the 's' specifier of Formatter should implement the Formattable interface. It gives basic control over formatting objects.
See Also:
Formatter

  • Method Summary

    Modifier and Type Method Description
    void formatTo​(Formatter formatter, int flags, int width, int precision)
    Formats the object using the specified Formatter.

  • Method Details

    • formatTo

      void formatTo​(Formatter formatter, int flags, int width, int precision) throws IllegalFormatException
      Formats the object using the specified Formatter.
      Parameters:
      formatter - the Formatter to use.
      flags - the flags applied to the output format, which is a bitmask that is any combination of FormattableFlags.LEFT_JUSTIFY, FormattableFlags.UPPERCASE, and FormattableFlags.ALTERNATE. If no such flag is set, the output is formatted by the default formatting of the implementation.
      width - the minimum number of characters that should be written to the output. If the length of the converted value is less than width Additional space characters (' ') are added to the output if the as needed to make up the difference. These spaces are added at the beginning by default unless the flag FormattableFlags.LEFT_JUSTIFY is set, which denotes that padding should be added at the end. If width is -1, then minimum length is not enforced.
      precision - the maximum number of characters that can be written to the output. The length of the output is trimmed down to this size before the width padding is applied. If the precision is -1, then maximum length is not enforced.
      Throws:
      IllegalFormatException - if any of the parameters is not supported.