Interface GitRefCommandFactory
- All Superinterfaces:
com.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
public interface GitRefCommandFactory
extends com.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
-
Method Summary
Modifier and TypeMethodDescriptionGitCommand<com.atlassian.bitbucket.repository.Branch>createBranch(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ref.CreateBranchCommandParameters parameters) GitCommand<com.atlassian.bitbucket.repository.Tag>createTag(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ref.CreateTagCommandParameters parameters) deleteBranch(com.atlassian.bitbucket.repository.Repository repository, GitDeleteBranchCommandParameters parameters) deleteTag(com.atlassian.bitbucket.repository.Repository repository, GitDeleteTagCommandParameters parameters) resolveAnnotatedTags(com.atlassian.bitbucket.repository.Repository repository, GitResolveAnnotatedTagsCommandParameters parameters, GitAnnotatedTagCallback callback) com.atlassian.bitbucket.scm.Command<Void>validateRef(GitValidateRefCommandParameters parameters)
-
Method Details
-
createBranch
@Nonnull GitCommand<com.atlassian.bitbucket.repository.Branch> createBranch(@Nonnull com.atlassian.bitbucket.repository.Repository repository, @Nonnull com.atlassian.bitbucket.scm.ref.CreateBranchCommandParameters parameters) - Specified by:
createBranchin interfacecom.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
-
createTag
@Nonnull GitCommand<com.atlassian.bitbucket.repository.Tag> createTag(@Nonnull com.atlassian.bitbucket.repository.Repository repository, @Nonnull com.atlassian.bitbucket.scm.ref.CreateTagCommandParameters parameters) - Specified by:
createTagin interfacecom.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
-
deleteBranch
@Nonnull GitCommand<Void> deleteBranch(@Nonnull com.atlassian.bitbucket.repository.Repository repository, @Nonnull GitDeleteBranchCommandParameters parameters) - Parameters:
repository- the repository containing the branch to deleteparameters- describes the parameters required to delete a branch- Returns:
- a command which, when called, will delete a branch
- Throws:
com.atlassian.bitbucket.repository.InvalidAuthorException- if an author is not provided and there is no current effective user
-
deleteTag
@Nonnull GitCommand<Void> deleteTag(@Nonnull com.atlassian.bitbucket.repository.Repository repository, @Nonnull GitDeleteTagCommandParameters parameters) - Parameters:
repository- the repository containing the tag to deleteparameters- describes the parameters required to delete a tag- Returns:
- a command which, when called, will delete a tag
- Throws:
com.atlassian.bitbucket.repository.InvalidAuthorException- if an author is not provided and there is no current effective user
-
resolveAnnotatedTags
@Nonnull GitCommand<Void> resolveAnnotatedTags(@Nonnull com.atlassian.bitbucket.repository.Repository repository, @Nonnull GitResolveAnnotatedTagsCommandParameters parameters, @Nonnull GitAnnotatedTagCallback callback) - Parameters:
repository- the repository containing the tag to retrieveparameters- describes the parameters required to retrieve the tagcallback- the callback to stream the annotated tags to- Returns:
- a command which, when called, provides each successfully retrieved annotated tag to the provided callback.
- Since:
- 5.0
-
validateRef
com.atlassian.bitbucket.scm.Command<Void> validateRef(GitValidateRefCommandParameters parameters) throws com.atlassian.bitbucket.repository.InvalidRefNameException - Parameters:
parameters- describes the parameters required to validate the ref- Returns:
- a command which, when calls, will validate the given ref name and throw an exception if it is invalid
- Throws:
com.atlassian.bitbucket.repository.InvalidRefNameException- if the provided ref is invalid- Since:
- 6.1
-