Enum Class ScanMode

java.lang.Object
java.lang.Enum<ScanMode>
org.hid4java.ScanMode
All Implemented Interfaces:
Serializable, Comparable<ScanMode>, Constable

public enum ScanMode extends Enum<ScanMode>
Provide a collection of different device enumeration scanning modes so that device attach/detach events can be generated.
  • Enum Constant Details

    • NO_SCAN

      public static final ScanMode NO_SCAN
      Equivalent to scan interval of zero.
    • SCAN_AT_FIXED_INTERVAL

      public static final ScanMode SCAN_AT_FIXED_INTERVAL
      Trigger continuous scan at given interval.
    • SCAN_AT_FIXED_INTERVAL_WITH_PAUSE_AFTER_WRITE

      public static final ScanMode SCAN_AT_FIXED_INTERVAL_WITH_PAUSE_AFTER_WRITE
      Trigger continuous scan at given interval but introduce a pause after a write operation to allow the device time to process data without having to respond to further enumeration requests. This can be a useful strategy for handling devices with constrained processing power and/or limited USB stacks. Note this will affect the time to generate a device attach/detach event since scanning will be paused.
  • Constructor Details

    • ScanMode

      private ScanMode()
  • Method Details

    • values

      public static ScanMode[] 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 ScanMode 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