Package jetbrains.buildServer.pipeline.internal

Class PipelineBuildFeature

java.lang.Object

jetbrains.buildServer.serverSide.BuildFeature

jetbrains.buildServer.pipeline.internal.PipelineBuildFeature

All Implemented Interfaces:

ExecutorModeSupport, Describable, ServerExtension, TeamCityExtension

@Component
public class PipelineBuildFeature
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	TYPE

Constructor Summary

Constructors

Constructor	Description
PipelineBuildFeature(PipelineHeadManager pipelineHeadManager)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	User presentable name of the feature.
String	getEditParametersUrl()
String	getType()	Type of the feature, must be unique among all of the features.
boolean	isAvailable(BuildTypeSettings buildTypeSettings)	This build feature is only used as an internal implementation detail, so there's no need to show it in UI
boolean	isRequiresAgent()

Methods inherited from class jetbrains.buildServer.serverSide.BuildFeature

describeParameters, getDefaultParameters, getParametersProcessor, getParametersProcessor, getPlaceToShow, getRequirements, getSupportType, isMultipleFeaturesPerBuildTypeAllowed, isUnchangedBySettingsFreeze

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

@NotNull
public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

PipelineBuildFeature

public PipelineBuildFeature(@NotNull
                            PipelineHeadManager pipelineHeadManager)

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.

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.

isAvailable

public boolean isAvailable(BuildTypeSettings buildTypeSettings)

This build feature is only used as an internal implementation detail, so there's no need to show it in UI

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.