com.atlassian.jgitflow.core

Class FeatureStartCommand

java.lang.Object

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

com.atlassian.jgitflow.core.FeatureStartCommand

All Implemented Interfaces:

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

public class FeatureStartCommand
extends AbstractGitFlowCommand<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").setFetchDevelop(true).call();
 

Field Summary

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

gfConfig, git, reporter

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Ref	call()
protected String	getCommandName()
FeatureStartCommand	setAllowUntracked(boolean allow)
FeatureStartCommand	setFetchDevelop(boolean fetch) Set whether to perform a git fetch of the remote develop branch before branching
FeatureStartCommand	setPush(boolean push) Set whether to push the changes to the remote repository
FeatureStartCommand	setScmMessagePrefix(String scmMessagePrefix)
FeatureStartCommand	setStartCommit(org.eclipse.jgit.revwalk.RevCommit commit)
FeatureStartCommand	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

Method Detail

setAllowUntracked

public FeatureStartCommand setAllowUntracked(boolean allow)

Overrides:

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

setScmMessagePrefix

public FeatureStartCommand setScmMessagePrefix(String scmMessagePrefix)

Overrides:

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

call

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

Returns:

A reference to the new feature branch

Throws:

NotInitializedException

JGitFlowGitAPIException

LocalBranchExistsException

BranchOutOfDateException

JGitFlowIOException

LocalBranchMissingException

RemoteBranchExistsException

setFetchDevelop

public FeatureStartCommand setFetchDevelop(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

setPush

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

setStartCommit

public FeatureStartCommand setStartCommit(String commitId)

setStartCommit

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

getCommandName

protected String getCommandName()

Specified by:

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