Package jetbrains.buildServer.serverSide

Interface BranchEx

All Superinterfaces:

Branch, Comparable<BranchEx>, FilteredBranch

All Known Implementing Classes:

AbstractBuildTypeBranch

public interface BranchEx
extends FilteredBranch, Comparable<BranchEx>

Represents a branch with associated data in a build type.

Since:

7.1

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Field Summary

Fields inherited from interface jetbrains.buildServer.serverSide.Branch

DEFAULT_BRANCH_NAME, UNSPECIFIED_BRANCH_NAME

Method Summary

Modifier and Type	Method	Description
SBuildType	getBuildType()
List<ChangeDescriptor>	getDetectedChanges(ChangesCalculationOptionsEx options)
List<ChangeDescriptor>	getDetectedChanges(SelectPrevBuildPolicy prevBuildPolicy, Boolean includeDependencyChanges)	Returns changes detected in the branch according to previous build policy.
List<ChangeDescriptor>	getDetectedChanges(SelectPrevBuildPolicy prevBuildPolicy, Boolean includeDependencyChanges, VcsModificationProcessor callback)
DummyBuild	getDummyBuild()
DummyBuildPromotion	getDummyBuildPromotion()
SFinishedBuild	getLastChangesFinished()	Returns the last finished build for the branch, or null
SBuild	getLastChangesStarted()
SFinishedBuild	getLastChangesSuccessfullyFinished()	Returns the last successfully finished build for the branch, or null
SFinishedBuild	getLastFinished()
SBuild	getLastStarted()
List<SBuild>	getLatestBuilds()
List<SQueuedBuild>	getQueuedBuilds(SUser user)
List<SRunningBuild>	getRunningBuilds(SUser user)
Status	getStatus()
BuildTypeStatusDescriptor	getStatusDescriptor()
Date	getTimestamp()
boolean	isActive()	Returns whether this branch is active in a build type it belongs to.

Methods inherited from interface jetbrains.buildServer.serverSide.Branch

getDisplayName, getName, isDefaultBranch

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jetbrains.buildServer.serverSide.FilteredBranch

getPrecalcContext, withPrecalcContext

Method Detail

getLastChangesFinished

@Nullable
SFinishedBuild getLastChangesFinished()

Returns the last finished build for the branch, or null

Returns:

last finished build

getLastChangesSuccessfullyFinished

@Nullable
SFinishedBuild getLastChangesSuccessfullyFinished()

Returns the last successfully finished build for the branch, or null

Returns:

last successfully finished build

getLastChangesStarted

@Nullable
SBuild getLastChangesStarted()

Returns:

a started build (finished or running) which took latest changes in this branch

getLastStarted

@Nullable
SBuild getLastStarted()

Returns:

last started build

Since:

2017.2

getLastFinished

@Nullable
SFinishedBuild getLastFinished()

Returns:

last finished build

Since:

2017.2

getDetectedChanges

@NotNull
List<ChangeDescriptor> getDetectedChanges(@NotNull
                                          SelectPrevBuildPolicy prevBuildPolicy,
                                          @Nullable
                                          Boolean includeDependencyChanges)

Returns changes detected in the branch according to previous build policy.

Parameters:

prevBuildPolicy -

includeDependencyChanges - whether to include changes from dependencies (true), include only if show changes from deps option is enabled (null), or do not include - false

Returns:

getDetectedChanges

@NotNull
List<ChangeDescriptor> getDetectedChanges(@NotNull
                                          SelectPrevBuildPolicy prevBuildPolicy,
                                          @Nullable
                                          Boolean includeDependencyChanges,
                                          @NotNull
                                          VcsModificationProcessor callback)

getDetectedChanges

@NotNull
List<ChangeDescriptor> getDetectedChanges(@NotNull
                                          ChangesCalculationOptionsEx options)

getDummyBuild

@NotNull
DummyBuild getDummyBuild()

Returns:

dummy build corresponding to this branch

getDummyBuildPromotion

@NotNull
DummyBuildPromotion getDummyBuildPromotion()

Returns:

dummy promotion corresponding to this branch, same as getDummyBuild().getBuildPromotion, but faster because it avoids creation of dummy build

getBuildType

@NotNull
SBuildType getBuildType()

Specified by:

getBuildType in interface FilteredBranch

Returns:

Build type that was used to calculate the logical branch name

getStatus

@NotNull
Status getStatus()

Returns:

branch status calculated by latest builds

getStatusDescriptor

@NotNull
BuildTypeStatusDescriptor getStatusDescriptor()

Returns:

branch status descriptor calculated by latest builds

getLatestBuilds

@NotNull
List<SBuild> getLatestBuilds()

Returns:

latest builds ordered by changes (currently running and last finished)

getRunningBuilds

@NotNull
List<SRunningBuild> getRunningBuilds(@Nullable
                                     SUser user)

Parameters:

user - if specified, the result should include personal builds of the user

Returns:

running builds for this branch

getQueuedBuilds

@NotNull
List<SQueuedBuild> getQueuedBuilds(@Nullable
                                   SUser user)

Parameters:

user - If user is null or has "Show personal builds of other users" enabled, returns all queued builds including all personal builds. Otherwise, returns non-personal queued builds and personal builds of the specified user.

Returns:

queued builds for this branch

isActive

boolean isActive()

Returns whether this branch is active in a build type it belongs to. This means that buildType.getActiveBranches() returns it too.

Returns:

true iff the branch is active

getTimestamp

@Nullable
Date getTimestamp()