com.atlassian.bitbucket.scm.pull

Interface ScmPullRequestCommandFactory

public interface ScmPullRequestCommandFactory

Creates commands which provide pull request functionality. Each method accepts a set of CommandParameters which are used to control the command's behaviour and output.

Plugin developers: This is probably not the interface you want to use. PullRequestService automatically chooses the correct SCM based on the repository, and provides a more stable, compatible API. The documentation for each method on this interface includes a link to the API service method or methods which expose it.

Method Summary

Modifier and Type	Method and Description
Command<Void>	changes(PullRequestChangesCommandParameters parameters, ChangeCallback callback)
Command<Void>	commits(PullRequestCommitsCommandParameters parameters, CommitCallback callback)
Command<Void>	diff(PullRequestDiffCommandParameters parameters, DiffContentCallback callback)
Command<PullRequestEffectiveDiff>	effectiveDiff() Retrieves the effective diff for the pull request.
Command<Branch>	merge(PullRequestMergeCommandParameters parameters)
Command<PullRequestMergeResult>	tryMerge(PullRequest pullRequest) Attempt to merge the pull request to determine what the expected result of actually merging it would be.

Method Detail

changes

@Nonnull
Command<Void> changes(@Nonnull
                               PullRequestChangesCommandParameters parameters,
                               @Nonnull
                               ChangeCallback callback)

Parameters:

parameters - parameters describing how many changes to stream, and potentially for which paths

callback - a callback to receive changes

Returns:

a command which, when executed, will stream the changes the pull request wants to apply

Since:

6.0

See Also:

PullRequestService.streamChanges(PullRequestChangesRequest, ChangeCallback)

commits

@Nonnull
Command<Void> commits(@Nonnull
                               PullRequestCommitsCommandParameters parameters,
                               @Nonnull
                               CommitCallback callback)

Parameters:

parameters - parameters describing how the commits should be streamed

callback - a callback to receive commits

Returns:

a command which, when executed, will stream the commits that are reachable from the from ref and not reachable from the to ref

Since:

6.0

See Also:

PullRequestService.streamCommits(PullRequestCommitsRequest, CommitCallback)

diff

@Nonnull
Command<Void> diff(@Nonnull
                            PullRequestDiffCommandParameters parameters,
                            @Nonnull
                            DiffContentCallback callback)

Parameters:

parameters - parameters describing the paths to diff and what should be included in the diffs generated

callback - a callback to receive the diff

Returns:

a command which, when executed, will stream the diff for the specified paths

See Also:

PullRequestService.streamDiff(PullRequestDiffRequest, DiffContentCallback)

effectiveDiff

@Nonnull
Command<PullRequestEffectiveDiff> effectiveDiff()

Retrieves the effective diff for the pull request. The "effective diff" is comprised of the two commits that should be compared to get a view of what changes the pull request includes. When new commits are added to either of the branches involved in a pull request, the pull request's effective diff may change.

Note: This method is not exposed via the service API. It is only available directly on the SCM API. The effective diff is something plugin developers generally do not need to be explicitly aware of. Instead, the commits, changes and diff(com.atlassian.bitbucket.scm.pull.PullRequestDiffCommandParameters, com.atlassian.bitbucket.content.DiffContentCallback) should be retrieved using their respective commands.

Returns:

a command which, when executed, will retrieve the commit IDs which describe the pull request's current effective diff

merge

@Nonnull
Command<Branch> merge(@Nonnull
                               PullRequestMergeCommandParameters parameters)

Parameters:

parameters - parameters describing additional context which an SCM may consider when merging the pull request, potentially altering the way final shape of the merge

Returns:

a command which, when executed, will merge the pull request, applying its changes to the target branch

See Also:

PullRequestService.merge(PullRequestMergeRequest)

tryMerge

@Nonnull
Command<PullRequestMergeResult> tryMerge(@Nonnull
                                                  PullRequest pullRequest)

Attempt to merge the pull request to determine what the expected result of actually merging it would be.

Parameters:

pullRequest - the pull request to test for merge-ability

Returns:

the result of trying to merge the pull request

Since:

4.10

See Also:

PullRequestService.canMerge(int, long)