com.thoughtworks.go.plugin.api.response.execution

Class ExecutionResult

java.lang.Object

com.thoughtworks.go.plugin.api.response.Result

com.thoughtworks.go.plugin.api.response.execution.ExecutionResult

public class ExecutionResult
extends Result

Used to specify the result of an execution of a part of a plugin.

Constructor Summary

Constructors

Constructor and Description
ExecutionResult()

Method Summary

Modifier and Type	Method and Description
static ExecutionResult	failure(String message) Mark the result as 'Failure'.
static ExecutionResult	failure(String message, Exception exception) Mark the result as 'Failure'.
static ExecutionResult	success(String message) Mark the result as 'Success'.

Methods inherited from class com.thoughtworks.go.plugin.api.response.Result

getMessages, getMessagesForDisplay, isSuccessful, withErrorMessages, withErrorMessages, withSuccessMessages, withSuccessMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionResult

public ExecutionResult()

Method Detail

failure

public static ExecutionResult failure(String message,
                                      Exception exception)

Mark the result as 'Failure'.

Parameters:

message - More details about the failure.

exception - (currently not used)

Returns:

A new ExecutionResult instance, which is marked as 'Failure'.

failure

public static ExecutionResult failure(String message)

Mark the result as 'Failure'.

Parameters:

message - More details about the failure.

Returns:

A new ExecutionResult instance, which is marked as 'Failure'.

success

public static ExecutionResult success(String message)

Mark the result as 'Success'.

Parameters:

message - More details about the run.

Returns:

A new ExecutionResult instance, which is marked as 'Success'.