Module org.eclipse.jgit

Package 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 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RemoteSetUrlCommand.UriType	The available URI types for the remote.

Field Summary

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

repo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteSetUrlCommand(Repository repo)	Constructor for RemoteSetUrlCommand.

Method Summary

Modifier and Type	Method	Description
RemoteConfig	call()
RemoteSetUrlCommand	setRemoteName(String remoteName)	The name of the remote to change the URL for.
RemoteSetUrlCommand	setRemoteUri(URIish remoteUri)	The new URL for the remote.
RemoteSetUrlCommand	setUriType(RemoteSetUrlCommand.UriType type)	Whether to change the push URL of the remote instead of the fetch URL.

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 Details

RemoteSetUrlCommand

protected RemoteSetUrlCommand(Repository repo)

Constructor for RemoteSetUrlCommand.

Parameters:

repo - the Repository

Method Details

setRemoteName

public RemoteSetUrlCommand setRemoteName(String remoteName)

The name of the remote to change the URL for.

Parameters:

remoteName - a remote remoteName

Returns:

this

Since:

5.3

setRemoteUri

public RemoteSetUrlCommand setRemoteUri(URIish remoteUri)

The new URL for the remote.

Parameters:

remoteUri - an URL for the remote

Returns:

this

Since:

5.3

setUriType

public RemoteSetUrlCommand setUriType(RemoteSetUrlCommand.UriType type)

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

Parameters:

type - the UriType value to set

Returns:

this

Since:

5.3

call

public RemoteConfig call()
                  throws GitAPIException

Execute the command

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>

Throws:

GitAPIException