org.eclipse.jgit.api

Class RemoteRemoveCommand

java.lang.Object

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

org.eclipse.jgit.api.RemoteRemoveCommand

All Implemented Interfaces:

Callable<RemoteConfig>

public class RemoteRemoveCommand
extends GitCommand<RemoteConfig>

Used to remove an existing remote. This class has setters for all supported options and arguments of this command and a call() method to finally execute the command.

Since:

4.2

See Also:

Git documentation about Remote

Field Summary

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

repo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteRemoveCommand(Repository repo)

Method Summary

Modifier and Type	Method and Description
RemoteConfig	call() Executes the remote command with all the options and parameters collected by the setter methods of this class.
void	setName(String name) The name of the remote to remove.

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

RemoteRemoveCommand

protected RemoteRemoveCommand(Repository repo)

Parameters:

repo -

Method Detail

setName

public void setName(String name)

The name of the remote to remove.

Parameters:

name - a remote name

call

public RemoteConfig call()
                  throws GitAPIException

Executes the remote command with all the options and parameters collected by the setter methods of this class.

Specified by:

call in interface Callable<RemoteConfig>

Specified by:

call in class GitCommand<RemoteConfig>

Returns:

the RemoteConfig object of the removed remote

Throws:

GitAPIException - or subclass thereof when an error occurs