Package com.atlassian.bitbucket.scm.compare

Interface PluginCompareCommandFactory

public interface PluginCompareCommandFactory
Specialized command factory to compare two refs.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    com.atlassian.bitbucket.scm.Command<Void>
    changes(com.atlassian.bitbucket.compare.CompareRequest compareRequest, com.atlassian.bitbucket.scm.compare.CompareChangeCommandParameters parameters, com.atlassian.bitbucket.content.ChangeCallback callback)
     
    com.atlassian.bitbucket.scm.Command<Void>
    commits(com.atlassian.bitbucket.compare.CompareRequest compareRequest, com.atlassian.bitbucket.commit.CommitCallback callback)
     
    com.atlassian.bitbucket.scm.Command<Void>
    diff(com.atlassian.bitbucket.compare.CompareRequest compareRequest, com.atlassian.bitbucket.scm.compare.CompareDiffCommandParameters parameters, com.atlassian.bitbucket.content.DiffContentCallback callback)
     
    com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.content.DiffStatsSummary>
    diffStatsSummary(com.atlassian.bitbucket.compare.CompareRequest compareRequest, com.atlassian.bitbucket.scm.compare.CompareDiffStatsSummaryCommandParameters parameters)
    Retrieve the diff stats summary for the specified request.

  • Method Details

    • changes

      @Nonnull com.atlassian.bitbucket.scm.Command<Void> changes(@Nonnull com.atlassian.bitbucket.compare.CompareRequest compareRequest, @Nonnull com.atlassian.bitbucket.scm.compare.CompareChangeCommandParameters parameters, @Nonnull com.atlassian.bitbucket.content.ChangeCallback callback)

    • commits

      @Nonnull com.atlassian.bitbucket.scm.Command<Void> commits(@Nonnull com.atlassian.bitbucket.compare.CompareRequest compareRequest, @Nonnull com.atlassian.bitbucket.commit.CommitCallback callback)
      Parameters:
      compareRequest - describes the refs being compared
      callback - a callback to receive commits which are unique to the from ref
      Returns:
      a command which, when executed, will stream commits referenced by the from ref which are not referenced by the to ref

    • diff

      @Nonnull com.atlassian.bitbucket.scm.Command<Void> diff(@Nonnull com.atlassian.bitbucket.compare.CompareRequest compareRequest, @Nonnull com.atlassian.bitbucket.scm.compare.CompareDiffCommandParameters parameters, @Nonnull com.atlassian.bitbucket.content.DiffContentCallback callback)

    • diffStatsSummary

      @Nonnull com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.content.DiffStatsSummary> diffStatsSummary(@Nonnull com.atlassian.bitbucket.compare.CompareRequest compareRequest, @Nonnull com.atlassian.bitbucket.scm.compare.CompareDiffStatsSummaryCommandParameters parameters)
      Retrieve the diff stats summary for the specified request.

      The stats summary include the total number of modified files, added lines, and deleted lines.

      Parameters:
      compareRequest - the repository, starting and terminating commits, paths to filter by and other properties describing the diff
      parameters - parameters describing the paths to diff and what should be included in the diff stat summary generated
      Returns:
      a command which, when executed, will retrieve the diff stats summary for the specified request
      Since:
      9.1