Package org.apache.pulsar.websocket

Enum Class WebSocketError

java.lang.Object

java.lang.Enum<WebSocketError>

org.apache.pulsar.websocket.WebSocketError

All Implemented Interfaces:

Serializable, Comparable<WebSocketError>, Constable

public enum WebSocketError
extends Enum<WebSocketError>

Enum for possible errors in the proxy

Enum has error code and description of the error.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AuthenticationError
FailedToCreateProducer
FailedToDeserializeFromJSON
FailedToSerializeToJSON
FailedToSubscribe
NotAuthorizedError
PayloadEncodingError
UnknownError

Method Summary

Modifier and Type	Method	Description
int	getCode()
String	getDescription()
String	toString()
static WebSocketError	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebSocketError[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FailedToCreateProducer

public static final WebSocketError FailedToCreateProducer

FailedToSubscribe

public static final WebSocketError FailedToSubscribe

FailedToDeserializeFromJSON

public static final WebSocketError FailedToDeserializeFromJSON

FailedToSerializeToJSON

public static final WebSocketError FailedToSerializeToJSON

AuthenticationError

public static final WebSocketError AuthenticationError

NotAuthorizedError

public static final WebSocketError NotAuthorizedError

PayloadEncodingError

public static final WebSocketError PayloadEncodingError

UnknownError

public static final WebSocketError UnknownError

Method Details

values

public static WebSocketError[] values()

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

Returns:

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

valueOf

public static WebSocketError valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDescription

public String getDescription()

getCode

public int getCode()

toString

public String toString()

Overrides:

toString in class Enum<WebSocketError>