Class AbstractUsbDevice

java.lang.Object
oshi.hardware.common.AbstractUsbDevice
All Implemented Interfaces:
Comparable<UsbDevice>, UsbDevice
Direct Known Subclasses:
AixUsbDevice, FreeBsdUsbDevice, LinuxUsbDevice, MacUsbDevice, OpenBsdUsbDevice, SolarisUsbDevice, WindowsUsbDeviceJNA
@Immutable public abstract class AbstractUsbDevice extends Object implements UsbDevice
A USB device

  • Constructor Details

    • AbstractUsbDevice

      protected AbstractUsbDevice(String name, String vendor, String vendorId, String productId, String serialNumber, String uniqueDeviceId, List<UsbDevice> connectedDevices)
      Creates an AbstractUsbDevice with the given parameters.
      Parameters:
      name - the device name
      vendor - the vendor name
      vendorId - the vendor ID
      productId - the product ID
      serialNumber - the serial number
      uniqueDeviceId - the unique device ID
      connectedDevices - the list of connected child devices

  • Method Details

    • getName

      public String getName()
      Description copied from interface: UsbDevice
      Name of the USB device
      Specified by:
      getName in interface UsbDevice
      Returns:
      The device name

    • getVendor

      public String getVendor()
      Description copied from interface: UsbDevice
      Vendor that manufactured the USB device
      Specified by:
      getVendor in interface UsbDevice
      Returns:
      The vendor name

    • getVendorId

      public String getVendorId()
      Description copied from interface: UsbDevice
      ID of the vendor that manufactured the USB device
      Specified by:
      getVendorId in interface UsbDevice
      Returns:
      The vendor ID, a 4-digit hex string

    • getProductId

      public String getProductId()
      Description copied from interface: UsbDevice
      Product ID of the USB device
      Specified by:
      getProductId in interface UsbDevice
      Returns:
      The product ID, a 4-digit hex string

    • getSerialNumber

      public String getSerialNumber()
      Description copied from interface: UsbDevice
      Serial number of the USB device
      Specified by:
      getSerialNumber in interface UsbDevice
      Returns:
      The serial number, if known

    • getUniqueDeviceId

      public String getUniqueDeviceId()
      Description copied from interface: UsbDevice
      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)
      Specified by:
      getUniqueDeviceId in interface UsbDevice
      Returns:
      The Unique Device ID

    • getConnectedDevices

      public List<UsbDevice> getConnectedDevices()
      Description copied from interface: UsbDevice
      Other devices connected to this hub
      Specified by:
      getConnectedDevices in interface UsbDevice
      Returns:
      An UnmodifiableList of other devices connected to this hub, if any, or an empty list if none

    • compareTo

      public int compareTo(UsbDevice usb)
      Specified by:
      compareTo in interface Comparable<UsbDevice>

    • addDevicesToList

      protected static void addDevicesToList(List<UsbDevice> deviceList, List<UsbDevice> list)
      Recursively adds USB devices from list to deviceList, depth-first.
      Parameters:
      deviceList - the target list to add devices to
      list - the source list of devices (and their children) to add

    • toString

      public String toString()
      Overrides:
      toString in class Object