Package com.yubico.yubikit.core

Enum Class UsbInterface.Mode

java.lang.Object

java.lang.Enum<UsbInterface.Mode>

com.yubico.yubikit.core.UsbInterface.Mode

All Implemented Interfaces:

Serializable, Comparable<UsbInterface.Mode>, Constable

Enclosing class:

UsbInterface

public static enum UsbInterface.Mode
extends Enum<UsbInterface.Mode>

Used for configuring USB Mode for YubiKey 3 and 4.

This is replaced by DeviceConfig starting with YubiKey 5.

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
CCID
FIDO
FIDO_CCID
OTP
OTP_CCID
OTP_FIDO
OTP_FIDO_CCID

Field Summary

Fields

Modifier and Type	Field	Description
final int	interfaces
final byte	value

Method Summary

Modifier and Type	Method	Description
static UsbInterface.Mode	getMode(int interfaces)	Returns the USB Mode given the enabled USB interfaces it has.
static UsbInterface.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UsbInterface.Mode[]	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

OTP

public static final UsbInterface.Mode OTP

CCID

public static final UsbInterface.Mode CCID

OTP_CCID

public static final UsbInterface.Mode OTP_CCID

FIDO

public static final UsbInterface.Mode FIDO

OTP_FIDO

public static final UsbInterface.Mode OTP_FIDO

FIDO_CCID

public static final UsbInterface.Mode FIDO_CCID

OTP_FIDO_CCID

public static final UsbInterface.Mode OTP_FIDO_CCID

Field Details

value

public final byte value

interfaces

public final int interfaces

Method Details

values

public static UsbInterface.Mode[] 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 UsbInterface.Mode 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

getMode

public static UsbInterface.Mode getMode(int interfaces)

Returns the USB Mode given the enabled USB interfaces it has.