com.atlassian.jgitflow.core

Class AbstractGitFlowCommand<T>

java.lang.Object

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

Type Parameters:

T - The return type of the call() method

All Implemented Interfaces:

Callable<T>

Direct Known Subclasses:

FeatureFinishCommand, FeaturePublishCommand, FeatureRebaseCommand, FeatureStartCommand, HotfixFinishCommand, HotfixPublishCommand, HotfixStartCommand, ReleaseFinishCommand, ReleasePublishCommand, ReleaseStartCommand

public abstract class AbstractGitFlowCommand<T>
extends Object
implements Callable<T>

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getCommandName()
String	getScmMessagePrefix()
boolean	isAllowUntracked()
protected void	requireCleanWorkingTree() Requires that the local working tree has no un-committed changes
protected void	requireCommitOnBranch(org.eclipse.jgit.revwalk.RevCommit commit, String branch) Requires that a local branch contains the given commit
protected void	requireGitFlowInitialized() Requires that git flow has been initialized for the project represented by the internal {Git} instance
protected void	requireLocalBranchAbsent(String branch) Requires that a local branch with the given name does not yet exist
protected void	requireLocalBranchExists(String branch) Requires that a local branch with the given name exists
protected void	requireLocalBranchNotBehindRemote(String branch) Requires that the local branch with the given name is not behind a remote brach with the same name
protected void	requireNoExistingHotfixBranches() Requires that no hotfix branches already exist
protected void	requireNoExistingReleaseBranches() Requires that no release branches already exist
protected void	requireRemoteBranchAbsent(String branch) Requires that a remote branch with the given name does not yet exist
protected void	requireRemoteBranchExists(String branch) Requires that a remote branch with the given name exists
protected void	requireTagAbsent(String name) Requires that a tag with the given name does not yet exist
AbstractGitFlowCommand	setAllowUntracked(boolean allow)
AbstractGitFlowCommand	setScmMessagePrefix(String scmMessagePrefix)

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

Constructor Detail

AbstractGitFlowCommand

protected AbstractGitFlowCommand(org.eclipse.jgit.api.Git git,
                      GitFlowConfiguration gfConfig,
                      JGitFlowReporter reporter)

Method Detail

setAllowUntracked

public AbstractGitFlowCommand setAllowUntracked(boolean allow)

isAllowUntracked

public boolean isAllowUntracked()

getScmMessagePrefix

public String getScmMessagePrefix()

setScmMessagePrefix

public AbstractGitFlowCommand setScmMessagePrefix(String scmMessagePrefix)

requireGitFlowInitialized

protected void requireGitFlowInitialized()
                                  throws NotInitializedException,
                                         JGitFlowGitAPIException

Requires that git flow has been initialized for the project represented by the internal {Git} instance

Throws:

NotInitializedException

JGitFlowGitAPIException

getCommandName

protected abstract String getCommandName()

requireLocalBranchAbsent

protected void requireLocalBranchAbsent(String branch)
                                 throws LocalBranchExistsException,
                                        JGitFlowGitAPIException

Requires that a local branch with the given name does not yet exist

Parameters:

branch - the name of the branch to test

Throws:

LocalBranchExistsException

JGitFlowGitAPIException

requireLocalBranchExists

protected void requireLocalBranchExists(String branch)
                                 throws LocalBranchMissingException,
                                        JGitFlowGitAPIException

Requires that a local branch with the given name exists

Parameters:

branch - The name of the branch to test

Throws:

LocalBranchMissingException

JGitFlowGitAPIException

requireRemoteBranchAbsent

protected void requireRemoteBranchAbsent(String branch)
                                  throws RemoteBranchExistsException,
                                         JGitFlowGitAPIException

Requires that a remote branch with the given name does not yet exist

Parameters:

branch - The name of the branch to test

Throws:

RemoteBranchExistsException

JGitFlowGitAPIException

requireRemoteBranchExists

protected void requireRemoteBranchExists(String branch)
                                  throws RemoteBranchMissingException,
                                         JGitFlowGitAPIException

Requires that a remote branch with the given name exists

Parameters:

branch - The name of the branch to test

Throws:

RemoteBranchMissingException

JGitFlowGitAPIException

requireTagAbsent

protected void requireTagAbsent(String name)
                         throws TagExistsException,
                                JGitFlowGitAPIException

Requires that a tag with the given name does not yet exist

Parameters:

name - The name of the tag to test

Throws:

TagExistsException

JGitFlowGitAPIException

requireLocalBranchNotBehindRemote

protected void requireLocalBranchNotBehindRemote(String branch)
                                          throws BranchOutOfDateException,
                                                 JGitFlowIOException

Requires that the local branch with the given name is not behind a remote brach with the same name

Parameters:

branch - The name of the branch to test

Throws:

BranchOutOfDateException

JGitFlowIOException

requireCleanWorkingTree

protected void requireCleanWorkingTree()
                                throws DirtyWorkingTreeException,
                                       JGitFlowIOException,
                                       JGitFlowGitAPIException

Requires that the local working tree has no un-committed changes

Throws:

DirtyWorkingTreeException

JGitFlowIOException

JGitFlowGitAPIException

requireNoExistingReleaseBranches

protected void requireNoExistingReleaseBranches()
                                         throws ReleaseBranchExistsException,
                                                JGitFlowGitAPIException

Requires that no release branches already exist

Throws:

ReleaseBranchExistsException

JGitFlowGitAPIException

requireNoExistingHotfixBranches

protected void requireNoExistingHotfixBranches()
                                        throws HotfixBranchExistsException,
                                               JGitFlowGitAPIException

Requires that no hotfix branches already exist

Throws:

HotfixBranchExistsException

JGitFlowGitAPIException

requireCommitOnBranch

protected void requireCommitOnBranch(org.eclipse.jgit.revwalk.RevCommit commit,
                         String branch)
                              throws LocalBranchExistsException,
                                     JGitFlowGitAPIException,
                                     JGitFlowIOException

Requires that a local branch contains the given commit

Parameters:

commit - the commit to test

branch - the name of the branch to check

Throws:

LocalBranchMissingException

JGitFlowGitAPIException

LocalBranchExistsException

JGitFlowIOException