Module org.eclipse.jgit

Package org.eclipse.jgit.api

Class CreateBranchCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Ref>

org.eclipse.jgit.api.CreateBranchCommand

All Implemented Interfaces:

Callable<Ref>

public class CreateBranchCommand
extends GitCommand<Ref>

Used to create a local branch.

See Also:

Git documentation about Branch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateBranchCommand.SetupUpstreamMode	The modes available for setting up the upstream configuration (corresponding to the --set-upstream, --track, --no-track options

Field Summary

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CreateBranchCommand(Repository repo)	Constructor for CreateBranchCommand

Method Summary

Modifier and Type	Method	Description
Ref	call()
static boolean	isValidBranchName(String branchName)	Check if the given branch name is valid
CreateBranchCommand	setForce(boolean force)	Set whether to create the branch forcefully
CreateBranchCommand	setName(String name)	Set the name of the new branch
CreateBranchCommand	setStartPoint(String startPoint)	Set the start point
CreateBranchCommand	setStartPoint(RevCommit startPoint)	Set the start point
CreateBranchCommand	setUpstreamMode(CreateBranchCommand.SetupUpstreamMode mode)	Set the upstream mode

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateBranchCommand

protected CreateBranchCommand(Repository repo)

Constructor for CreateBranchCommand

Parameters:

repo - the Repository

Method Detail

call

public Ref call()
         throws GitAPIException,
                RefAlreadyExistsException,
                RefNotFoundException,
                InvalidRefNameException

Execute the command

Specified by:

call in interface Callable<Ref>

Specified by:

call in class GitCommand<Ref>

Throws:

GitAPIException

RefAlreadyExistsException

RefNotFoundException

InvalidRefNameException

isValidBranchName

public static boolean isValidBranchName(String branchName)

Check if the given branch name is valid

Parameters:

branchName - branch name to check

Returns:

true if the branch name is valid

Since:

5.0

setName

public CreateBranchCommand setName(String name)

Set the name of the new branch

Parameters:

name - the name of the new branch

Returns:

this instance

setForce

public CreateBranchCommand setForce(boolean force)

Set whether to create the branch forcefully

Parameters:

force - if true and the branch with the given name already exists, the start-point of an existing branch will be set to a new start-point; if false, the existing branch will not be changed

Returns:

this instance

setStartPoint

public CreateBranchCommand setStartPoint(String startPoint)

Set the start point

Parameters:

startPoint - corresponds to the start-point option; if null, the current HEAD will be used

Returns:

this instance

setStartPoint

public CreateBranchCommand setStartPoint(RevCommit startPoint)

Set the start point

Parameters:

startPoint - corresponds to the start-point option; if null, the current HEAD will be used

Returns:

this instance

setUpstreamMode

public CreateBranchCommand setUpstreamMode(CreateBranchCommand.SetupUpstreamMode mode)

Set the upstream mode

Parameters:

mode - corresponds to the --track/--no-track/--set-upstream options; may be null

Returns:

this instance