SVcsRootUsages (javadoc 2024.12-174331 API)

All Known Subinterfaces:

SVcsRoot, SVcsRootEx

All Known Implementing Classes:

DeletedVcsRoot, InaccessibleVcsRoot, MockSVcsRoot, SecuredVcsRoot, SVcsRootImpl
```
public interface SVcsRootUsages
```
Created 22.08.13 17:34

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getNumberOfUsagesInProjects()`
`SProject`	`getProject()`
`VcsRootScope`	`getScope()`	Returns scope of this VCS root
`Map<SBuildType,CheckoutRules>`	`getUsages()`	Deprecated. Since 10.0, consider using `getUsagesInConfigurations()`.
`List<SBuildType>`	`getUsagesInConfigurations()`
`Collection<SProject>`	`getUsagesInProjects()`
`boolean`	`isUsedInProjects()`

- Method Detail
  - getProject
```
@NotNull
SProject getProject()
```
    Returns:
    
    project this VCS root belongs to
    
    Since:
    
    8.0
  - getScope
```
@NotNull
VcsRootScope getScope()
```
    Returns scope of this VCS root
    
    Returns:
    
    scope of this VCS root
  - getUsagesInConfigurations
```
@NotNull
List<SBuildType> getUsagesInConfigurations()
```
    Returns:
    
    All configurations where this VCS Root is used (excluding VCS settings usages). Works faster than getUsages()
    
    Since:
    
    10.0
  - getUsages
```
@NotNull
Map<SBuildType,CheckoutRules> getUsages()
```
    Deprecated.
    Since 10.0, consider using getUsagesInConfigurations().
    
    Returns:
    
    This method returns all usages of this VCS root in various build configurations + its checkout rules
    
    Since:
    
    6.5
  - getNumberOfUsagesInProjects
```
int getNumberOfUsagesInProjects()
```
    Returns:
    
    number of projects using this VCS root in their templates or configurations.
    
    Since:
    
    8.0
  - isUsedInProjects
```
boolean isUsedInProjects()
```
    Returns:
    
    true if getNumberOfUsagesInProjects() is positive, but works faster because it does not count all of the usages
    
    Since:
    
    2021.1
  - getUsagesInProjects
```
@NotNull
Collection<SProject> getUsagesInProjects()
```
    Returns:
    
    projects using this VCS root in their templates or configurations.
    
    Since:
    
    8.0