public Class RemoteRemoveCommand

Class Inheritance

java.lang.Object
org.eclipse.jgit.api.GitCommand
org.eclipse.jgit.api.RemoteRemoveCommand

Imports

java.io.IOException, java.net.URISyntaxException, org.eclipse.jgit.api.errors.GitAPIException, .JGitInternalException, org.eclipse.jgit.lib.ConfigConstants, .Repository, .StoredConfig, org.eclipse.jgit.transport.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

Modifier and Type	Field and Description
private String	remoteName

Inherited from org.eclipse.jgit.api.GitCommand:: repo

Constructor Summary

Access	Constructor and Description
protected	RemoteRemoveCommand(Repository the `org.eclipse.jgit.lib.Repository` repo) Constructor for RemoteRemoveCommand.

Method Summary

Modifier and Type	Method and Description
public RemoteConfig	call() Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
public RemoteRemoveCommand	Returns: `this` setRemoteName(String a remote name remoteName) The name of the remote to remove.

Inherited from org.eclipse.jgit.api.GitCommand:: checkCallable getRepository setCallable

Field Detail

remoteName	back to summary
private String remoteName

Constructor Detail

RemoteRemoveCommand back to summary

RemoteRemoveCommand	back to summary
protected RemoteRemoveCommand(Repository repo) Constructor for RemoteRemoveCommand. Parameters repo:Repository the `org.eclipse.jgit.lib.Repository`

protected RemoteRemoveCommand(Repository repo)

Constructor for RemoteRemoveCommand.

Parameters

repo:Repository: the org.eclipse.jgit.lib.Repository

Method Detail

call back to summary

call	back to summary
public RemoteConfig call() throws GitAPIException Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Doc from org.eclipse.jgit.api.GitCommand.call. Computes a result, or throws an exception if unable to do so. Execute the command Executes the `remote` command with all the options and parameters collected by the setter methods of this class. Returns:RemoteConfig Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

public RemoteConfig call() throws GitAPIException

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Doc from org.eclipse.jgit.api.GitCommand.call.

Computes a result, or throws an exception if unable to do so.

Execute the command

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

Returns:RemoteConfig

Doc from java.util.concurrent.Callable.call.

computed result

Annotations

@Override

setRemoteName back to summary

setRemoteName	back to summary
public RemoteRemoveCommand setRemoteName(String remoteName) The name of the remote to remove. Parameters remoteName:String a remote name Returns:RemoteRemoveCommand `this` Since 5.3

public RemoteRemoveCommand setRemoteName(String remoteName)

The name of the remote to remove.

Parameters

remoteName:String: a remote name

Returns:RemoteRemoveCommand

this

Since

5.3