FilteredBranch (javadoc 2024.12-174331 API)

All Superinterfaces:

Branch

All Known Subinterfaces:

BranchEx

All Known Implementing Classes:

AbstractBuildTypeBranch, BaseFilteredBranch
```
public interface FilteredBranch
extends Branch
```
Branch that can be filtered by attributes branch filters(e.g. +pr: target=master)

Since:

2024.3

Field Summary
- Fields inherited from interface jetbrains.buildServer.serverSide.Branch
  DEFAULT_BRANCH_NAME, UNSPECIFIED_BRANCH_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SBuildType`	`getBuildType()`
`BranchFilterContext`	`getPrecalcContext()`
`FilteredBranch`	`withPrecalcContext(BranchFilterContext context)`	Sets context for the branch

Methods inherited from interface jetbrains.buildServer.serverSide.Branch
getDisplayName, getName, isDefaultBranch

- Method Detail
  - getPrecalcContext
```
@Nullable
BranchFilterContext getPrecalcContext()
```
    Returns:
    
    an optional context calculated for this branch before applying filter. This context can be calculated for branches with BranchSpecsImpl.precalculateForFiltering(SBuildType, BranchFilter)
  - withPrecalcContext
```
FilteredBranch withPrecalcContext(@Nullable
                                  BranchFilterContext context)
```
    Sets context for the branch
    
    Parameters:
    
    context - optional context that can speed up filtering for attribute filters
    
    Returns:
    
    the same branch with the context set, if the branch is to be stored somewhere, then it is recommended to create a new temporary branch for filtering, so that the context can be garbage collected after filtering is done
  - getBuildType
```
@NotNull
SBuildType getBuildType()
```
    Returns:
    
    Build type that was used to calculate the logical branch name