Package org.eclipse.jgit.api
Class CreateBranchCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Ref>
-
- org.eclipse.jgit.api.CreateBranchCommand
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Ref
call()
static boolean
isValidBranchName(String branchName)
Check if the given branch name is validCreateBranchCommand
setForce(boolean force)
Set whether to create the branch forcefullyCreateBranchCommand
setName(String name)
Set the name of the new branchCreateBranchCommand
setStartPoint(String startPoint)
Set the start pointCreateBranchCommand
setStartPoint(RevCommit startPoint)
Set the start pointCreateBranchCommand
setUpstreamMode(CreateBranchCommand.SetupUpstreamMode mode)
Set the upstream mode-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
CreateBranchCommand
protected CreateBranchCommand(Repository repo)
Constructor for CreateBranchCommand- Parameters:
repo
- theRepository
-
-
Method Detail
-
call
public Ref call() throws GitAPIException, RefAlreadyExistsException, RefNotFoundException, InvalidRefNameException
Execute the command
- Specified by:
call
in interfaceCallable<Ref>
- Specified by:
call
in classGitCommand<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
- iftrue
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; ifnull
, 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; ifnull
, 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 benull
- Returns:
- this instance
-
-