Interface Formatter


public interface Formatter
A value formatter.
Author:
Pavel Ponec
  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull CharSequence
    format(@Nullable Object value, @NotNull ApiElement element, @Nullable String attributeName)
    Format an objet value to a string ouptut, special characters will be escaped later.
  • Method Details

    • format

      @NotNull @NotNull CharSequence format(@Nullable @Nullable Object value, @NotNull @NotNull ApiElement element, @Nullable @Nullable String attributeName)
      Format an objet value to a string ouptut, special characters will be escaped later.
      Parameters:
      value - A data value
      element - A related element
      attributeName - A name of the attribute, if any.
      Returns:
      A target non-nnul sequence is required.