org.apereo.cas.logout

Enum LogoutRequestStatus

java.lang.Object

java.lang.Enum<LogoutRequestStatus>

org.apereo.cas.logout.LogoutRequestStatus

All Implemented Interfaces:

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

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

Define the status of a logout request.

Since:

4.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILURE The logout request has failed.
NOT_ATTEMPTED The logout request has not been performed.
SUCCESS The logout request is successful.

Method Summary

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

NOT_ATTEMPTED

public static final LogoutRequestStatus NOT_ATTEMPTED

The logout request has not been performed.

FAILURE

public static final LogoutRequestStatus FAILURE

The logout request has failed.

SUCCESS

public static final LogoutRequestStatus SUCCESS

The logout request is successful.

Method Detail

values

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

Returns:

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

valueOf

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