Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote

Enum Class AuthStatus

java.lang.Object

java.lang.Enum<AuthStatus>

com.thecoderscorner.menu.remote.AuthStatus

All Implemented Interfaces:

Serializable, Comparable<AuthStatus>, java.lang.constant.Constable

public enum AuthStatus
extends Enum<AuthStatus>

the authentication states that a RemoteMenuController can be in. Internally, the controller object is always in one of these states, and this is just the exterior view of the state.

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
AWAITING_CONNECTION
BOOTSTRAPPING
CONNECTION_FAILED
CONNECTION_READY
ESTABLISHED_CONNECTION
FAILED_AUTH
NOT_STARTED
SEND_AUTH

Method Summary

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

NOT_STARTED

public static final AuthStatus NOT_STARTED

AWAITING_CONNECTION

public static final AuthStatus AWAITING_CONNECTION

ESTABLISHED_CONNECTION

public static final AuthStatus ESTABLISHED_CONNECTION

SEND_AUTH

public static final AuthStatus SEND_AUTH

AUTHENTICATED

public static final AuthStatus AUTHENTICATED

FAILED_AUTH

public static final AuthStatus FAILED_AUTH

BOOTSTRAPPING

public static final AuthStatus BOOTSTRAPPING

CONNECTION_READY

public static final AuthStatus CONNECTION_READY

CONNECTION_FAILED

public static final AuthStatus CONNECTION_FAILED

Method Details

values

public static AuthStatus[] 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 AuthStatus 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()