BranchGroupsProvider (javadoc 2024.12-174331 API)

All Superinterfaces:

PositionAware, PositionConstraintAware, ServerExtension, TeamCityExtension

All Known Implementing Classes:

BranchGroupsMyBranchesProvider, BranchGroupsUserSelectedProvider
```
public interface BranchGroupsProvider
extends ServerExtension, PositionAware
```
Author:

Yegor.Yarko Date: 25/06/2018

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class BranchGroupsProvider.BranchGroup

static class BranchGroupsProvider.Context

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`collectBranches(String branchGroupId, BranchGroupsProvider.Context context, ItemProcessor<BranchEx> processor)`	Should exit fast on branchGroupId which is not supported by this provider
`List<BranchGroupsProvider.BranchGroup>`	`getAvailableBranchGroups(BranchGroupsProvider.Context context)`	Reports the branch groups which this extension supports via collectBranches method
`String`	`getId()`	unique id of this extension.
`default String`	`getOrderId()`	Returns object id that can be referenced by {`PositionConstraint`}

Methods inherited from interface jetbrains.buildServer.util.positioning.PositionConstraintAware
getConstraint

- Method Detail
  - getId
```
@NotNull
String getId()
```
    unique id of this extension. Should be a valid Java identifier
  - getAvailableBranchGroups
```
List<BranchGroupsProvider.BranchGroup> getAvailableBranchGroups(@NotNull
                                                                BranchGroupsProvider.Context context)
```
    Reports the branch groups which this extension supports via collectBranches method
  - collectBranches
```
boolean collectBranches(@NotNull
                        String branchGroupId,
                        @NotNull
                        BranchGroupsProvider.Context context,
                        @NotNull
                        ItemProcessor<BranchEx> processor)
```
    Should exit fast on branchGroupId which is not supported by this provider
    
    Parameters:
    
    branchGroupId - id which can match id from earlier returned BranchGroup via getAvailableBranchGroups method
    
    context -
    
    processor -
    
    Returns:
    
    true if branchGroupId belongs to this provider (and matching branches. if any were fed to processor), false otherwise
  - getOrderId
```
@NotNull
default String getOrderId()
```
    Description copied from interface: PositionAware
    
    Returns object id that can be referenced by {PositionConstraint}
    
    Specified by:
    
    getOrderId in interface PositionAware
    
    Returns:
    
    object id