Package org.hid4java

Enum ScanMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScanMode>

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

      Enum Constants 
      Enum Constant Description
      NO_SCAN
      Equivalent to scan interval of zero.
      SCAN_AT_FIXED_INTERVAL
      Trigger continuous scan at given interval.
      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.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ScanMode()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ScanMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ScanMode[] 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

      • 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 Detail

      • ScanMode

        private ScanMode()
    • Method Detail

      • values

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

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