jetbrains.buildServer.serverSide
Class BuildFeature

java.lang.Object
  extended by jetbrains.buildServer.serverSide.BuildFeature
All Implemented Interfaces:
ServerExtension, TeamCityExtension

public abstract class BuildFeature
extends java.lang.Object
implements ServerExtension

Represents a kind of a plugin that provides some functionality around a build. Usually such plugin has corresponding agent-side part.

Since:
6.0

Nested Class Summary
static class BuildFeature.PlaceToShow
          Location of build feature settings in UI
 
Constructor Summary
BuildFeature()
           
 
Method Summary
 java.lang.String describeParameters(java.util.Map<java.lang.String,java.lang.String> params)
          Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings.
 java.util.Map<java.lang.String,java.lang.String> getDefaultParameters()
           
abstract  java.lang.String getDisplayName()
          User presentable name of the feature.
abstract  java.lang.String getEditParametersUrl()
           
 PropertiesProcessor getParametersProcessor()
          Returns parameters processor which will be used to validate parameters specified by user.
 BuildFeature.PlaceToShow getPlaceToShow()
          Return the UI location for build feature settings
abstract  java.lang.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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BuildFeature

public BuildFeature()
Method Detail

getType

@NotNull
public abstract java.lang.String getType()
Type of the feature, must be unique among all of the features.

Returns:
type of the feature

getDisplayName

@NotNull
public abstract java.lang.String getDisplayName()
User presentable name of the feature.

Returns:
name of the feature to show in the user interface.

describeParameters

@NotNull
public java.lang.String describeParameters(@NotNull
                                                   java.util.Map<java.lang.String,java.lang.String> params)
Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings. Can contain HTML, so please make sure it is safe in terms of XSS.

Parameters:
params - parameters to describe
Returns:
short description of parameters.

getParametersProcessor

@Nullable
public PropertiesProcessor getParametersProcessor()
Returns parameters processor which will be used to validate parameters specified by user.

Returns:
see above

getEditParametersUrl

@Nullable
public abstract java.lang.String getEditParametersUrl()
Returns:
absolute path to a JSP file or controller for editing parameters, should not include context path.

getDefaultParameters

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getDefaultParameters()
Returns:
default parameters

isMultipleFeaturesPerBuildTypeAllowed

public boolean isMultipleFeaturesPerBuildTypeAllowed()
Returns true if single build type can contain more than one build feature of this type.

Returns:
see above

getPlaceToShow

public BuildFeature.PlaceToShow getPlaceToShow()
Return the UI location for build feature settings

Returns:
see above
Since:
7.0
See Also:
BuildFeature.PlaceToShow