com.atlassian.bitbucket.scm

Class AbstractMergeCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.AbstractMergeCommandParameters

Direct Known Subclasses:

MergeCommandParameters, PullRequestMergeCommandParameters

public class AbstractMergeCommandParameters
extends AbstractCommandParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMergeCommandParameters.AbstractBuilder<B extends AbstractMergeCommandParameters.AbstractBuilder<B>>

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMergeCommandParameters(AbstractMergeCommandParameters.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method and Description
ApplicationUser	getAuthor()
int	getCommitSummaries()
ApplicationUser	getCommitter()
String	getMessage()
String	getStrategyId()
boolean	isDryRun()

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMergeCommandParameters

protected AbstractMergeCommandParameters(AbstractMergeCommandParameters.AbstractBuilder<?> builder)

Parameters:

builder - a AbstractMergeCommandParameters.AbstractBuilder builder with properties to set on the constructed instance

Method Detail

getAuthor

@Nonnull
public ApplicationUser getAuthor()

Returns:

the author of the changes being merged

getCommitSummaries

public int getCommitSummaries()

Returns:

the number of commit summaries to append to the message, which may be 0 to not append any

Since:

6.7

getCommitter

@Nonnull
public ApplicationUser getCommitter()

Returns:

the user merging the changes

Since:

5.0

getMessage

@Nullable
public String getMessage()

getStrategyId

@Nullable
public String getStrategyId()

Returns:

the ID for the strategy to use to perform the merge, which may be null to use the SCM's default strategy

Since:

4.9

isDryRun

public boolean isDryRun()