Class BuildFailureOnMessageFeature
- java.lang.Object
-
- jetbrains.buildServer.serverSide.BuildFeature
-
- jetbrains.buildServer.buildFailures.buildLog.BuildFailureOnMessageFeature
-
- All Implemented Interfaces:
ExecutorModeSupport
,Describable
,PropertiesProcessor
,ServerExtension
,TeamCityExtension
public class BuildFailureOnMessageFeature extends BuildFeature implements PropertiesProcessor
User: vbedrosova Date: 17.08.11 Time: 12:46
-
-
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
EDIT_PARAMETERS_URL
static String
FEATURE_TYPE
-
Constructor Summary
Constructors Constructor Description BuildFailureOnMessageFeature()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.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.BuildFeature.PlaceToShow
getPlaceToShow()
Return the UI location for build feature settingsString
getType()
Type of the feature, must be unique among all of the features.boolean
isRequiresAgent()
Collection<InvalidProperty>
process(Map<String,String> properties)
Will be called when user attempts to save properties from the user interface or when runner parameters are used to compute agent compatibility for a build configuration.-
Methods inherited from class jetbrains.buildServer.serverSide.BuildFeature
getDefaultParameters, getParametersProcessor, getRequirements, getSupportType, isAvailable, isMultipleFeaturesPerBuildTypeAllowed, isUnchangedBySettingsFreeze
-
-
-
-
Field Detail
-
FEATURE_TYPE
public static final String FEATURE_TYPE
- See Also:
- Constant Field Values
-
EDIT_PARAMETERS_URL
public static final String EDIT_PARAMETERS_URL
- See Also:
- Constant Field Values
-
-
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 classBuildFeature
- 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 interfaceDescribable
- Specified by:
getDisplayName
in classBuildFeature
- Returns:
- name of the feature to show in the user interface.
-
getEditParametersUrl
public String getEditParametersUrl()
- Specified by:
getEditParametersUrl
in classBuildFeature
- Returns:
- absolute path to a JSP file or controller for editing parameters, should not include context path.
-
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 classBuildFeature
- Parameters:
params
- parameters to describe- Returns:
- short description of parameters.
-
getParametersProcessor
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 classBuildFeature
- Returns:
- see above
-
getPlaceToShow
public BuildFeature.PlaceToShow getPlaceToShow()
Description copied from class:BuildFeature
Return the UI location for build feature settings- Overrides:
getPlaceToShow
in classBuildFeature
- Returns:
- see above
- See Also:
BuildFeature.PlaceToShow
-
isRequiresAgent
public boolean isRequiresAgent()
- Overrides:
isRequiresAgent
in classBuildFeature
- 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.
-
process
public Collection<InvalidProperty> process(Map<String,String> properties)
Description copied from interface:PropertiesProcessor
Will be called when user attempts to save properties from the user interface or when runner parameters are used to compute agent compatibility for a build configuration. Properties map passed as argument can be verified or modified by the processor (for example, one could remove all properties with empty values from this map). If processor was called during saving properties to a configuration file, then modified map will be stored without changes.- Specified by:
process
in interfacePropertiesProcessor
- Parameters:
properties
- properties to process- Returns:
- collection of invalid properties, if this collection is not empty properties will not be saved into the configuration file.
-
-