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 Changeset changesets given a set of ChangesetsCommandParameters#getCommitIds commit IDs, where each changeset includes the first page of com.atlassian.stash.content.Change 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

@Nonnull Command<List<Blame>>	blame(Repository repository, BlameCommandParameters parameters, PageRequest pageRequest)
@Nonnull Command<Page<Branch>>	branches(Repository repository, BranchesCommandParameters parameters, PageRequest pageRequest)
@Nonnull Command<Page<Change>>	changes(Repository repository, ChangesCommandParameters parameters, PageRequest pageRequest)
@Nonnull Command<Void>	changes(Repository repository, ChangesCommandParameters parameters, ChangeCallback callback)
@Nonnull Command<Changeset>	commit(Repository repository, CommitCommandParameters parameters) This method is deprecated. in 3.7 for removal in 4.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent. Owing to Java generics, there is no backward compatible way that change can be applied here. Based on that, this method signature will be changed in 4.0, to return a `Command<Commit>`. It will not be possible for an SCM to be compatible with both 3.x and 4.x due to this change.
@Deprecated @Nonnull Command<Page<Changeset>>	commits(Repository repository, CommitsCommandParameters parameters, PageRequest pageRequest) This method is deprecated. in 3.7 for removal in 4.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent. Owing to Java generics, there is no backward compatible way that change can be applied here. Based on that, this method signature will be changed in 4.0, to return a `Command<Page<Commit>>`. It will not be possible for an SCM to be compatible with both 3.x and 4.x due to this change.
@Deprecated @Nonnull Command<Void>	commits(Repository repository, CommitsCommandParameters parameters, ChangesetCallback callback) This method is deprecated. in 3.7 for removal in 4.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent. This method will be replaced by `commits(Repository, CommitsCommandParameters, CommitCallback)` in 4.0.
@Nonnull Command<Void>	create(Repository repository) Creates and initializes the repository on disk, performing any SCM-specific configuration that is appropriate for new repositories.
@Nonnull Command<Branch>	defaultBranch(Repository repository)
@Nonnull AsyncCommand<Void>	delete(Repository repository, DeleteCommandParameters parameters) Deletes the repository, allowing the underlying SCM to carry out any special processing necessary to clean up repository storage.
@Deprecated @Nonnull Command<Page<DetailedChangeset>>	detailedCommits(Repository repository, DetailedCommitsCommandParameters parameters, PageRequest pageRequest) This method is deprecated. in 3.7 for removal in 4.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent, allowing DetailedChangeset to be renamed to what it is: com.atlassian.stash.commit.Changeset Changeset. This method will be replaced by `changesets(Repository, ChangesetsCommandParameters, PageRequest)` in 4.0.
@Nonnull Command<Void>	diff(Repository repository, DiffCommandParameters parameters, DiffContentCallback callback)
@Nonnull Command<Void>	directory(Repository repository, DirectoryCommandParameters parameters, ContentTreeCallback callback, PageRequest pageRequest)
@Nonnull Command<Void>	file(Repository repository, FileCommandParameters parameters, FileContentCallback callback, PageRequest pageRequest)
@Nonnull Command<Void>	fork(Repository repository, Repository fork) Creates a fork of `repository`, stored in `fork`.
@Nonnull Command<Void>	heads(Repository repository, RefCallback callback)
@Nonnull Command<Branch>	merge(Repository repository, MergeCommandParameters parameters) Merges the specified `fromChangesetId` into the specified `toBranch`.
@Nonnull Command<Void>	rawFile(Repository repository, RawFileCommandParameters parameters, TypeAwareOutputSupplier outputSupplier)
@Nonnull Command<Ref>	resolveRef(Repository repository, String refId)
@Nonnull Command<Page<Tag>>	tags(Repository repository, TagsCommandParameters parameters, PageRequest pageRequest)
Command<Void>	traverseCommits(Repository repository, TraversalCallback callback) Streams all of the commits in the repository in topological order.
@Nonnull Command<ContentTreeNode.Type>	type(Repository repository, TypeCommandParameters parameters)
@Nonnull Command<Void>	updateDefaultBranch(Repository repository, String branchName) Set the default branch for the specified repository to the named branch.

Public Methods

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

Retrieves a page of Changeset changesets given a set of ChangesetsCommandParameters#getCommitIds commit IDs, where each changeset includes the first page of com.atlassian.stash.content.Change 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

Interfaces

Classes

Enums

PluginCommandFactory2

Summary

Public Methods

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

Parameters

Returns

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

Parameters

Returns

Throws

See Also