Interface IncompleteLogger

  • All Implemented Interfaces:

    
    public interface IncompleteLogger
    
                        

    Interface defining operations for an incomplete logger object. Implementations are expected to handle log entries, timestamps, vitals, and finalization or abandonment of incomplete logs.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Long getLastSavedTimestamp() Retrieves the timestamp of the last time the logger was saved.
      abstract Unit addLogStatement(String tag, String message) Adds a log statement with a specified tag and message to the incomplete logger.
      abstract Unit addVitals(String tag, String key, String value) Records vital information associated with a incomplete logger tag for the logs.
      abstract Result<?> finish(String tag) Finalizes the incomplete logger
      abstract Result<?> abandon() Abandons the incomplete logger, discarding any saved data.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getLastSavedTimestamp

         abstract Long getLastSavedTimestamp()

        Retrieves the timestamp of the last time the logger was saved.

        Returns:

        The timestamp of the last time the logger was saved.

      • addLogStatement

         abstract Unit addLogStatement(String tag, String message)

        Adds a log statement with a specified tag and message to the incomplete logger.

        Parameters:
        tag - The tag or identifier for categorizing the log entry.
        message - The content or message to be logged.
      • addVitals

         abstract Unit addVitals(String tag, String key, String value)

        Records vital information associated with a incomplete logger tag for the logs.

        Parameters:
        tag - The tag for the error logs
        key - The key identifying the vital information.
        value - The corresponding value of the vital information.
      • finish

         abstract Result<?> finish(String tag)

        Finalizes the incomplete logger

        Parameters:
        tag - The tag for the error logs.
        Returns:

        A Result object indicating the result of finalizing the log.

      • abandon

         abstract Result<?> abandon()

        Abandons the incomplete logger, discarding any saved data.

        Returns:

        A Result object indicating the result of abandoning the logger.