Package jetbrains.buildServer.serverSide.impl

Class VcsLabelingBuildFeature

java.lang.Object

jetbrains.buildServer.serverSide.BuildFeature

jetbrains.buildServer.serverSide.impl.VcsLabelingBuildFeature

All Implemented Interfaces:

ExecutorModeSupport, Describable, ServerExtension, TeamCityExtension

public class VcsLabelingBuildFeature
extends BuildFeature

Nested Class Summary

Nested classes/interfaces inherited from class jetbrains.buildServer.serverSide.BuildFeature

BuildFeature.PlaceToShow

Field Summary

Fields

Modifier and Type	Field	Description
static String	BRANCH_FILTER_PARAM
static String	LABELING_PATTERN_PARAM
static String	MESSAGE_FORMAT_PARAM
static String	SUCCESSFUL_ONLY_PARAM
static String	VCS_LABELING_TYPE
static String	VCS_ROOT_ID_PARAM

Constructor Summary

Constructors

Constructor	Description
VcsLabelingBuildFeature(ProjectManager projectManager, BranchSpecs branchSpecs)

Method Summary

Modifier and Type	Method	Description
String	describeParameters(Map<String,String> params)	Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings.
Map<String,String>	getDefaultParameters()
String	getDisplayName()	User presentable name of the feature.
String	getEditParametersUrl()
PropertiesProcessor	getParametersProcessor()	Returns parameters processor which will be used to validate and alter parameters specified by user.
String	getType()	Type of the feature, must be unique among all of the features.
boolean	isMultipleFeaturesPerBuildTypeAllowed()	Returns true if single build type can contain more than one build feature of this type.
boolean	isRequiresAgent()

Methods inherited from class jetbrains.buildServer.serverSide.BuildFeature

getParametersProcessor, getPlaceToShow, getRequirements, getSupportType, isAvailable, isUnchangedBySettingsFreeze

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VCS_LABELING_TYPE

public static final String VCS_LABELING_TYPE

See Also:

Constant Field Values

VCS_ROOT_ID_PARAM

public static final String VCS_ROOT_ID_PARAM

See Also:

Constant Field Values

LABELING_PATTERN_PARAM

public static final String LABELING_PATTERN_PARAM

See Also:

Constant Field Values

SUCCESSFUL_ONLY_PARAM

public static final String SUCCESSFUL_ONLY_PARAM

See Also:

Constant Field Values

BRANCH_FILTER_PARAM

public static final String BRANCH_FILTER_PARAM

See Also:

Constant Field Values

MESSAGE_FORMAT_PARAM

public static final String MESSAGE_FORMAT_PARAM

See Also:

Constant Field Values

Constructor Detail

VcsLabelingBuildFeature

public VcsLabelingBuildFeature(@NotNull
                               ProjectManager projectManager,
                               @NotNull
                               BranchSpecs branchSpecs)

Method Detail

getType

@NotNull
public String getType()

Description copied from class: BuildFeature

Type of the feature, must be unique among all of the features.

Specified by:

getType in class BuildFeature

Returns:

type of the feature

getDisplayName

@NotNull
public String getDisplayName()

Description copied from class: BuildFeature

User presentable name of the feature.

Specified by:

getDisplayName in interface Describable

Specified by:

getDisplayName in class BuildFeature

Returns:

name of the feature to show in the user interface.

getEditParametersUrl

@Nullable
public String getEditParametersUrl()

Specified by:

getEditParametersUrl in class BuildFeature

Returns:

absolute path to a JSP file or controller for editing parameters, should not include context path.

isMultipleFeaturesPerBuildTypeAllowed

public boolean isMultipleFeaturesPerBuildTypeAllowed()

Description copied from class: BuildFeature

Returns true if single build type can contain more than one build feature of this type.

Overrides:

isMultipleFeaturesPerBuildTypeAllowed in class BuildFeature

Returns:

see above

isRequiresAgent

public boolean isRequiresAgent()

Overrides:

isRequiresAgent in class BuildFeature

Returns:

true if this build feature has some code which should be executed on the agent during the build. If false is returned then parameters of this feature will not be passed to an agent.

getDefaultParameters

@Nullable
public Map<String,String> getDefaultParameters()

Overrides:

getDefaultParameters in class BuildFeature

Returns:

default parameters

describeParameters

@NotNull
public String describeParameters(@NotNull
                                 Map<String,String> params)

Description copied from class: BuildFeature

Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings.

Overrides:

describeParameters in class BuildFeature

Parameters:

params - parameters to describe

Returns:

short description of parameters.

getParametersProcessor

@Nullable
public PropertiesProcessor getParametersProcessor()

Description copied from class: BuildFeature

Returns parameters processor which will be used to validate and alter parameters specified by user.

Overrides:

getParametersProcessor in class BuildFeature

Returns:

see above