Package jetbrains.buildServer.serverSide.vcs

Interface VcsLabelManager

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

VcsLabeler

public interface VcsLabelManager
extends ServerExtension

Updates and provides information about vcs labels made by TeamCity

Method Summary

Modifier and Type	Method	Description
List<VcsLabel>	getLabels(Build build)	Returns all labels for the given build
boolean	isLabelingSupported(SBuild build, VcsRootInstance root)	Returns if it is possible to label the given build on the given vcs root.
void	setLabel(SBuild build, String labelValue, String message, List<VcsRootInstance> rootToLabel)
void	setLabel(SBuild build, String labelValue, List<VcsRootInstance> rootsToLabel)	Sets label for the specified build on the specified vcs roots.

Method Detail

getLabels

@NotNull
List<VcsLabel> getLabels(@NotNull
                         Build build)

Returns all labels for the given build

Parameters:

build - specified build instance.

Returns:

collection of labels set by TeamCity for the given build sources.

setLabel

void setLabel(@NotNull
              SBuild build,
              @NotNull
              String labelValue,
              @NotNull
              List<VcsRootInstance> rootsToLabel)
       throws VcsException

Sets label for the specified build on the specified vcs roots.

Parameters:

build - specified build.

labelValue - specified label text.

rootsToLabel - roots to label list.

Throws:

VcsException - problem to set label in version control.

setLabel

void setLabel(@NotNull
              SBuild build,
              @NotNull
              String labelValue,
              @Nullable
              String message,
              @NotNull
              List<VcsRootInstance> rootToLabel)
       throws VcsException

Throws:

VcsException

isLabelingSupported

boolean isLabelingSupported(@NotNull
                            SBuild build,
                            @NotNull
                            VcsRootInstance root)

Returns if it is possible to label the given build on the given vcs root.

Parameters:

build - specified build.

root - specified root.

Returns:

true if the root supports labeling and revision of the root fpr the build is not a null, false otherwise.