public class

MergeCommandParameters

extends AbstractMergeCommandParameters
java.lang.Object
   ↳ com.atlassian.bitbucket.util.BuilderSupport
     ↳ com.atlassian.bitbucket.scm.AbstractCommandParameters
       ↳ com.atlassian.bitbucket.scm.AbstractMergeCommandParameters
         ↳ com.atlassian.bitbucket.scm.MergeCommandParameters

Summary

Nested Classes
class MergeCommandParameters.AbstractMergeBuilder<B extends AbstractMergeBuilder<B>>  
class MergeCommandParameters.Builder  
[Expand]
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Protected Constructors
MergeCommandParameters(AbstractMergeBuilder builder)
Public Methods
@Nonnull String getFromBranch()
@Nullable String getFromCommitId()
Retrieves the specific commit that should be merged into the target branch.
@Nullable Repository getFromRepository()
Retrieves the repository containing the from getFromBranch() and commit.
@Nonnull String getToBranch()
boolean hasFromRepository()
Retrieves a flag indicating whether these parameters include a from repository, indicating the merge is cross-repository, where the to repository is provided when requesting the merge command rather than in these parameters.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.scm.AbstractMergeCommandParameters
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Protected Constructors

protected MergeCommandParameters (AbstractMergeBuilder builder)

Public Methods

@Nonnull public String getFromBranch ()

@Nullable public String getFromCommitId ()

Retrieves the specific commit that should be merged into the target branch.

If this value is not provided, the current tip of the source branch is merged into the target. This should be used with caution, as it may result in the system performing a different merge than intended if the source branch changes between when the merge is requested and when it is performed.

Returns
  • the specific commit to merge in, or null to merge the current tip of the branch

@Nullable public Repository getFromRepository ()

Retrieves the repository containing the from getFromBranch() and commit.

Returns
  • the from repository, or null if the from and to branches are in the same repository

@Nonnull public String getToBranch ()

public boolean hasFromRepository ()

Retrieves a flag indicating whether these parameters include a from repository, indicating the merge is cross-repository, where the to repository is provided when requesting the merge command rather than in these parameters.

Returns