Package com.lightbend.cinnamon.chmetrics.reporter

Interface Formatter

  • All Known Implementing Classes:
    DefaultFormatter
    public interface Formatter
    API used to format identifiers.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String encode​(java.lang.String name)
      Encode a single name element within a full identifier.
      java.lang.String join​(java.util.List<java.lang.String> names)
      Join names into a single delimited identifier.

    • Method Detail

      • encode

        java.lang.String encode​(java.lang.String name)
        Encode a single name element within a full identifier. This allows delimiters in the name, or special characters, to be encoded differently. Such as replacing '.' with '_'.
        Parameters:
        name - single name element within full identifier
        Returns:
        encoded name to be included in full identifier

      • join

        java.lang.String join​(java.util.List<java.lang.String> names)
        Join names into a single delimited identifier.
        Parameters:
        names - the parts of the full identifier to join together
        Returns:
        a single delimited identifier