com.ibm.mqlight.api

Interface Promise<T>

Type Parameters:

T - the type of object passed back when the promise is completed successfully via the setSuccess(Object) method.

All Known Subinterfaces:

EndpointPromise

public interface Promise<T>

Represents a promise that the recipient of an instance of this object will perform an operation and then complete the promise by invoking one of the set functions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isComplete()
void	setFailure(Exception exception) Called to indicate that the related operation failed in some way.
void	setSuccess(T result) Called to indicate that the related operation succeeded.

Method Detail

setFailure

void setFailure(Exception exception)
                throws IllegalStateException

Called to indicate that the related operation failed in some way.

Parameters:

exception - an indication of why the operation failed.

Throws:

IllegalStateException - if the promise has already been completed.

setSuccess

void setSuccess(T result)
                throws IllegalStateException

Called to indicate that the related operation succeeded.

Parameters:

result - an object that represents the result of the operation. This can be passed back to the class that issued the promise.

Throws:

IllegalStateException - if the promise has already been completed.

isComplete

boolean isComplete()

Returns:

true if the promise has been completed (by either the setSuccess(Object) or the setFailure(Exception) method being invoked).