Package com.atlassian.bitbucket.scm

Interface CommandSummaryHandler

public interface CommandSummaryHandler
Augments a CommandErrorHandler, CommandInputHandler or CommandOutputHandler with an enhanced completion handler that is provided with a summary of the command that was executed.

Some handlers need better insight into how the command they were attached to completed, rather than simply knowing when completion happens. For example, handlers which are attached to callbacks may need to know whether the command succeeded or failed so they can notify the callback appropriately. The base complete() method inherited from the handler interfaces does not offer that level of detail.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onComplete(CommandSummary summary)
    Notifies the handler that the command it was attached to has completed, and provides a summary of the command.

  • Method Details

    • onComplete

      void onComplete(@Nonnull CommandSummary summary) throws IOException
      Notifies the handler that the command it was attached to has completed, and provides a summary of the command.
      Parameters:
      summary - the command's summary
      Throws:
      IOException - if processing the completion results in an exception