Package jetbrains.buildServer.serverSide.impl.approval

Class ApprovalBuildFeature

java.lang.Object

jetbrains.buildServer.serverSide.BuildFeature

jetbrains.buildServer.serverSide.impl.approval.ApprovalBuildFeature

All Implemented Interfaces:

ExecutorModeSupport, Describable, ServerExtension, TeamCityExtension

public class ApprovalBuildFeature
extends BuildFeature

Nested Class Summary

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

BuildFeature.PlaceToShow

Constructor Summary

Constructors

Constructor	Description
ApprovalBuildFeature(ApprovableBuildManager approvableBuildManager)

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(BuildTypeIdentity buildTypeOrTemplate)	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	isAvailable(BuildTypeSettings buildTypeSettings)
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, isUnchangedBySettingsFreeze

Methods inherited from class java.lang.Object

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

Constructor Detail

ApprovalBuildFeature

public ApprovalBuildFeature(ApprovableBuildManager approvableBuildManager)

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

isAvailable

public boolean isAvailable(BuildTypeSettings buildTypeSettings)

Overrides:

isAvailable in class BuildFeature

Returns:

true if this build feature should be available for a given build type. If false is returned then build feature should not appear on the available features list.

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.

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(@NotNull
                                                  BuildTypeIdentity buildTypeOrTemplate)

Description copied from class: BuildFeature

Returns parameters processor which will be used to validate and alter parameters specified by user. Unlike the previous method, this one accepts build type or template context

Overrides:

getParametersProcessor in class BuildFeature

Returns:

getDefaultParameters

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

Overrides:

getDefaultParameters in class BuildFeature

Returns:

default parameters