Package com.atlassian.bitbucket.scm.compare

Interface ScmCompareCommandFactory

public interface ScmCompareCommandFactory

Creates commands which allow comparing arbitrary refs or commits. 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. CompareService 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	Description
Command<Void>	changes(CompareChangeCommandParameters parameters, ChangeCallback callback)
Command<Void>	commits(CommitCallback callback)
Command<Void>	diff(CompareDiffCommandParameters parameters, DiffContentCallback callback)
Command<DiffStatsSummary>	diffStatsSummary(CompareDiffStatsSummaryCommandParameters parameters)	Retrieves the diff stats summary for the diff between two given commits

Method Details

changes

@Nonnull
Command<Void> changes(@Nonnull
 CompareChangeCommandParameters 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 between the from ref and the to ref

See Also:

• CompareService.streamChanges(CompareRequest, ChangeCallback)

commits

@Nonnull
Command<Void> commits(@Nonnull
 CommitCallback callback)

Parameters:

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

See Also:

• CompareService.streamCommits(CompareRequest, CommitCallback)

diff

@Nonnull
Command<Void> diff(@Nonnull
 CompareDiffCommandParameters 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 between the from ref and the to ref for the specified paths

See Also:

• CompareService.streamDiff(CompareDiffRequest, DiffContentCallback)

diffStatsSummary

@Nonnull
Command<DiffStatsSummary> diffStatsSummary(@Nonnull
 CompareDiffStatsSummaryCommandParameters parameters)

Retrieves the diff stats summary for the diff between two given commits

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

Parameters:

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

Returns:

a command which, when executed, will retrieve the diff stats summary between the from ref and the to ref for the specified paths

Since:

9.1

See Also:

• CompareService.getDiffStatsSummary(CompareDiffStatsSummaryRequest)