Package jetbrains.buildServer.vcs

Interface LabelingSupport

All Superinterfaces:

VcsExtension

public interface LabelingSupport
extends VcsExtension

To offer a labeling for a VCS support the developer must implement this interface.

Method Summary

Modifier and Type	Method	Description
default String	label(String label, String message, String version, VcsRoot root, CheckoutRules checkoutRules)	Labels sources for given revision and settings and sets comment if required.
String	label(String label, String version, VcsRoot root, CheckoutRules checkoutRules)	Labels sources for given revision and settings.

Method Detail

label

@NotNull
String label(@NotNull
             String label,
             @NotNull
             String version,
             @NotNull
             VcsRoot root,
             @NotNull
             CheckoutRules checkoutRules)
      throws VcsException

Labels sources for given revision and settings. Returns actual label

Parameters:

label - actual set label

version - repository version

root - versioned root

checkoutRules - build checkout rules

Returns:

actually set label

Throws:

VcsException - throw exception if label was not set because of some reasons.

label

@NotNull
default String label(@NotNull
                     String label,
                     @Nullable
                     String message,
                     @NotNull
                     String version,
                     @NotNull
                     VcsRoot root,
                     @NotNull
                     CheckoutRules checkoutRules)
              throws VcsException

Labels sources for given revision and settings and sets comment if required. Returns actual label

Parameters:

label - actual set label

message - message for the label

version - repository version

root - versioned root

checkoutRules - build checkout rules

Returns:

actually set label

Throws:

VcsException - throw exception if label was not set because of some reasons. Implementation note: implementors must ensure the value of the message param is safe to use for the given VCS.