Package nl.harm27.obswebsocket.authentication

Enum AuthenticationResult

java.lang.Object

java.lang.Enum<AuthenticationResult>

nl.harm27.obswebsocket.authentication.AuthenticationResult

All Implemented Interfaces:

Serializable, Comparable<AuthenticationResult>

public enum AuthenticationResult
extends Enum<AuthenticationResult>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATION_FAILED
AUTHENTICATION_NOT_REQUIRED
AUTHENTICATION_PASSWORD_MISSING
AUTHENTICATION_REQUIRED
AUTHENTICATION_REQUIRED_CHECKING
AUTHENTICATION_SUCCESS
UN_AVAILABLE

Method Summary

Modifier and Type	Method	Description
boolean	isComplete()
boolean	isSuccessful()
static AuthenticationResult	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthenticationResult[]	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 Detail

UN_AVAILABLE

public static final AuthenticationResult UN_AVAILABLE

AUTHENTICATION_REQUIRED

public static final AuthenticationResult AUTHENTICATION_REQUIRED

AUTHENTICATION_NOT_REQUIRED

public static final AuthenticationResult AUTHENTICATION_NOT_REQUIRED

AUTHENTICATION_PASSWORD_MISSING

public static final AuthenticationResult AUTHENTICATION_PASSWORD_MISSING

AUTHENTICATION_REQUIRED_CHECKING

public static final AuthenticationResult AUTHENTICATION_REQUIRED_CHECKING

AUTHENTICATION_SUCCESS

public static final AuthenticationResult AUTHENTICATION_SUCCESS

AUTHENTICATION_FAILED

public static final AuthenticationResult AUTHENTICATION_FAILED

Method Detail

values

public static AuthenticationResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthenticationResult c : AuthenticationResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthenticationResult 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

isSuccessful

public boolean isSuccessful()

isComplete

public boolean isComplete()