com.thoughtworks.go.plugin.api.response

Class Result

java.lang.Object

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

Direct Known Subclasses:

ExecutionResult

public class Result
extends Object

Represents result of a plugin method invocation

Constructor Summary

Constructors

Constructor and Description
Result()

Method Summary

Modifier and Type	Method and Description
List<String>	getMessages() Gets error messages associated with result
String	getMessagesForDisplay() Formats the messages in the result to a suitable form so that it can be used in user interface.
boolean	isSuccessful() Checks if result is successful
Result	withErrorMessages(List<String> errorList) Creates instance of result with specified errors
Result	withErrorMessages(String... errors) Creates instance of result with specified errors
Result	withSuccessMessages(List<String> successMessages) Creates instance of result with specified success messages
Result	withSuccessMessages(String... successMessages) Creates instance of result with specified success messages

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result()

Method Detail

isSuccessful

public boolean isSuccessful()

Checks if result is successful

Returns:

true if result successful

getMessages

public List<String> getMessages()

Gets error messages associated with result

Returns:

error messages associated with result

withErrorMessages

public Result withErrorMessages(String... errors)

Creates instance of result with specified errors

Parameters:

errors - the errors with which instance should be created

Returns:

created instance

withErrorMessages

public Result withErrorMessages(List<String> errorList)

Creates instance of result with specified errors

Parameters:

errorList - the errors with which instance should be created

Returns:

created instance

withSuccessMessages

public Result withSuccessMessages(String... successMessages)

Creates instance of result with specified success messages

Parameters:

successMessages - the success messages with which instance should be created

Returns:

created instance

withSuccessMessages

public Result withSuccessMessages(List<String> successMessages)

Creates instance of result with specified success messages

Parameters:

successMessages - the success messages with which instance should be created

Returns:

created instance

getMessagesForDisplay

public String getMessagesForDisplay()

Formats the messages in the result to a suitable form so that it can be used in user interface.

Returns:

a string containing the formatted message.