org.eclipse.jgit.api

Class RemoteListCommand

java.lang.Object

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

org.eclipse.jgit.api.RemoteListCommand

All Implemented Interfaces:

Callable<List<RemoteConfig>>

public class RemoteListCommand
extends GitCommand<List<RemoteConfig>>

Used to obtain the list of remotes. 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	RemoteListCommand(Repository repo)

Method Summary

Modifier and Type	Method and Description
List<RemoteConfig>	call() Executes the remote command with all the options and parameters collected by the setter methods of this class.

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

RemoteListCommand

protected RemoteListCommand(Repository repo)

Parameters:

repo -

Method Detail

call

public List<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<List<RemoteConfig>>

Specified by:

call in class GitCommand<List<RemoteConfig>>

Returns:

a list of RemoteConfig objects.

Throws:

GitAPIException - or subclass thereof when an error occurs