Package jetbrains.buildServer.vcshostings.github

Class GitHubVcsInformationProvider

java.lang.Object

jetbrains.buildServer.vcshostings.github.GitHubVcsInformationProvider

All Implemented Interfaces:

VcsInformationProvider

public class GitHubVcsInformationProvider
extends Object
implements VcsInformationProvider

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.vcshostings.VcsInformationProvider

VcsInformationProvider.Capabilities

Constructor Summary

Constructors

Constructor	Description
GitHubVcsInformationProvider(jetbrains.buildServer.vcshostings.github.GitHubFacade gitHubFacade)

Method Summary

Modifier and Type	Method	Description
VcsSearch<VcsBranches>	branches(String repositoryName)
EnumSet<VcsInformationProvider.Capabilities>	getCapabilities()
String	getDefaultBranch(String repository)	Obtains the default branch reference for a repository
VcsSearch<VcsRepositories>	repositories()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitHubVcsInformationProvider

public GitHubVcsInformationProvider(@NotNull
                                    jetbrains.buildServer.vcshostings.github.GitHubFacade gitHubFacade)

Method Detail

repositories

@NotNull
public VcsSearch<VcsRepositories> repositories()

Specified by:

repositories in interface VcsInformationProvider

Returns:

an instance of an object for listing/search of repositories

branches

@NotNull
public VcsSearch<VcsBranches> branches(String repositoryName)

Specified by:

branches in interface VcsInformationProvider

Returns:

an instance of an object for listing/search of branches

getDefaultBranch

@Nullable
public String getDefaultBranch(@NotNull
                               String repository)
                        throws IOException

Description copied from interface: VcsInformationProvider

Obtains the default branch reference for a repository

Specified by:

getDefaultBranch in interface VcsInformationProvider

Parameters:

repository - full repository name with an owner, e.g. "JohnSmith/myrepo"

Returns:

default branch reference (e.g. "refs/heads/main") or null if such a repository has not been found

Throws:

IOException

getCapabilities

@NotNull
public EnumSet<VcsInformationProvider.Capabilities> getCapabilities()

Specified by:

getCapabilities in interface VcsInformationProvider

Returns:

capabilities of the provider