com.atlassian.jgitflow.core.command

Class FeatureFinishCommand

java.lang.Object

com.atlassian.jgitflow.core.command.AbstractGitFlowCommand<C,T>

com.atlassian.jgitflow.core.command.AbstractBranchMergingCommand<FeatureFinishCommand,org.eclipse.jgit.api.MergeResult>

com.atlassian.jgitflow.core.command.FeatureFinishCommand

All Implemented Interfaces:

JGitFlowCommand, Callable<org.eclipse.jgit.api.MergeResult>

public class FeatureFinishCommand
extends AbstractBranchMergingCommand<FeatureFinishCommand,org.eclipse.jgit.api.MergeResult>

Finish a feature.

This will merge the feature into develop and set the local branch to develop.

Examples (flow is a JGitFlow instance):

Finish a feature:

 flow.featureFinish("feature").call();
 

Don't delete the local feature branch

 flow.featureFinish("feature").setKeepBranch(true).call();
 

Squash all commits on the feature branch into one before merging

 flow.featureFinish("feature").setSquash(true).call();
 

Field Summary

Fields inherited from class com.atlassian.jgitflow.core.command.AbstractGitFlowCommand

gfConfig, git, reporter, requirementHelper

Constructor Summary

Constructors

Constructor and Description
FeatureFinishCommand(String branchName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig) Create a new feature finish command instance.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.api.MergeResult	call()
protected String	getCommandName()
FeatureFinishCommand	setExtension(FeatureFinishExtension extension)
FeatureFinishCommand	setNoMerge(boolean noMerge)
FeatureFinishCommand	setRebase(boolean rebase) Set whether to perform a git rebase on the feature before doing the merge
FeatureFinishCommand	setSquash(boolean squash) Set whether to squash all commits into a single commit before the merge
FeatureFinishCommand	setSuppressFastForward(boolean suppressFastForward)

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractBranchMergingCommand

checkMergeResults, checkoutTopicBranch, cleanupBranchesIfNeeded, createEmptyMergeResult, doMerge, doMerge, doMerge, doTag, getMessage, isForceDeleteBranch, isKeepBranch, setForceDeleteBranch, setKeepBranch, setMessage

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractGitFlowCommand

doFetchIfNeeded, doPushIfNeeded, enforcer, ensureLocalBranchesNotBehindRemotes, getBranchName, getScmMessagePrefix, getScmMessageSuffix, isAllowUntracked, isFetch, isPush, runBeforeAndGetPrefixedBranchName, runExtensionCommands, setAllowUntracked, setFetch, setPush, setScmMessagePrefix, setScmMessageSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureFinishCommand

public FeatureFinishCommand(String branchName,
                            org.eclipse.jgit.api.Git git,
                            GitFlowConfiguration gfConfig)

Create a new feature finish command instance.

An instance of this class is usually obtained by calling JGitFlow.featureFinish(String)

Parameters:

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

Method Detail

call

public org.eclipse.jgit.api.MergeResult call()
                                      throws NotInitializedException,
                                             JGitFlowGitAPIException,
                                             LocalBranchMissingException,
                                             JGitFlowIOException,
                                             DirtyWorkingTreeException,
                                             MergeConflictsNotResolvedException,
                                             BranchOutOfDateException,
                                             JGitFlowExtensionException,
                                             org.eclipse.jgit.api.errors.GitAPIException

Returns:

nothing

Throws:

NotInitializedException

JGitFlowGitAPIException

LocalBranchMissingException

JGitFlowIOException

DirtyWorkingTreeException

MergeConflictsNotResolvedException

BranchOutOfDateException

JGitFlowExtensionException

org.eclipse.jgit.api.errors.GitAPIException

setRebase

public FeatureFinishCommand setRebase(boolean rebase)

Set whether to perform a git rebase on the feature before doing the merge

Parameters:

rebase - true to do a rebase, false(default) otherwise

Returns:

this

setSquash

public FeatureFinishCommand setSquash(boolean squash)

Set whether to squash all commits into a single commit before the merge

Parameters:

squash - true to squash, false(default) otherwise

Returns:

this

setNoMerge

public FeatureFinishCommand setNoMerge(boolean noMerge)

setSuppressFastForward

public FeatureFinishCommand setSuppressFastForward(boolean suppressFastForward)

setExtension

public FeatureFinishCommand setExtension(FeatureFinishExtension extension)

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<FeatureFinishCommand,org.eclipse.jgit.api.MergeResult>