com.atlassian.jgitflow.core.command

Class FeatureStartCommand

java.lang.Object

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

com.atlassian.jgitflow.core.command.AbstractBranchCreatingCommand<FeatureStartCommand,org.eclipse.jgit.lib.Ref>

com.atlassian.jgitflow.core.command.FeatureStartCommand

All Implemented Interfaces:

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

public class FeatureStartCommand
extends AbstractBranchCreatingCommand<FeatureStartCommand,org.eclipse.jgit.lib.Ref>

Start a feature.

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

Examples (flow is a JGitFlow instance):

Start a feature:

 flow.featureStart("feature").call();
 

Perform a fetch of develop before branching

 flow.featureStart("feature").setFetch(true).call();
 

Field Summary

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

gfConfig, git, reporter, requirementHelper

Constructor Summary

Constructors

Constructor and Description
FeatureStartCommand(String branchName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig) Create a new feature start command instance.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Ref	call()
protected String	getCommandName()
FeatureStartCommand	setExtension(FeatureStartExtension extension)

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractBranchCreatingCommand

doCreateBranch, doPushNewBranchIfNeeded, getStartingPoint, setStartCommit, setStartCommit

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractGitFlowCommand

doFetchIfNeeded, doPushIfNeeded, enforcer, ensureLocalBranchesNotBehindRemotes, getBranchName, getScmMessagePrefix, getScmMessageSuffix, isAllowUntracked, isFetch, isPush, runBeforeAndGetPrefixedBranchName, runExtensionCommands, setAllowUntracked, setFetch, setPush, setScmMessagePrefix, setScmMessageSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureStartCommand

public FeatureStartCommand(String branchName,
                           org.eclipse.jgit.api.Git git,
                           GitFlowConfiguration gfConfig)

Create a new feature start command instance.

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

Parameters:

branchName - The name of the feature

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

Method Detail

call

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

Returns:

A reference to the new feature branch

Throws:

NotInitializedException

JGitFlowGitAPIException

LocalBranchExistsException

BranchOutOfDateException

JGitFlowIOException

LocalBranchMissingException

RemoteBranchExistsException

JGitFlowExtensionException

TagExistsException

getCommandName

protected String getCommandName()

Specified by:

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

setExtension

public FeatureStartCommand setExtension(FeatureStartExtension extension)