Package jetbrains.buildServer.tools.impl

Class ToolsParametersProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

jetbrains.buildServer.tools.impl.ToolsParametersProvider

All Implemented Interfaces:

BuildParametersProvider, ProjectParametersProvider, ServerExtension, TeamCityExtension

public class ToolsParametersProvider
extends AbstractBuildParametersProvider
implements ProjectParametersProvider

provides parameters of tools which can be lazy-loaded on agent. i.e. server assumes that these parameters will be always available on agent

Since:

2019.1

Constructor Summary

Constructors

Constructor	Description
ToolsParametersProvider(OnDemandToolsProvider onDemandToolsProvider)

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAvailableParameters(SProject project)
Collection<String>	getParametersAvailableOnAgent(SBuild build)	Returns collection of parameters (names) always available on the agent for the specified build.
String	getPrefix()

Methods inherited from class jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

getParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolsParametersProvider

public ToolsParametersProvider(@NotNull
                               OnDemandToolsProvider onDemandToolsProvider)

Method Detail

getParametersAvailableOnAgent

@NotNull
public Collection<String> getParametersAvailableOnAgent(@NotNull
                                                        SBuild build)

Description copied from interface: BuildParametersProvider

Returns collection of parameters (names) always available on the agent for the specified build. Because concrete values of these parameters are not known on the server side only names are returned. This collection may not contain parameters returned by BuildParametersProvider.getParameters(jetbrains.buildServer.serverSide.SBuild,boolean). To provide descriptions for the properties ParameterDescriptionProvider

Specified by:

getParametersAvailableOnAgent in interface BuildParametersProvider

Overrides:

getParametersAvailableOnAgent in class AbstractBuildParametersProvider

Parameters:

build - build

Returns:

see above

getPrefix

@NotNull
public String getPrefix()

Specified by:

getPrefix in interface BuildParametersProvider

Overrides:

getPrefix in class AbstractBuildParametersProvider

Returns:

a common prefix used for all parameter names generated by this provider, returns empty string if there is no common prefix

getAvailableParameters

@NotNull
public Collection<String> getAvailableParameters(@NotNull
                                                 SProject project)

Specified by:

getAvailableParameters in interface ProjectParametersProvider