Package org.jenkinsci.plugins.stashNotifier

Class NotificationResult

java.lang.Object

org.jenkinsci.plugins.stashNotifier.NotificationResult

public final class NotificationResult
extends Object

convenience class to capture the result of a notification.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	indicatesSuccess	true if and only if the notification was successful.
final String	message	the error message in case the notification was not successful or null, otherwise.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NotificationResult(boolean initSuccess, String initMessage)	default constructor

Method Summary

Modifier and Type	Method	Description
static NotificationResult	newFailure(String message)	returns a new NotificationResult instance indicating a failed notification.
static NotificationResult	newSuccess()	returns a new NotificationResult instance indicating a successful notification.

Methods inherited from class java.lang.Object

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

Field Details

indicatesSuccess

public final boolean indicatesSuccess

true if and only if the notification was successful.

message

public final String message

the error message in case the notification was not successful or null, otherwise.

Constructor Details

NotificationResult

protected NotificationResult(boolean initSuccess,
 String initMessage)

default constructor

Parameters:

initSuccess - success flag

initMessage - message in case notification was not successful

Method Details

newSuccess

public static NotificationResult newSuccess()

returns a new NotificationResult instance indicating a successful notification.

Returns:

a new NotificationResult instance indicating a successful notification

newFailure

public static NotificationResult newFailure(String message)

returns a new NotificationResult instance indicating a failed notification.

Parameters:

message - the message indicating why the notification failed

Returns:

a new NotificationResult instance indicating a successful notification