Package markets.alpaca.client.ws

Enum Class AlpacaStreamAuthResult.Status

java.lang.Object

java.lang.Enum<AlpacaStreamAuthResult.Status>

markets.alpaca.client.ws.AlpacaStreamAuthResult.Status

All Implemented Interfaces:

Serializable, Comparable<AlpacaStreamAuthResult.Status>, Constable

Enclosing class:

AlpacaStreamAuthResult

public static enum AlpacaStreamAuthResult.Status
extends Enum<AlpacaStreamAuthResult.Status>

Outcome categories for stream authentication.

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
AUTHENTICATED	The stream authenticated successfully.
CLOSED	The stream closed before authentication completed.
FAILED	The stream became terminal before authentication completed for another reason.
INTERRUPTED	The caller's wait was interrupted before authentication completed.
SERVER_REJECTED	The server rejected the credentials or authentication request.
TIMEOUT	The caller's wait timed out before authentication completed.

Method Summary

Modifier and Type	Method	Description
static AlpacaStreamAuthResult.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlpacaStreamAuthResult.Status[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTHENTICATED

public static final AlpacaStreamAuthResult.Status AUTHENTICATED

The stream authenticated successfully.

SERVER_REJECTED

public static final AlpacaStreamAuthResult.Status SERVER_REJECTED

The server rejected the credentials or authentication request.

CLOSED

public static final AlpacaStreamAuthResult.Status CLOSED

The stream closed before authentication completed.

TIMEOUT

public static final AlpacaStreamAuthResult.Status TIMEOUT

The caller's wait timed out before authentication completed.

INTERRUPTED

public static final AlpacaStreamAuthResult.Status INTERRUPTED

The caller's wait was interrupted before authentication completed.

FAILED

public static final AlpacaStreamAuthResult.Status FAILED

The stream became terminal before authentication completed for another reason.

Method Details

values

public static AlpacaStreamAuthResult.Status[] 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 AlpacaStreamAuthResult.Status 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