@Deprecated public interface

PluginCommandFactory2

implements PluginCommandFactory
com.atlassian.stash.scm.PluginCommandFactory2

This interface is deprecated.
in 3.7 for removal in 4.0. In 4.0 this interface's methods will be folded into PluginCommandFactory and become a mandatory part of the SCM contract.

Summary

Public Methods
@Nonnull Command<Page<Changeset>> changesets(Repository repository, ChangesetsCommandParameters parameters, PageRequest pageRequest)
Retrieves a page of changesets given a set of ChangesetsCommandParameters#getCommitIds commit IDs, where each changeset includes the first page of changes between a requested commit and its first parent.
@Nonnull Command<Void> commits(Repository repository, CommitsCommandParameters parameters, CommitCallback callback)
Streams commits which match the provided CommitsCommandParameters paramters to the provided callback.
[Expand]
Inherited Methods
From interface com.atlassian.stash.scm.PluginCommandFactory

Public Methods

@Nonnull public Command<Page<Changeset>> changesets (Repository repository, ChangesetsCommandParameters parameters, PageRequest pageRequest)

Retrieves a page of changesets given a set of ChangesetsCommandParameters#getCommitIds commit IDs, where each changeset includes the first page of changes between a requested commit and its first parent.

Parameters
repository the repository to retrieve changesets from
parameters parameters describing the changesets to retrieve
pageRequest describes the page of changesets to retrieve
Returns
  • a command which, when executed, will retrieve a page of changesets

@Nonnull public Command<Void> commits (Repository repository, CommitsCommandParameters parameters, CommitCallback callback)

Streams commits which match the provided CommitsCommandParameters paramters to the provided callback.

Implementors: SCMs are required to support this operation. However, they are not required to support CommitsCommandParameters#getSecondaryRepository() secondary repositories unless they offer ScmFeature#CROSS_REPOSITORY cross-repository support. If a secondary repository is provided and cross- repository operations are not supported, implementations should throw an UnsupportedOperationException.

Parameters
repository the repository to retrieve commits from
parameters parameters describing the commits to retrieve
callback a callback to receive the streamed commits
Returns
  • a command which, when executed, will stream commits to the provided callback
Throws
UnsupportedOperationException if a CommitsCommandParameters#getSecondaryRepository() secondary repository is provided an ScmFeature#CROSS_REPOSITORY cross- repository operations are not supported
See Also
  • ScmFeature#CROSS_REPOSITORY