jetbrains.buildServer.serverSide.parameters

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

Modifier and Type	Method and 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.
boolean	isVisible(java.lang.String paramName) Called to check if parameter should be shown in the UI

Method Detail

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