org.apereo.cas.consent

Enum ConsentOptions

java.lang.Object

java.lang.Enum<ConsentOptions>

org.apereo.cas.consent.ConsentOptions

All Implemented Interfaces:

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

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

This is ConsentOptions.

Since:

5.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always ask for consent.
ATTRIBUTE_NAME Always ask for consent.
ATTRIBUTE_VALUE Always ask for consent.

Method Summary

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

ALWAYS

public static final ConsentOptions ALWAYS

Always ask for consent.

ATTRIBUTE_NAME

public static final ConsentOptions ATTRIBUTE_NAME

Always ask for consent.

ATTRIBUTE_VALUE

public static final ConsentOptions ATTRIBUTE_VALUE

Always ask for consent.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

valueOf

public static ConsentOptions valueOf(int value)

Value of consent options.

Parameters:

value - the value

Returns:

the consent options