org.eclipse.jgit.api

Class RemoteSetUrlCommand

java.lang.Object

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

org.eclipse.jgit.api.RemoteSetUrlCommand

All Implemented Interfaces:

Callable<RemoteConfig>

public class RemoteSetUrlCommand
extends GitCommand<RemoteConfig>

Used to to change the URL of a 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	RemoteSetUrlCommand(Repository repo)

Method Summary

Methods

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 change the URL for.
void	setPush(boolean push) Whether to change the push URL of the remote instead of the fetch URL.
void	setUri(URIish uri) The new URL for the 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

RemoteSetUrlCommand

protected RemoteSetUrlCommand(Repository repo)

Parameters:

repo -

Method Detail

setName

public void setName(String name)

The name of the remote to change the URL for.

Parameters:

name - a remote name

setUri

public void setUri(URIish uri)

The new URL for the remote.

Parameters:

uri - an URL for the remote

setPush

public void setPush(boolean push)

Whether to change the push URL of the remote instead of the fetch URL.

Parameters:

push - true to set the push url, false to set the fetch url

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 modified remote

Throws:

GitAPIException - or subclass thereof when an error occurs