com.atlassian.jgitflow.core

Class HotfixStartCommand

java.lang.Object

com.atlassian.jgitflow.core.AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>

com.atlassian.jgitflow.core.HotfixStartCommand

All Implemented Interfaces:

Callable<org.eclipse.jgit.lib.Ref>

public class HotfixStartCommand
extends AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>

Start a hotfix.

This will create a new branch using the hotfix prefix and release name from the tip of develop

Examples (flow is a JGitFlow instance):

Start a feature:

 flow.hotfixStart("1.0.1").call();
 

Perform a fetch of develop before branching

 flow.hotfixStart("1.0.1").setFetch(true).call();
 

Field Summary

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

gfConfig, git, reporter

Constructor Summary

Constructors

Constructor and Description
HotfixStartCommand(String hotfixName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig, JGitFlowReporter reporter) Create a new hotfix start command instance.

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Ref	call()
protected String	getCommandName()
HotfixStartCommand	setAllowUntracked(boolean allow)
HotfixStartCommand	setFetch(boolean fetch) Set whether to perform a git fetch of the remote develop branch before branching
HotfixStartCommand	setPush(boolean push) Set whether to push the changes to the remote repository
HotfixStartCommand	setScmMessagePrefix(String scmMessagePrefix)
HotfixStartCommand	setStartCommit(org.eclipse.jgit.revwalk.RevCommit commit)
HotfixStartCommand	setStartCommit(String commitId)

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

HotfixStartCommand

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

Create a new hotfix start command instance.

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

Parameters:

hotfixName - The name of the hotfix

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

reporter -

Method Detail

setAllowUntracked

public HotfixStartCommand setAllowUntracked(boolean allow)

Overrides:

setAllowUntracked in class AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>

setScmMessagePrefix

public HotfixStartCommand setScmMessagePrefix(String scmMessagePrefix)

Overrides:

setScmMessagePrefix in class AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>

call

public org.eclipse.jgit.lib.Ref call()
                              throws NotInitializedException,
                                     JGitFlowGitAPIException,
                                     HotfixBranchExistsException,
                                     DirtyWorkingTreeException,
                                     JGitFlowIOException,
                                     LocalBranchExistsException,
                                     TagExistsException,
                                     BranchOutOfDateException,
                                     LocalBranchMissingException,
                                     RemoteBranchExistsException

Returns:

A reference to the new hotfix branch

Throws:

NotInitializedException

JGitFlowGitAPIException

HotfixBranchExistsException

DirtyWorkingTreeException

JGitFlowIOException

LocalBranchExistsException

TagExistsException

BranchOutOfDateException

LocalBranchMissingException

RemoteBranchExistsException

setFetch

public HotfixStartCommand setFetch(boolean fetch)

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

Parameters:

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

Returns:

this

setStartCommit

public HotfixStartCommand setStartCommit(String commitId)

setStartCommit

public HotfixStartCommand setStartCommit(org.eclipse.jgit.revwalk.RevCommit commit)

setPush

public HotfixStartCommand setPush(boolean push)

Set whether to push the changes to the remote repository

Parameters:

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

Returns:

this

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>