com.atlassian.jgitflow.core

Class FeatureFinishCommand

java.lang.Object

com.atlassian.jgitflow.core.AbstractGitFlowCommand<Void>

com.atlassian.jgitflow.core.FeatureFinishCommand

All Implemented Interfaces:

Callable<Void>

public class FeatureFinishCommand
extends AbstractGitFlowCommand<Void>

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.AbstractGitFlowCommand

gfConfig, git, reporter

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Void	call()
protected String	getCommandName()
FeatureFinishCommand	setAllowUntracked(boolean allow)
FeatureFinishCommand	setFetchDevelop(boolean fetch) Set whether to perform a git fetch of the remote develop branch before doing the merge
FeatureFinishCommand	setForceDeleteBranch(boolean force) Set whether to use the force flag when deleting the local feature branch
FeatureFinishCommand	setKeepBranch(boolean keep) Set whether to keep the local feature branch after the merge
FeatureFinishCommand	setNoMerge(boolean noMerge)
FeatureFinishCommand	setPush(boolean push)
FeatureFinishCommand	setRebase(boolean rebase) Set whether to perform a git rebase on the feature before doing the merge
FeatureFinishCommand	setScmMessagePrefix(String scmMessagePrefix)
FeatureFinishCommand	setSquash(boolean squash) Set whether to squash all commits into a single commit before the merge

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

getScmMessagePrefix, isAllowUntracked, requireCleanWorkingTree, requireCommitOnBranch, requireGitFlowInitialized, requireLocalBranchAbsent, requireLocalBranchExists, requireLocalBranchNotBehindRemote, requireNoExistingHotfixBranches, requireNoExistingReleaseBranches, requireRemoteBranchAbsent, requireRemoteBranchExists, requireTagAbsent

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureFinishCommand

public FeatureFinishCommand(String name,
                    org.eclipse.jgit.api.Git git,
                    GitFlowConfiguration gfConfig,
                    JGitFlowReporter reporter)

Create a new feature finish command instance.

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

Parameters:

name - The name of the feature

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

reporter -

Method Detail

setAllowUntracked

public FeatureFinishCommand setAllowUntracked(boolean allow)

Overrides:

setAllowUntracked in class AbstractGitFlowCommand<Void>

setScmMessagePrefix

public FeatureFinishCommand setScmMessagePrefix(String scmMessagePrefix)

Overrides:

setScmMessagePrefix in class AbstractGitFlowCommand<Void>

call

public Void call()
          throws NotInitializedException,
                 JGitFlowGitAPIException,
                 LocalBranchMissingException,
                 JGitFlowIOException,
                 DirtyWorkingTreeException,
                 MergeConflictsNotResolvedException,
                 BranchOutOfDateException

Returns:

nothing

Throws:

NotInitializedException

JGitFlowGitAPIException

LocalBranchMissingException

JGitFlowIOException

DirtyWorkingTreeException

MergeConflictsNotResolvedException

BranchOutOfDateException

setFetchDevelop

public FeatureFinishCommand setFetchDevelop(boolean fetch)

Set whether to perform a git fetch of the remote develop branch before doing the merge

Parameters:

fetch - true to do the fetch, false(default) otherwise

Returns:

this

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

setKeepBranch

public FeatureFinishCommand setKeepBranch(boolean keep)

Set whether to keep the local feature branch after the merge

Parameters:

keep - true to keep the branch, false(default) otherwise

Returns:

this

setForceDeleteBranch

public FeatureFinishCommand setForceDeleteBranch(boolean force)

Set whether to use the force flag when deleting the local feature branch

Parameters:

force - true to force, 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

setPush

public FeatureFinishCommand setPush(boolean push)

setNoMerge

public FeatureFinishCommand setNoMerge(boolean noMerge)

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<Void>