Package com.broadleafcommerce.auth.user.domain

Enum Class UserAttemptResult

java.lang.Object

java.lang.Enum<UserAttemptResult>

com.broadleafcommerce.auth.user.domain.UserAttemptResult

All Implemented Interfaces:

Serializable, Comparable<UserAttemptResult>, Constable

public enum UserAttemptResult
extends Enum<UserAttemptResult>

Represents the result of a user attempt for actions such as changing or resetting the password.

Since:

2.1.3

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
FAILURE
SUCCESS

Method Summary

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

SUCCESS

public static final UserAttemptResult SUCCESS

FAILURE

public static final UserAttemptResult FAILURE

Method Details

values

public static UserAttemptResult[] 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 UserAttemptResult 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

isSuccess

public static boolean isSuccess(String result)

isFailure

public static boolean isFailure(String result)