com.simpligility.maven.plugins.android

Interface CommandExecutor

public interface CommandExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommandExecutor.ErrorListener
static class	CommandExecutor.Factory Provides factory services for creating a default instance of the command executor.

Method Summary

Modifier and Type	Method and Description
void	addEnvironment(String name, String value) Adds an environment variable with the specified name and value to the executor.
void	executeCommand(String executable, List<String> commands) Executes the command for the specified executable and list of command options.
void	executeCommand(String executable, List<String> commands, boolean failsOnErrorOutput) Executes the command for the specified executable and list of command options.
void	executeCommand(String executable, List<String> commands, File workingDirectory, boolean failsOnErrorOutput) Executes the command for the specified executable and list of command options.
long	getPid()
int	getResult() Returns the process result of executing the command.
String	getStandardError() Returns the standard error from executing the command.
String	getStandardOut() Returns the standard output from executing the command.
void	setCaptureStdErr(boolean captureStdErr)
void	setCaptureStdOut(boolean captureStdOut)
void	setCustomShell(org.codehaus.plexus.util.cli.shell.Shell s)
void	setErrorListener(CommandExecutor.ErrorListener errorListener)
void	setLogger(org.apache.maven.plugin.logging.Log logger) Sets the plexus logger.

Method Detail

setLogger

void setLogger(org.apache.maven.plugin.logging.Log logger)

Sets the plexus logger.

Parameters:

logger - the plexus logger

executeCommand

void executeCommand(String executable,
                    List<String> commands)
             throws ExecutionException

Executes the command for the specified executable and list of command options.

Parameters:

executable - the name of the executable (csc, xsd, etc).

commands - the command options for the compiler/executable

Throws:

ExecutionException - if compiler or executable writes anything to the standard error stream or if the process returns a process result != 0.

executeCommand

void executeCommand(String executable,
                    List<String> commands,
                    boolean failsOnErrorOutput)
             throws ExecutionException

Executes the command for the specified executable and list of command options.

Parameters:

executable - the name of the executable (csc, xsd, etc).

commands - the commands options for the compiler/executable

failsOnErrorOutput - if true, throws an ExecutionException if there the compiler or executable writes anything to the error output stream. By default, this value is true

Throws:

ExecutionException - if compiler or executable writes anything to the standard error stream (provided the failsOnErrorOutput is not false) or if the process returns a process result != 0.

executeCommand

void executeCommand(String executable,
                    List<String> commands,
                    File workingDirectory,
                    boolean failsOnErrorOutput)
             throws ExecutionException

Executes the command for the specified executable and list of command options. If the compiler or executable is not within the environmental path, you should use this method to specify the working directory. Always use this method for executables located within the local maven repository.

Parameters:

executable - the name of the executable (csc, xsd, etc).

commands - the command options for the compiler/executable

workingDirectory - the directory where the command will be executed

Throws:

ExecutionException - if compiler or executable writes anything to the standard error stream (provided the failsOnErrorOutput is not false) or if the process returns a process result != 0.

getResult

int getResult()

Returns the process result of executing the command. Typically a value of 0 means that the process executed successfully.

Returns:

the process result of executing the command

getPid

long getPid()

Returns:

the process id for the executed command.

getStandardOut

String getStandardOut()

Returns the standard output from executing the command.

Returns:

the standard output from executing the command

getStandardError

String getStandardError()

Returns the standard error from executing the command.

Returns:

the standard error from executing the command

addEnvironment

void addEnvironment(String name,
                    String value)

Adds an environment variable with the specified name and value to the executor.

setErrorListener

void setErrorListener(CommandExecutor.ErrorListener errorListener)

setCustomShell

void setCustomShell(org.codehaus.plexus.util.cli.shell.Shell s)

setCaptureStdOut

void setCaptureStdOut(boolean captureStdOut)

setCaptureStdErr

void setCaptureStdErr(boolean captureStdErr)