Package com.yubico.yubikit.management

Enum FormFactor

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FormFactor>
    public enum FormFactor
extends java.lang.Enum<FormFactor>
    The physical form factor of a YubiKey.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      UNKNOWN
      Used when information about the YubiKey's form factor isn't available.
      USB_A_BIO
      A keychain-sized YubiKey with fingerprint sensor and USB-A connector.
      USB_A_KEYCHAIN
      A keychain-sized YubiKey with a USB-A connector.
      USB_A_NANO
      A nano-sized YubiKey with a USB-A connector.
      USB_C_BIO
      A keychain-sized YubiKey with fingerprint sensor and USB-C connector.
      USB_C_KEYCHAIN
      A keychain-sized YubiKey with a USB-C connector.
      USB_C_LIGHTNING
      A keychain-sized YubiKey with both USB-C and Lightning connectors.
      USB_C_NANO
      A nano-sized YubiKey with a USB-C connector.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int value  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FormFactor valueOf​(int value)
      Returns the form factor corresponding to the given Management application form factor constant, or UNKNOWN if the value is unknown.
      static FormFactor valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FormFactor[] 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

      • UNKNOWN

        public static final FormFactor UNKNOWN
        Used when information about the YubiKey's form factor isn't available.

      • USB_A_KEYCHAIN

        public static final FormFactor USB_A_KEYCHAIN
        A keychain-sized YubiKey with a USB-A connector.

      • USB_A_NANO

        public static final FormFactor USB_A_NANO
        A nano-sized YubiKey with a USB-A connector.

      • USB_C_KEYCHAIN

        public static final FormFactor USB_C_KEYCHAIN
        A keychain-sized YubiKey with a USB-C connector.

      • USB_C_NANO

        public static final FormFactor USB_C_NANO
        A nano-sized YubiKey with a USB-C connector.

      • USB_C_LIGHTNING

        public static final FormFactor USB_C_LIGHTNING
        A keychain-sized YubiKey with both USB-C and Lightning connectors.

      • USB_A_BIO

        public static final FormFactor USB_A_BIO
        A keychain-sized YubiKey with fingerprint sensor and USB-A connector.

      • USB_C_BIO

        public static final FormFactor USB_C_BIO
        A keychain-sized YubiKey with fingerprint sensor and USB-C connector.

    • Field Detail

      • value

        public final int value

    • Method Detail

      • values

        public static FormFactor[] 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 (FormFactor c : FormFactor.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • valueOf

        public static FormFactor valueOf​(int value)
        Returns the form factor corresponding to the given Management application form factor constant, or UNKNOWN if the value is unknown.