me.lucko.helper.messaging.conversation

Class ConversationReply<R extends ConversationMessage>

java.lang.Object

me.lucko.helper.messaging.conversation.ConversationReply<R>

Type Parameters:

R - the reply type

public final class ConversationReply<R extends ConversationMessage>
extends Object

Encapsulates the reply to a incoming message in a ConversationChannel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Promise<R>	getReply() Gets the reply.
int	hashCode()
boolean	hasReply() Gets if this object actually contains a reply.
static <R extends ConversationMessage> ConversationReply<R>	noReply() Returns an object indicating that no reply should be sent.
static <R extends ConversationMessage> ConversationReply<R>	of(R reply) Creates a new ConversationReply.
static <R extends ConversationMessage> ConversationReply<R>	ofCompletableFuture(CompletableFuture<R> futureReply) Creates a new ConversationReply.
static <R extends ConversationMessage> ConversationReply<R>	ofPromise(Promise<R> promiseReply) Creates a new ConversationReply.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

noReply

public static <R extends ConversationMessage> ConversationReply<R> noReply()

Returns an object indicating that no reply should be sent.

Type Parameters:

R - the reply type

Returns:

a "no reply" marker

of

public static <R extends ConversationMessage> ConversationReply<R> of(R reply)

Creates a new ConversationReply.

Type Parameters:

R - the type

Parameters:

reply - the reply message

Returns:

the new reply encapsulation

ofCompletableFuture

public static <R extends ConversationMessage> ConversationReply<R> ofCompletableFuture(CompletableFuture<R> futureReply)

Creates a new ConversationReply.

Bear in mind the reply will only be send once the future completes. The timeout value on "other other end" may need to take this into account.

Type Parameters:

R - the type

Parameters:

futureReply - the future reply

Returns:

the new reply encapsulation

ofPromise

public static <R extends ConversationMessage> ConversationReply<R> ofPromise(Promise<R> promiseReply)

Creates a new ConversationReply.

Bear in mind the reply will only be send once the future completes. The timeout value on "other other end" may need to take this into account.

Type Parameters:

R - the type

Parameters:

promiseReply - the future reply

Returns:

the new reply encapsulation

hasReply

public boolean hasReply()

Gets if this object actually contains a reply.

Returns:

if the object has a reply

getReply

@Nonnull
public Promise<R> getReply()

Gets the reply.

Returns:

the reply

Throws:

IllegalStateException - if this object doesn't have a reply

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object