com.atlassian.bitbucket.scm.ref

Interface PluginRefCommandFactory

public interface PluginRefCommandFactory

Specialized command factory for dealing with refs.

See Also:

PluginCommandFactory

Method Summary

Modifier and Type	Method and Description
com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.repository.Branch>	createBranch(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ref.CreateBranchCommandParameters parameters)
com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.repository.Tag>	createTag(com.atlassian.bitbucket.repository.Repository repository, com.atlassian.bitbucket.scm.ref.CreateTagCommandParameters parameters)

Method Detail

createBranch

@Nonnull
com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.repository.Branch> createBranch(@Nonnull
                                                                                                     com.atlassian.bitbucket.repository.Repository repository,
                                                                                                     @Nonnull
                                                                                                     com.atlassian.bitbucket.scm.ref.CreateBranchCommandParameters parameters)

Parameters:

repository - the repository to create the branch

parameters - describes the parameters required to create a branch

Returns:

a command which, when called, will create a branch

Throws:

com.atlassian.bitbucket.repository.InvalidAuthorException - if an author is not provided and there is no current effective user

createTag

@Nonnull
com.atlassian.bitbucket.scm.Command<com.atlassian.bitbucket.repository.Tag> createTag(@Nonnull
                                                                                               com.atlassian.bitbucket.repository.Repository repository,
                                                                                               @Nonnull
                                                                                               com.atlassian.bitbucket.scm.ref.CreateTagCommandParameters parameters)

Parameters:

repository - the repository to create the tag

parameters - describes the parameters required to create a tag

Returns:

a command which, when called, will create a tag

Throws:

com.atlassian.bitbucket.repository.InvalidAuthorException - if an author is not provided and there is no current effective user