io.nats.client.api

Class KeyResult

java.lang.Object

io.nats.client.api.KeyResult

public class KeyResult
extends java.lang.Object

Class is used as the result or consuming keys

Constructor Summary

Constructors

Constructor and Description
KeyResult() Construct a valueless Key Result - used as the done marker without an exception
KeyResult(java.lang.Exception e) Construct a key result containing an exception
KeyResult(java.lang.String key) Construct a key result for a specific key

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.Exception	getException() Get the exception in this result
@Nullable java.lang.String	getKey() Get the key in this result
boolean	isDone() If there is no key, the result indicates the consume is done, even if there is an exception.
boolean	isException() Whether this result is an exception
boolean	isKey() Whether this result is a key.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyResult

public KeyResult()

Construct a valueless Key Result - used as the done marker without an exception

KeyResult

public KeyResult(java.lang.String key)

Construct a key result for a specific key

Parameters:

key - the key

KeyResult

public KeyResult(java.lang.Exception e)

Construct a key result containing an exception

Parameters:

e - the exception

Method Detail

getKey

public @Nullable java.lang.String getKey()

Get the key in this result

Returns:

the key or null if there is no key

getException

public @Nullable java.lang.Exception getException()

Get the exception in this result

Returns:

the exception or null if there is no exception

isKey

public boolean isKey()

Whether this result is a key.

Returns:

true if the result is a key

isException

public boolean isException()

Whether this result is an exception

Returns:

true if the result is an exception

isDone

public boolean isDone()

If there is no key, the result indicates the consume is done, even if there is an exception.

Returns:

true if this result indicates the consume is done.