Package jetbrains.buildServer.serverSide.parameters

Class AbstractParameterDescriptionProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractParameterDescriptionProvider

All Implemented Interfaces:

ParameterDescriptionProvider, ServerExtension, TeamCityExtension

Direct Known Subclasses:

BuildStepsParameterDescriptionProvider, DefaultParametersDescription

public abstract class AbstractParameterDescriptionProvider
extends Object
implements ParameterDescriptionProvider

Abstract class for ParameterDescriptionProvider.

Constructor Summary

Constructors

Constructor	Description
AbstractParameterDescriptionProvider()

Method Summary

Modifier and Type	Method	Description
String	describe(String paramName)	Returns description of the parameter or null if this extension does not know anything about this parameter.
boolean	isVisible(String paramName)	Called to check if parameter should be shown in the UI

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.parameters.ParameterDescriptionProvider

describe

Constructor Detail

AbstractParameterDescriptionProvider

public AbstractParameterDescriptionProvider()

Method Detail

describe

public String describe(@NotNull
                       String paramName)

Description copied from interface: ParameterDescriptionProvider

Returns description of the parameter or null if this extension does not know anything about this parameter.

Specified by:

describe in interface ParameterDescriptionProvider

Parameters:

paramName - name of the parameter (may have system. or env. prefix)

Returns:

description or null

isVisible

public boolean isVisible(@NotNull
                         String paramName)

Description copied from interface: ParameterDescriptionProvider

Called to check if parameter should be shown in the UI

Specified by:

isVisible in interface ParameterDescriptionProvider

Parameters:

paramName - name of parameter

Returns:

true to let parameter be shown in the UI, false to hide parameter