com.khoros.messaging.core

Enum LoginResult

java.lang.Object

java.lang.Enum<LoginResult>

com.khoros.messaging.core.LoginResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LoginResult>

public enum LoginResult
extends java.lang.Enum<LoginResult>

Login response status

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Login failed
SUCCESS Login completed successfully

Method Summary

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

SUCCESS

public static final LoginResult SUCCESS

Login completed successfully

ERROR

public static final LoginResult ERROR

Login failed

Method Detail

values

public static LoginResult[] 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 (LoginResult c : LoginResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static LoginResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null