Package jetbrains.buildServer.agent

Interface ToolProvider

All Known Implementing Classes:

IdeaToolProvider

public interface ToolProvider

Locates a path to a tool.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
String	getPath(String toolName)	Returns path to a tool, if it can be found without build settings.
String	getPath(String toolName, AgentRunningBuild build, BuildRunnerContext runner)	Returns path to a tool, according to current build settings
boolean	supports(String toolName)	Returns true if this tool provider supports locating of the tool with specified name

Method Detail

supports

boolean supports(@NotNull
                 String toolName)

Returns true if this tool provider supports locating of the tool with specified name

Parameters:

toolName - name of the tool

Returns:

true if specified name supported

getPath

@NotNull
String getPath(@NotNull
               String toolName)
        throws ToolCannotBeFoundException

Returns path to a tool, if it can be found without build settings.

Parameters:

toolName - tool name

Returns:

path to a tool

Throws:

ToolCannotBeFoundException - if provider can't locate a tool

getPath

@NotNull
String getPath(@NotNull
               String toolName,
               @NotNull
               AgentRunningBuild build,
               @NotNull
               BuildRunnerContext runner)
        throws ToolCannotBeFoundException

Returns path to a tool, according to current build settings

Parameters:

toolName - tool name

build - current build

runner - current runner

Returns:

path to a tool on a filesystem, never null

Throws:

ToolCannotBeFoundException - if provider can't locate a tool