com.atlassian.jgitflow.core.util

Class GitHelper

java.lang.Object

com.atlassian.jgitflow.core.util.GitHelper

public class GitHelper
extends Object

A helper class for common Git operations

Constructor Summary

Constructors

Constructor and Description
GitHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static org.eclipse.jgit.revwalk.RevCommit	getCommitForString(org.eclipse.jgit.api.Git git, String commitId) Gets a commit for a given string with no body
static org.eclipse.jgit.revwalk.RevCommit	getLatestCommit(org.eclipse.jgit.api.Git git, String branchName) Gets the latest commit for a branch
static org.eclipse.jgit.lib.Ref	getLocalBranch(org.eclipse.jgit.api.Git git, String branchName) Gets a reference to a local branch with the given name
static org.eclipse.jgit.lib.Ref	getRemoteBranch(org.eclipse.jgit.api.Git git, String branchName) Gets a reference to a remote branch with the given name
static boolean	isMergedInto(org.eclipse.jgit.api.Git git, org.eclipse.jgit.revwalk.RevCommit commit, String branchName) Checks to see if a specific commit is merged into a branch
static boolean	isMergedInto(org.eclipse.jgit.api.Git git, String commitString, String baseBranch) Checks to see if one branch is merged into another
static List<org.eclipse.jgit.lib.Ref>	listBranchesWithPrefix(org.eclipse.jgit.api.Git git, String prefix) Gets a list of branch references that begin with the given prefix
static boolean	localBranchBehindRemote(org.eclipse.jgit.api.Git git, String branch, JGitFlowReporter reporter)
static boolean	localBranchExists(org.eclipse.jgit.api.Git git, String branchName) Checks to see if a local branch with the given name exists
static boolean	remoteBranchExists(org.eclipse.jgit.api.Git git, String branch, JGitFlowReporter reporter) Checks to see if a remote branch with the given name exists
static boolean	tagExists(org.eclipse.jgit.api.Git git, String tagName) Tests to see if a tag exists with the given name
static CleanStatus	workingTreeIsClean(org.eclipse.jgit.api.Git git, boolean allowUntracked, JGitFlowReporter reporter) Tests to see if a working folder is clean.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHelper

public GitHelper()

Method Detail

isMergedInto

public static boolean isMergedInto(org.eclipse.jgit.api.Git git,
                   String commitString,
                   String baseBranch)
                            throws LocalBranchMissingException,
                                   JGitFlowIOException,
                                   JGitFlowGitAPIException

Checks to see if one branch is merged into another

Parameters:

git - The git instance to use

commitString - The name of the commit we're testing

baseBranch - The name of the base branch to look for the merge

Returns:

if the contents of branchName has been merged into baseName

Throws:

LocalBranchMissingException

JGitFlowIOException

JGitFlowGitAPIException

getCommitForString

public static org.eclipse.jgit.revwalk.RevCommit getCommitForString(org.eclipse.jgit.api.Git git,
                                                    String commitId)
                                                             throws JGitFlowIOException,
                                                                    LocalBranchMissingException

Gets a commit for a given string with no body

Parameters:

git - The git instance to use

commitId - The name of the commit to find

Returns:

The commit

Throws:

JGitFlowIOException

LocalBranchMissingException

isMergedInto

public static boolean isMergedInto(org.eclipse.jgit.api.Git git,
                   org.eclipse.jgit.revwalk.RevCommit commit,
                   String branchName)
                            throws JGitFlowGitAPIException,
                                   JGitFlowIOException

Checks to see if a specific commit is merged into a branch

Parameters:

git - The git instance to use

commit - The commit to test

branchName - The name of the base branch to look for the merge

Returns:

if the contents of commit has been merged into baseName

Throws:

JGitFlowGitAPIException

JGitFlowIOException

getLatestCommit

public static org.eclipse.jgit.revwalk.RevCommit getLatestCommit(org.eclipse.jgit.api.Git git,
                                                 String branchName)
                                                          throws JGitFlowIOException

Gets the latest commit for a branch

Parameters:

git - The git instance to use

branchName - The name of the branch to find the commit on

Returns:

The latest commit for the branch

Throws:

JGitFlowIOException

localBranchExists

public static boolean localBranchExists(org.eclipse.jgit.api.Git git,
                        String branchName)
                                 throws JGitFlowGitAPIException

Checks to see if a local branch with the given name exists

Parameters:

git - The git instance to use

branchName - The name of the branch to look for

Returns:

if the branch exists or not

Throws:

JGitFlowGitAPIException

remoteBranchExists

public static boolean remoteBranchExists(org.eclipse.jgit.api.Git git,
                         String branch,
                         JGitFlowReporter reporter)
                                  throws JGitFlowGitAPIException

Checks to see if a remote branch with the given name exists

Parameters:

git - The git instance to use

branch - The name of the branch to look for

Returns:

if the branch exists or not

Throws:

JGitFlowGitAPIException

localBranchBehindRemote

public static boolean localBranchBehindRemote(org.eclipse.jgit.api.Git git,
                              String branch,
                              JGitFlowReporter reporter)
                                       throws JGitFlowIOException

Throws:

JGitFlowIOException

getRemoteBranch

public static org.eclipse.jgit.lib.Ref getRemoteBranch(org.eclipse.jgit.api.Git git,
                                       String branchName)
                                                throws JGitFlowIOException

Gets a reference to a remote branch with the given name

Parameters:

git - The git instance to use

branchName - The name of the remote branch

Returns:

A reference to the remote branch or null

Throws:

JGitFlowIOException

getLocalBranch

public static org.eclipse.jgit.lib.Ref getLocalBranch(org.eclipse.jgit.api.Git git,
                                      String branchName)
                                               throws JGitFlowIOException

Gets a reference to a local branch with the given name

Parameters:

git - The git instance to use

branchName - The name of the remote branch

Returns:

A reference to the local branch or null

Throws:

JGitFlowIOException

listBranchesWithPrefix

public static List<org.eclipse.jgit.lib.Ref> listBranchesWithPrefix(org.eclipse.jgit.api.Git git,
                                                    String prefix)
                                                             throws JGitFlowGitAPIException

Gets a list of branch references that begin with the given prefix

Parameters:

git - The git instance to use

prefix - The prefix to test for

Returns:

A list of branch references matching the given prefix

Throws:

JGitFlowGitAPIException

workingTreeIsClean

public static CleanStatus workingTreeIsClean(org.eclipse.jgit.api.Git git,
                             boolean allowUntracked,
                             JGitFlowReporter reporter)
                                      throws JGitFlowIOException,
                                             JGitFlowGitAPIException

Tests to see if a working folder is clean. e.g. all changes have been committed.

Parameters:

git - The git instance to use

allowUntracked -

reporter - @return if the branch is clean or not

Throws:

JGitFlowIOException

JGitFlowGitAPIException

tagExists

public static boolean tagExists(org.eclipse.jgit.api.Git git,
                String tagName)
                         throws JGitFlowGitAPIException

Tests to see if a tag exists with the given name

Parameters:

git - The git instance to use

tagName - The name of the tag to test for

Returns:

if the tag exists or not

Throws:

JGitFlowGitAPIException