com.atlassian.jgitflow.core.command

Class AbstractGitFlowCommand<C,T>

java.lang.Object

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

Type Parameters:

T - The return type of the call() method

All Implemented Interfaces:

JGitFlowCommand, Callable<T>

Direct Known Subclasses:

AbstractBranchCreatingCommand, AbstractBranchMergingCommand, FeaturePublishCommand, FeatureRebaseCommand, HotfixPublishCommand, ReleasePublishCommand

public abstract class AbstractGitFlowCommand<C,T>
extends Object
implements Callable<T>, JGitFlowCommand

The base class for all JGitFlow commands.

Most commands should extend this class as it provides common helper methods and methods to ensure valid state.

Field Summary

Fields

Modifier and Type	Field and Description
protected GitFlowConfiguration	gfConfig
protected org.eclipse.jgit.api.Git	git
protected JGitFlowReporter	reporter
protected RequirementHelper	requirementHelper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGitFlowCommand(String branchName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig)

Method Summary

Modifier and Type	Method and Description
protected void	doFetchIfNeeded(JGitFlowExtension fetchingExtension)
protected void	doPushIfNeeded(JGitFlowExtension pushExtension, boolean includeTags, String... branchesToPush)
protected RequirementHelper	enforcer()
protected void	ensureLocalBranchesNotBehindRemotes(String... branchesToTest)
String	getBranchName()
protected abstract String	getCommandName()
String	getScmMessagePrefix()
String	getScmMessageSuffix()
boolean	isAllowUntracked()
boolean	isFetch()
boolean	isPush()
protected String	runBeforeAndGetPrefixedBranchName(Iterable<ExtensionCommand> before, JGitFlowConstants.PREFIXES prefix)
protected void	runExtensionCommands(Iterable<ExtensionCommand> commands)
C	setAllowUntracked(boolean allow)
C	setFetch(boolean fetch) Set whether to perform a git fetch of the remote branches before doing the merge
C	setPush(boolean push) Set whether to push the changes to the remote repository
C	setScmMessagePrefix(String scmMessagePrefix)
C	setScmMessageSuffix(String scmMessageSuffix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Callable

call

Field Detail

git

protected final org.eclipse.jgit.api.Git git

gfConfig

protected final GitFlowConfiguration gfConfig

reporter

protected final JGitFlowReporter reporter

requirementHelper

protected final RequirementHelper requirementHelper

Constructor Detail

AbstractGitFlowCommand

protected AbstractGitFlowCommand(String branchName,
                                 org.eclipse.jgit.api.Git git,
                                 GitFlowConfiguration gfConfig)

Method Detail

doFetchIfNeeded

protected void doFetchIfNeeded(JGitFlowExtension fetchingExtension)
                        throws org.eclipse.jgit.api.errors.GitAPIException,
                               JGitFlowGitAPIException,
                               JGitFlowExtensionException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

JGitFlowGitAPIException

JGitFlowExtensionException

doPushIfNeeded

protected void doPushIfNeeded(JGitFlowExtension pushExtension,
                              boolean includeTags,
                              String... branchesToPush)
                       throws org.eclipse.jgit.api.errors.GitAPIException,
                              JGitFlowGitAPIException,
                              JGitFlowExtensionException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

JGitFlowGitAPIException

JGitFlowExtensionException

runBeforeAndGetPrefixedBranchName

protected String runBeforeAndGetPrefixedBranchName(Iterable<ExtensionCommand> before,
                                                   JGitFlowConstants.PREFIXES prefix)
                                            throws JGitFlowExtensionException

Throws:

JGitFlowExtensionException

ensureLocalBranchesNotBehindRemotes

protected void ensureLocalBranchesNotBehindRemotes(String... branchesToTest)
                                            throws JGitFlowGitAPIException,
                                                   BranchOutOfDateException,
                                                   JGitFlowIOException

Throws:

JGitFlowGitAPIException

BranchOutOfDateException

JGitFlowIOException

setAllowUntracked

public C setAllowUntracked(boolean allow)

Specified by:

setAllowUntracked in interface JGitFlowCommand

isAllowUntracked

public boolean isAllowUntracked()

Specified by:

isAllowUntracked in interface JGitFlowCommand

getScmMessagePrefix

public String getScmMessagePrefix()

Specified by:

getScmMessagePrefix in interface JGitFlowCommand

setScmMessagePrefix

public C setScmMessagePrefix(String scmMessagePrefix)

Specified by:

setScmMessagePrefix in interface JGitFlowCommand

getScmMessageSuffix

public String getScmMessageSuffix()

Specified by:

getScmMessageSuffix in interface JGitFlowCommand

setScmMessageSuffix

public C setScmMessageSuffix(String scmMessageSuffix)

Specified by:

setScmMessageSuffix in interface JGitFlowCommand

setFetch

public C setFetch(boolean fetch)

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

Specified by:

setFetch in interface JGitFlowCommand

Parameters:

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

Returns:

this

isFetch

public boolean isFetch()

Specified by:

isFetch in interface JGitFlowCommand

setPush

public C setPush(boolean push)

Set whether to push the changes to the remote repository

Specified by:

setPush in interface JGitFlowCommand

Parameters:

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

Returns:

this

isPush

public boolean isPush()

Specified by:

isPush in interface JGitFlowCommand

getBranchName

public String getBranchName()

Specified by:

getBranchName in interface JGitFlowCommand

getCommandName

protected abstract String getCommandName()

runExtensionCommands

protected void runExtensionCommands(Iterable<ExtensionCommand> commands)
                             throws JGitFlowExtensionException

Throws:

JGitFlowExtensionException

enforcer

protected RequirementHelper enforcer()