com.atlassian.bamboo.command
Interface CommandDecorator

All Superinterfaces:

BambooPluginModule

All Known Implementing Classes:

AbstractAntCommandDecorator, AbstractCloverCommandDecorator, AbstractCommandDecorator, AbstractMaven2CommandDecorator, AbstractMavenCommandDecorator, AbstractPhpUnitCommandDecorator, CloverAntCommandDecorator, CloverGrailsCommandDecorator, CloverMavenCommandDecorator, CloverPhpUnitCommandDecorator, GrailsCommandDecorator, IsolatedLocalRepositoryMaven2CommandDecorator, IsolatedTmpDirAntCommandDecorator, IsolatedTmpDirMavenCommandDecorator

public interface CommandDecorator
extends BambooPluginModule

Method Summary

boolean	canDecorate(Command command) Given a command, determine whether or not it can be decorated.
java.util.List<java.lang.String>	decorateArguments(java.util.List<java.lang.String> arguments) Given a list of command line arguments, return a possibly new list of arguments.
void	init(BuildContext context)

Method Detail

init

void init(BuildContext context)

canDecorate

boolean canDecorate(Command command)

Given a command, determine whether or not it can be decorated. If this method returns false, then the decorateArguments method will not get called.

Parameters:

command - the command that will be decorated

Returns:

true if the command can be decorated by this Decorator. false otherwise.

decorateArguments

@NotNull
java.util.List<java.lang.String> decorateArguments(@NotNull
                                                           java.util.List<java.lang.String> arguments)

Given a list of command line arguments, return a possibly new list of arguments. The returned list will be used for building. This method will only be invoked if the canDecorate(com.atlassian.bamboo.command.Command) method returns true.

Parameters:

arguments - the original list of command line arguments configured in the Builder configuration

Returns:

a possibly modified list of arguments to use for building