io.fusionauth.domain.event

Enum UserActionPhase

java.lang.Object

java.lang.Enum<UserActionPhase>

io.fusionauth.domain.event.UserActionPhase

All Implemented Interfaces:

Serializable, Comparable<UserActionPhase>

public enum UserActionPhase
extends Enum<UserActionPhase>

The phases of a time-based user action.

Author:

Brian Pontarelli

Enum Constant Summary

Enum Constants

Enum Constant and Description
cancel The user action was canceled
end The user action ended.
modify The user action was modified.
start The user action started.

Method Summary

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

start

public static final UserActionPhase start

The user action started.

modify

public static final UserActionPhase modify

The user action was modified.

cancel

public static final UserActionPhase cancel

The user action was canceled

end

public static final UserActionPhase end

The user action ended.

Method Detail

values

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

Returns:

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

valueOf

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