Interface LoggableData


public interface LoggableData
This interface should be used to indicate that a class implements a method to format itself in a design suitable for logging.

This may be useful to either obfuscate, or even totally remove certain information from a class which would otherwise be exposed, or just to make the output formatting/layout of an object be more palatable when reading it in a log.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    Used to return the data the implementing class would like to display within a Log statement.
  • Method Details

    • getFormattedLogData

      default String getFormattedLogData()
      Used to return the data the implementing class would like to display within a Log statement.
      Returns:
      The data for the log formatted how you would like it to be displayed within a console.