Package jetbrains.buildServer.controllers.admin.buildFeatures.autoMerge

Class AutoMergeBuildFeature

java.lang.Object

jetbrains.buildServer.serverSide.BuildFeature

jetbrains.buildServer.controllers.admin.buildFeatures.autoMerge.AutoMergeBuildFeature

All Implemented Interfaces:

ExecutorModeSupport, Describable, ServerExtension, TeamCityExtension, MergeOptionsFactory

public class AutoMergeBuildFeature
extends BuildFeature
implements MergeOptionsFactory

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	FEATURE_TYPE

Constructor Summary

Constructors

Constructor	Description
AutoMergeBuildFeature(BranchSpecs specs)

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()
AutoMergeOptions	getMergeOptions(Map<String,String> resolvedParams, SBuild build, boolean onlyAfterBuildFinish)	Returns merge options for given build feature resolved parameters and a finished build.
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	isRequiresAgent()

Methods inherited from class jetbrains.buildServer.serverSide.BuildFeature

getParametersProcessor, getPlaceToShow, getRequirements, getSupportType, isAvailable, isMultipleFeaturesPerBuildTypeAllowed, isUnchangedBySettingsFreeze

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_TYPE

public static final String FEATURE_TYPE

See Also:

Constant Field Values

Constructor Detail

AutoMergeBuildFeature

public AutoMergeBuildFeature(@NotNull
                             BranchSpecs specs)

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.

getDefaultParameters

@NotNull
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

getMergeOptions

@Nullable
public AutoMergeOptions getMergeOptions(@NotNull
                                        Map<String,String> resolvedParams,
                                        @NotNull
                                        SBuild build,
                                        boolean onlyAfterBuildFinish)

Returns merge options for given build feature resolved parameters and a finished build. Returns null if sources from build should not be merged

Specified by:

getMergeOptions in interface MergeOptionsFactory

Parameters:

resolvedParams - resolved parameters of this build feature

build - a finished build of interest

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.