com.atlassian.bitbucket.scm

Class RevertCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.RevertCommandParameters

public class RevertCommandParameters
extends AbstractCommandParameters

Parameters to perform a revert operation.

Since:

8.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RevertCommandParameters.Builder

Field Summary

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

NOT_BLANK

Method Summary

Modifier and Type	Method and Description
Branch	getBranch() The tip of the branch that will be used as the parent of the revert commit.
String	getCommitId()
ApplicationUser	getCommitter()
Optional<Integer>	getMergedCommitParentNumber()
Optional<String>	getTargetBranch() The branch that the revert commit will be created on.

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

Method Detail

getBranch

@Nonnull
public Branch getBranch()

The tip of the branch that will be used as the parent of the revert commit.

This branch will also be the target branch if the target branch is not provided (i.e. the revert commit will be created on this branch).

Returns:

branch used as the parent of the revert commit

getCommitId

@Nonnull
public String getCommitId()

Returns:

the ID of the commit to be reverted

getCommitter

@Nonnull
public ApplicationUser getCommitter()

Returns:

the committer of the revert commit.

getMergedCommitParentNumber

@Nonnull
public Optional<Integer> getMergedCommitParentNumber()

Returns:

parent number of the merge commit to be considered for reverting, if the commit is a merge commit, otherwise Optional.empty().

getTargetBranch

@Nonnull
public Optional<String> getTargetBranch()

The branch that the revert commit will be created on.

If target branch is Optional.empty() then getBranch() will be used as the target branch.

Returns:

the branch to create the revert commit on