content: /*
   ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
   ~                                                                               ~
   ~ The MIT License (MIT)                                                         ~
   ~                                                                               ~
   ~ Copyright (c) 2015-2025 miaixz.org OSHI and other contributors.               ~
   ~                                                                               ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy  ~
   ~ of this software and associated documentation files (the "Software"), to deal ~
   ~ in the Software without restriction, including without limitation the rights  ~
   ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell     ~
   ~ copies of the Software, and to permit persons to whom the Software is         ~
   ~ furnished to do so, subject to the following conditions:                      ~
   ~                                                                               ~
   ~ The above copyright notice and this permission notice shall be included in    ~
   ~ all copies or substantial portions of the Software.                           ~
   ~                                                                               ~
   ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR    ~
   ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      ~
   ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE   ~
   ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER        ~
   ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, ~
   ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN     ~
   ~ THE SOFTWARE.                                                                 ~
   ~                                                                               ~
   ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
  */
  package org.miaixz.bus.health.builtin.hardware;
  
  import java.util.List;
  
  import org.miaixz.bus.core.lang.annotation.Immutable;
  
  /**
   * A USB device is a device connected via a USB port, possibly internally/permanently. Hubs may contain ports to which
   * other devices connect in a recursive fashion.
   *
   * @author Kimi Liu
   * @since Java 17+
   */
  @Immutable
  public interface UsbDevice extends Comparable<UsbDevice> {
  
      /**
       * Name of the USB device
       *
       * @return The device name
       */
      String getName();
  
      /**
       * Vendor that manufactured the USB device
       *
       * @return The vendor name
       */
      String getVendor();
  
      /**
       * ID of the vendor that manufactured the USB device
       *
       * @return The vendor ID, a 4-digit hex string
       */
      String getVendorId();
  
      /**
       * Product ID of the USB device
       *
       * @return The product ID, a 4-digit hex string
       */
      String getProductId();
  
      /**
       * Serial number of the USB device
       *
       * @return The serial number, if known
       */
      String getSerialNumber();
  
      /**
       * A Unique Device ID of the USB device, such as the PnPDeviceID (Windows), Device Node Path (Linux), Registry Entry
       * ID (macOS), or Device Node number (Unix)
       *
       * @return The Unique Device ID
       */
      String getUniqueDeviceId();
  
      /**
       * Other devices connected to this hub
       *
       * @return An {@code UnmodifiableList} of other devices connected to this hub, if any, or an empty list if none
       */
      List<UsbDevice> getConnectedDevices();
  
  }
  