Interface ParameterDescriptionProvider
-
- All Superinterfaces:
ServerExtension
,TeamCityExtension
- All Known Implementing Classes:
AbstractParameterDescriptionProvider
@UserImplemented(adapterClass=AbstractParameterDescriptionProvider.class) public interface ParameterDescriptionProvider extends ServerExtension
Provides a human readable description for a parameter with given name. Note that build parameter (i.e. parameter passed to a build) will have corresponding prefix (system. or env.).- Since:
- 5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
describe(java.lang.String paramName)
Returns description of the parameter or null if this extension does not know anything about this parameter.default java.lang.String
describe(java.lang.String param, ParameterDescriptionProviderContext context)
Returns description of the parameter or null if this extension does not know anything about this parameter.boolean
isVisible(java.lang.String paramName)
Called to check if parameter should be shown in the UI
-
-
-
Method Detail
-
describe
default java.lang.String describe(@NotNull java.lang.String param, @NotNull ParameterDescriptionProviderContext context)
Returns description of the parameter or null if this extension does not know anything about this parameter.- Parameters:
paramName
- name of the parameter (may have system. or env. prefix)context
- provides some additional context for the parameter description rendering- Returns:
- description or null
- Since:
- 2022.03
-
describe
@Nullable java.lang.String describe(@NotNull java.lang.String paramName)
Returns description of the parameter or null if this extension does not know anything about this parameter.- Parameters:
paramName
- name of the parameter (may have system. or env. prefix)- Returns:
- description or null
- Since:
- 5.0
-
isVisible
boolean isVisible(@NotNull java.lang.String paramName)
Called to check if parameter should be shown in the UI- Parameters:
paramName
- name of parameter- Returns:
- true to let parameter be shown in the UI, false to hide parameter
- Since:
- 7.0
-
-