org.eclipse.jgit.api

Class RemoteAddCommand

java.lang.Object

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

org.eclipse.jgit.api.RemoteAddCommand

All Implemented Interfaces:

Callable<RemoteConfig>

public class RemoteAddCommand
extends GitCommand<RemoteConfig>

Used to add a new 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	RemoteAddCommand(Repository repo)

Method Summary

Methods

Modifier and Type	Method and Description
RemoteConfig	call() Executes the remote add 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 add.
void	setUri(URIish uri) The URL of the repository for the new remote.

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

RemoteAddCommand

protected RemoteAddCommand(Repository repo)

Parameters:

repo -

Method Detail

setName

public void setName(String name)

The name of the remote to add.

Parameters:

name - a remote name

setUri

public void setUri(URIish uri)

The URL of the repository for the new remote.

Parameters:

uri - an URL for the remote

call

public RemoteConfig call()
                  throws GitAPIException

Executes the remote add 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 added remote

Throws:

GitAPIException - or subclass thereof when an error occurs