com.atlassian.jgitflow.core.util

Class RequirementHelper

java.lang.Object

com.atlassian.jgitflow.core.util.RequirementHelper

public class RequirementHelper
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RequirementHelper(org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig, String commandName)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

git

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

gfConfig

protected final GitFlowConfiguration gfConfig

reporter

protected final JGitFlowReporter reporter

commandName

protected final String commandName

Constructor Detail

RequirementHelper

public RequirementHelper(org.eclipse.jgit.api.Git git,
                         GitFlowConfiguration gfConfig,
                         String commandName)

Method Detail

requireGitFlowInitialized

public void requireGitFlowInitialized()
                               throws NotInitializedException,
                                      JGitFlowGitAPIException

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

Throws:

NotInitializedException

JGitFlowGitAPIException

requireLocalBranchAbsent

public 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

public 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

public 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

public 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

public 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

public 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

public void requireCleanWorkingTree(boolean allowUntracked)
                             throws DirtyWorkingTreeException,
                                    JGitFlowIOException,
                                    JGitFlowGitAPIException

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

Throws:

DirtyWorkingTreeException

JGitFlowIOException

JGitFlowGitAPIException

requireNoExistingReleaseBranches

public void requireNoExistingReleaseBranches()
                                      throws ReleaseBranchExistsException,
                                             JGitFlowGitAPIException

Requires that no release branches already exist

Throws:

ReleaseBranchExistsException

JGitFlowGitAPIException

requireNoExistingHotfixBranches

public void requireNoExistingHotfixBranches()
                                     throws HotfixBranchExistsException,
                                            JGitFlowGitAPIException

Requires that no hotfix branches already exist

Throws:

HotfixBranchExistsException

JGitFlowGitAPIException

requireCommitOnBranch

public 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:

LocalBranchExistsException

JGitFlowGitAPIException

JGitFlowIOException