Package com.couchbase.client.core.cnc

Enum EventBus.PublishResult

java.lang.Object

java.lang.Enum<EventBus.PublishResult>

com.couchbase.client.core.cnc.EventBus.PublishResult

All Implemented Interfaces:

Serializable, Comparable<EventBus.PublishResult>

Enclosing interface:

EventBus

public static enum EventBus.PublishResult
extends Enum<EventBus.PublishResult>

Signals if a publish call was successful and if not why.

Enum Constant Summary

Enum Constants

Enum Constant	Description
OVERLOADED	Could not publish because the event bus is overloaded temporarily.
SHUTDOWN	If the event bus is already shut down, the msg won't be published.
SUCCESS	Publishing was successful.

Method Summary

Modifier and Type	Method	Description
static EventBus.PublishResult	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EventBus.PublishResult[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final EventBus.PublishResult SUCCESS

Publishing was successful.

OVERLOADED

public static final EventBus.PublishResult OVERLOADED

Could not publish because the event bus is overloaded temporarily.

SHUTDOWN

public static final EventBus.PublishResult SHUTDOWN

If the event bus is already shut down, the msg won't be published.

Method Details

values

public static EventBus.PublishResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EventBus.PublishResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null