com.webauthn4j.data

Enum ResidentKeyRequirement

java.lang.Object

java.lang.Enum<ResidentKeyRequirement>

com.webauthn4j.data.ResidentKeyRequirement

All Implemented Interfaces:

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

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

This enumeration’s values describe the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys)

See Also:

§5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCOURAGED
PREFERRED
REQUIRED

Method Summary

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

DISCOURAGED

public static final ResidentKeyRequirement DISCOURAGED

PREFERRED

public static final ResidentKeyRequirement PREFERRED

REQUIRED

public static final ResidentKeyRequirement REQUIRED

Method Detail

values

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

Returns:

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

valueOf

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

create

public static ResidentKeyRequirement create(java.lang.String value)

getValue

public java.lang.String getValue()