com.codemesh.terp.ant.devpartner
Interface Tool<T extends Tool>

All Superinterfaces:

TerpAware, TerpContextHolder

All Known Implementing Classes:

BoundsChecker, DevPartnerTool

public interface Tool<T extends Tool>
extends TerpAware

The interface implemented by all tools.

Nested Class Summary

Nested classes/interfaces inherited from interface com.codemesh.terp.ant.TerpAware

TerpAware.Delegate

Method Summary

void	addOption(ToolOption<T> option) Add a tool option to the tool invocation.
java.lang.String	getCode() Returns the tool code.
TerpContext	getContext() Returns the terp context in which the tool is executing.
ToolOptionSet<T>	getOptions() Returns all configured tool options.
Version	getVersion() Returns the tool version.

Methods inherited from interface com.codemesh.terp.ant.TerpAware

getIf, getUnless, satisfiesConditions, setIf, setUnless

Methods inherited from interface com.codemesh.terp.ant.TerpContextHolder

setContext

Method Detail

getContext

TerpContext getContext()

Returns the terp context in which the tool is executing.

Specified by:

getContext in interface TerpContextHolder

Returns:

the terp context.

getCode

java.lang.String getCode()

Returns the tool code.

Returns:

the tool code.

getVersion

Version getVersion()

Returns the tool version.

Returns:

the tool version.

addOption

void addOption(ToolOption<T> option)

Add a tool option to the tool invocation.

Parameters:

option - the option to add.

getOptions

ToolOptionSet<T> getOptions()

Returns all configured tool options.

Returns:

all configured options.