Package org.apache.maven.shared.utils.cli.javatool

Class JavaToolResult

java.lang.Object

org.apache.maven.shared.utils.cli.javatool.JavaToolResult

public class JavaToolResult
extends java.lang.Object

Describes the result of a JavaTool invocation.

Since:

0.5

Author:

Tony Chemit

Constructor Summary

Constructors

Constructor	Description
JavaToolResult()

Method Summary

Modifier and Type	Method	Description
Commandline	getCommandline()	Gets the command line used.
CommandLineException	getExecutionException()	Gets the exception that possibly occurred during the execution of the command line.
int	getExitCode()	Gets the exit code from the tool invocation.
void	setCommandline(Commandline commandline)	Set the commandline used to obtain this result.
void	setExecutionException(CommandLineException executionException)	Sets the exception that prevented to execute the command line.
void	setExitCode(int exitCode)	Sets the exit code reported by the tool invocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaToolResult

public JavaToolResult()

Method Detail

getExitCode

public int getExitCode()

Gets the exit code from the tool invocation. A non-zero value indicates a build failure. Note: This value is undefined if getExecutionException() reports an exception.

Returns:

The exit code from the tool invocation.

getCommandline

public Commandline getCommandline()

Gets the command line used.

Returns:

The command line used

getExecutionException

public CommandLineException getExecutionException()

Gets the exception that possibly occurred during the execution of the command line.

Returns:

The exception that prevented to invoke tool or null if the command line was successfully processed by the operating system.

setExitCode

public void setExitCode(int exitCode)

Sets the exit code reported by the tool invocation.

Parameters:

exitCode - The exit code reported by the tool invocation.

setExecutionException

public void setExecutionException(CommandLineException executionException)

Sets the exception that prevented to execute the command line.

Parameters:

executionException - The exception that prevented to execute the command line, may be null.

setCommandline

public void setCommandline(Commandline commandline)

Set the commandline used to obtain this result.

Parameters:

commandline - the commandline used to obtain this result