Module org.eclipse.jgit

Package org.eclipse.jgit.api

Class DeleteBranchCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<List<String>>

org.eclipse.jgit.api.DeleteBranchCommand

All Implemented Interfaces:

Callable<List<String>>

public class DeleteBranchCommand
extends GitCommand<List<String>>

Used to delete one or several branches. The result of call() is a list with the (full) names of the deleted branches. Note that we don't have a setter corresponding to the -r option; remote tracking branches are simply deleted just like local branches.

See Also:

Git documentation about Branch

Field Summary

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

repo

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<String>	call()
DeleteBranchCommand	setBranchNames(String... branchnames)	Set the names of the branches to delete
DeleteBranchCommand	setForce(boolean force)	Set whether to forcefully delete branches

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

DeleteBranchCommand

protected DeleteBranchCommand(Repository repo)

Constructor for DeleteBranchCommand

Parameters:

repo - the Repository

Method Detail

call

public List<String> call()
                  throws GitAPIException,
                         NotMergedException,
                         CannotDeleteCurrentBranchException

Execute the command

Specified by:

call in interface Callable<List<String>>

Specified by:

call in class GitCommand<List<String>>

Throws:

GitAPIException

NotMergedException

CannotDeleteCurrentBranchException

setBranchNames

public DeleteBranchCommand setBranchNames(String... branchnames)

Set the names of the branches to delete

Parameters:

branchnames - the names of the branches to delete; if not set, this will do nothing; invalid branch names will simply be ignored

Returns:

this instance

setForce

public DeleteBranchCommand setForce(boolean force)

Set whether to forcefully delete branches

Parameters:

force - true corresponds to the -D option, false to the -d option (default)
if false a check will be performed whether the branch to be deleted is already merged into the current branch and deletion will be refused in this case

Returns:

this instance