VcsInformationProvider (javadoc 2024.12-174331 API)

All Known Implementing Classes:

BitBucketVcsInformationProvider, GitHubVcsInformationProvider, GitLabVcsInformationProvider
```
public interface VcsInformationProvider
```
VCS information provider

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class VcsInformationProvider.Capabilities
Provider capabilities

Method Summary

All Methods Instance Methods Abstract Methods
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()`

- Method Detail
  - repositories
```
@NotNull
VcsSearch<VcsRepositories> repositories()
```
    Returns:
    
    an instance of an object for listing/search of repositories
  - branches
```
@NotNull
VcsSearch<VcsBranches> branches(String repositoryName)
```
    Returns:
    
    an instance of an object for listing/search of branches
  - getDefaultBranch
```
@Nullable
String getDefaultBranch(@NotNull
                        String repository)
                 throws IOException
```
    Obtains the default branch reference for a repository
    
    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
EnumSet<VcsInformationProvider.Capabilities> getCapabilities()
```
    Returns:
    
    capabilities of the provider