GitCommandFactory (Bitbucket Server - Git SCM API 6.9.0 API)

All Superinterfaces:

com.atlassian.bitbucket.scm.PluginCommandFactory
```
public interface GitCommandFactory
extends com.atlassian.bitbucket.scm.PluginCommandFactory
```
Overrides methods from the standard PluginCommandFactory interface and returns GitCommand instances instead of simple Command or AsyncCommand instances. This allows commands created by this factory to be used synchronously or asynchronously at the caller's discretion, rather than fixing execution to one approach or the other.
This interface does not add any commands to the standard interface. It only covariantly adjusts their return types.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.content.Blame>>`	`blame(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.BlameCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<Void>`	`branches(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.BranchesCommandParameters parameters, com.atlassian.bitbucket.repository.BranchCallback callback)`
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.repository.Branch>>`	`branches(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.BranchesCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<Void>`	`changes(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ChangesCommandParameters parameters, com.atlassian.bitbucket.content.ChangeCallback callback)`
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.content.Change>>`	`changes(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ChangesCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.commit.Changeset>>`	`changesets(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ChangesetsCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<com.atlassian.bitbucket.commit.Commit>`	`commit(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.CommitCommandParameters parameters)`
`GitCommand<Void>`	`commits(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.CommitsCommandParameters parameters, com.atlassian.bitbucket.commit.CommitCallback callback)`
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.commit.Commit>>`	`commits(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.CommitsCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<com.atlassian.bitbucket.commit.MinimalCommit>`	`commonAncestor(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.CommonAncestorCommandParameters parameters)`
`GitCommand<Void>`	`create(com.atlassian.bitbucket.repository.Repository repository)`
`GitCommand<com.atlassian.bitbucket.repository.Branch>`	`defaultBranch(com.atlassian.bitbucket.repository.Repository repository)`
`GitCommand<Void>`	`delete(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.DeleteCommandParameters parameters)`
`GitCommand<Void>`	`diff(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.DiffCommandParameters parameters, com.atlassian.bitbucket.content.DiffContentCallback callback)`
`GitCommand<Void>`	`directory(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.DirectoryCommandParameters parameters, com.atlassian.bitbucket.content.ContentTreeCallback callback, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<Void>`	`file(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.FileCommandParameters parameters, com.atlassian.bitbucket.content.FileContentCallback callback, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<Void>`	`heads(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.repository.RefCallback callback)`
`GitCommand<Void>`	`rawFile(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.RawFileCommandParameters parameters, com.atlassian.bitbucket.io.TypeAwareOutputSupplier outputSupplier)`
`GitCommand<Void>`	`refs(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.RefsCommandParameters parameters, com.atlassian.bitbucket.repository.RefCallback callback)`
`GitCommand<com.atlassian.bitbucket.repository.Ref>`	`resolveRef(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ResolveRefCommandParameters parameters)`
`GitCommand<Map<String,com.atlassian.bitbucket.repository.Ref>>`	`resolveRefs(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ResolveRefsCommandParameters parameters)`
`GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.repository.Tag>>`	`tags(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.TagsCommandParameters parameters, com.atlassian.bitbucket.util.PageRequest pageRequest)`
`GitCommand<Void>`	`tags(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.TagsCommandParameters parameters, com.atlassian.bitbucket.repository.TagCallback callback)`
`GitCommand<Void>`	`traverseCommits(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.commit.graph.TraversalCallback callback)`
`GitCommand<com.atlassian.bitbucket.content.ContentTreeNode.Type>`	`type(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.TypeCommandParameters parameters)`

Methods inherited from interface com.atlassian.bitbucket.scm.PluginCommandFactory
diff

Method Detail

blame

@Nonnull
GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.content.Blame>> blame(@Nonnull
                                                                                                    com.atlassian.bitbucket.repository.Repository repository,
                                                                                                    @Nonnull
                                                                                                    com.atlassian.bitbucket.scm.BlameCommandParameters parameters,
                                                                                                    @Nonnull
                                                                                                    com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: blame in interface com.atlassian.bitbucket.scm.PluginCommandFactory

branches

@Nonnull
GitCommand<Void> branches(@Nonnull
                                   com.atlassian.bitbucket.repository.Repository repository,
                                   @Nonnull
                                   com.atlassian.bitbucket.scm.BranchesCommandParameters parameters,
                                   @Nonnull
                                   com.atlassian.bitbucket.repository.BranchCallback callback)

Specified by:: branches in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to stream branches from; parameters - parameters describing any filter to apply, and the order to stream branches in; callback - a callback to receive the streamed branches
Returns:: a command which, when executed, will stream branches
Since:: 4.6

branches

@Nonnull
GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.repository.Branch>> branches(@Nonnull
                                                                                                           com.atlassian.bitbucket.repository.Repository repository,
                                                                                                           @Nonnull
                                                                                                           com.atlassian.bitbucket.scm.BranchesCommandParameters parameters,
                                                                                                           @Nonnull
                                                                                                           com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: branches in interface com.atlassian.bitbucket.scm.PluginCommandFactory

changes

@Nonnull
GitCommand<Void> changes(@Nonnull
                                  com.atlassian.bitbucket.repository.Repository repository,
                                  @Nonnull
                                  com.atlassian.bitbucket.scm.ChangesCommandParameters parameters,
                                  @Nonnull
                                  com.atlassian.bitbucket.content.ChangeCallback callback)

Specified by:: changes in interface com.atlassian.bitbucket.scm.PluginCommandFactory

changes

@Nonnull
GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.content.Change>> changes(@Nonnull
                                                                                                       com.atlassian.bitbucket.repository.Repository repository,
                                                                                                       @Nonnull
                                                                                                       com.atlassian.bitbucket.scm.ChangesCommandParameters parameters,
                                                                                                       @Nonnull
                                                                                                       com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: changes in interface com.atlassian.bitbucket.scm.PluginCommandFactory

changesets

@Nonnull
GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.commit.Changeset>> changesets(@Nonnull
                                                                                                            com.atlassian.bitbucket.repository.Repository repository,
                                                                                                            @Nonnull
                                                                                                            com.atlassian.bitbucket.scm.ChangesetsCommandParameters parameters,
                                                                                                            @Nonnull
                                                                                                            com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: changesets in interface com.atlassian.bitbucket.scm.PluginCommandFactory

commit

@Nonnull
GitCommand<com.atlassian.bitbucket.commit.Commit> commit(@Nonnull
                                                                  com.atlassian.bitbucket.repository.Repository repository,
                                                                  @Nonnull
                                                                  com.atlassian.bitbucket.scm.CommitCommandParameters parameters)

Specified by:: commit in interface com.atlassian.bitbucket.scm.PluginCommandFactory

commits

@Nonnull
GitCommand<com.atlassian.bitbucket.util.Page<com.atlassian.bitbucket.commit.Commit>> commits(@Nonnull
                                                                                                      com.atlassian.bitbucket.repository.Repository repository,
                                                                                                      @Nonnull
                                                                                                      com.atlassian.bitbucket.scm.CommitsCommandParameters parameters,
                                                                                                      @Nonnull
                                                                                                      com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: commits in interface com.atlassian.bitbucket.scm.PluginCommandFactory

commits

@Nonnull
GitCommand<Void> commits(@Nonnull
                                  com.atlassian.bitbucket.repository.Repository repository,
                                  @Nonnull
                                  com.atlassian.bitbucket.scm.CommitsCommandParameters parameters,
                                  @Nonnull
                                  com.atlassian.bitbucket.commit.CommitCallback callback)

Specified by:: commits in interface com.atlassian.bitbucket.scm.PluginCommandFactory

commonAncestor

@Nonnull
GitCommand<com.atlassian.bitbucket.commit.MinimalCommit> commonAncestor(@Nonnull
                                                                                 com.atlassian.bitbucket.repository.Repository repository,
                                                                                 @Nonnull
                                                                                 com.atlassian.bitbucket.scm.CommonAncestorCommandParameters parameters)

Specified by:: commonAncestor in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Since:: 5.0

create
```
@Nonnull
GitCommand<Void> create(@Nonnull
                                 com.atlassian.bitbucket.repository.Repository repository)
```
Specified by:

create in interface com.atlassian.bitbucket.scm.PluginCommandFactory

Parameters:

repository - the repository to create

Returns:

a command which can be used to create a repository synchronously or asynchronously

defaultBranch

@Nonnull
GitCommand<com.atlassian.bitbucket.repository.Branch> defaultBranch(@Nonnull
                                                                             com.atlassian.bitbucket.repository.Repository repository)

Specified by:: defaultBranch in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to retrieve the default branch for
Returns:: a command which can retrieve the default branch synchronously or asynchronously

delete

@Nonnull
GitCommand<Void> delete(@Nonnull
                                 com.atlassian.bitbucket.repository.Repository repository,
                                 @Nonnull
                                 com.atlassian.bitbucket.scm.DeleteCommandParameters parameters)

Specified by:: delete in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to delete
Returns:: a command which can delete the repository synchronously or asynchronously

diff

@Nonnull
GitCommand<Void> diff(@Nonnull
                               com.atlassian.bitbucket.repository.Repository repository,
                               @Nonnull
                               com.atlassian.bitbucket.scm.DiffCommandParameters parameters,
                               @Nonnull
                               com.atlassian.bitbucket.content.DiffContentCallback callback)

Specified by:: diff in interface com.atlassian.bitbucket.scm.PluginCommandFactory

file

@Nonnull
GitCommand<Void> file(@Nonnull
                               com.atlassian.bitbucket.repository.Repository repository,
                               @Nonnull
                               com.atlassian.bitbucket.scm.FileCommandParameters parameters,
                               @Nonnull
                               com.atlassian.bitbucket.content.FileContentCallback callback,
                               @Nonnull
                               com.atlassian.bitbucket.util.PageRequest pageRequest)

Specified by:: file in interface com.atlassian.bitbucket.scm.PluginCommandFactory

heads

@Nonnull
GitCommand<Void> heads(@Nonnull
                                com.atlassian.bitbucket.repository.Repository repository,
                                @Nonnull
                                com.atlassian.bitbucket.repository.RefCallback callback)

Specified by:: heads in interface com.atlassian.bitbucket.scm.PluginCommandFactory

rawFile

@Nonnull
GitCommand<Void> rawFile(@Nonnull
                                  com.atlassian.bitbucket.repository.Repository repository,
                                  @Nonnull
                                  com.atlassian.bitbucket.scm.RawFileCommandParameters parameters,
                                  @Nonnull
                                  com.atlassian.bitbucket.io.TypeAwareOutputSupplier outputSupplier)

Specified by:: rawFile in interface com.atlassian.bitbucket.scm.PluginCommandFactory

refs

@Nonnull
GitCommand<Void> refs(@Nonnull
                               com.atlassian.bitbucket.repository.Repository repository,
                               @Nonnull
                               com.atlassian.bitbucket.scm.RefsCommandParameters parameters,
                               @Nonnull
                               com.atlassian.bitbucket.repository.RefCallback callback)

Specified by:: refs in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to stream refs for; parameters - parameters to allow evolving the SPI over time; callback - a callback to receive the streamed refs
Returns:: a command which, when executed, will stream refs from the specified repository
Since:: 6.4

resolveRef

@Nonnull
GitCommand<com.atlassian.bitbucket.repository.Ref> resolveRef(@Nonnull
                                                                       com.atlassian.bitbucket.repository.Repository repository,
                                                                       @Nonnull
                                                                       com.atlassian.bitbucket.scm.ResolveRefCommandParameters parameters)

Specified by:: resolveRef in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to resolve the ref in; parameters - parameters describing the ref to resolve, optionally including a type hint
Returns:: a command which, when executed, will attempt to resolve the provided ID to a Branch or Tag
Since:: 4.6

resolveRefs

@Nonnull
GitCommand<Map<String,com.atlassian.bitbucket.repository.Ref>> resolveRefs(@Nonnull
                                                                                    com.atlassian.bitbucket.repository.Repository repository,
                                                                                    @Nonnull
                                                                                    com.atlassian.bitbucket.scm.ResolveRefsCommandParameters parameters)

Specified by:: resolveRefs in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Since:: 4.4

traverseCommits

@Nonnull
GitCommand<Void> traverseCommits(@Nonnull
                                          com.atlassian.bitbucket.repository.Repository repository,
                                          @Nonnull
                                          com.atlassian.bitbucket.commit.graph.TraversalCallback callback)

Specified by:: traverseCommits in interface com.atlassian.bitbucket.scm.PluginCommandFactory
Parameters:: repository - the repository to traverse commits for; callback - the callback to receive the streamed commits
Returns:: a command which, when executed, will stream all of the commits in the repository, topologically ordered
Since:: 4.6

type

@Nonnull
GitCommand<com.atlassian.bitbucket.content.ContentTreeNode.Type> type(@Nonnull
                                                                               com.atlassian.bitbucket.repository.Repository repository,
                                                                               @Nonnull
                                                                               com.atlassian.bitbucket.scm.TypeCommandParameters parameters)

Specified by:: type in interface com.atlassian.bitbucket.scm.PluginCommandFactory

Interface GitCommandFactory

Method Summary

Methods inherited from interface com.atlassian.bitbucket.scm.PluginCommandFactory

Method Detail

blame

branches

branches

changes

changes

changesets

commit

commits

commits

commonAncestor

create

defaultBranch

delete

diff

directory

file

heads

rawFile

refs

resolveRef

resolveRefs

tags

tags

traverseCommits

type