Package oshi.hardware.common

Class AbstractUsbDevice

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractUsbDevice​(java.lang.String name, java.lang.String vendor, java.lang.String vendorId, java.lang.String productId, java.lang.String serialNumber, java.lang.String uniqueDeviceId, java.util.List<UsbDevice> connectedDevices)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(UsbDevice usb)  
      java.util.List<UsbDevice> getConnectedDevices()
      Other devices connected to this hub
      java.lang.String getName()
      Name of the USB device
      java.lang.String getProductId()
      Product ID of the USB device
      java.lang.String getSerialNumber()
      Serial number of the USB device
      java.lang.String getUniqueDeviceId()
      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)
      java.lang.String getVendor()
      Vendor that manufactured the USB device
      java.lang.String getVendorId()
      ID of the vendor that manufactured the USB device
      private static java.lang.String indentUsb​(UsbDevice usbDevice, int indent)
      Helper method for indenting chained USB devices
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • name

        private final java.lang.String name

      • vendor

        private final java.lang.String vendor

      • vendorId

        private final java.lang.String vendorId

      • productId

        private final java.lang.String productId

      • serialNumber

        private final java.lang.String serialNumber

      • uniqueDeviceId

        private final java.lang.String uniqueDeviceId

      • connectedDevices

        private final java.util.List<UsbDevice> connectedDevices

    • Constructor Detail

      • AbstractUsbDevice

        protected AbstractUsbDevice​(java.lang.String name,
                            java.lang.String vendor,
                            java.lang.String vendorId,
                            java.lang.String productId,
                            java.lang.String serialNumber,
                            java.lang.String uniqueDeviceId,
                            java.util.List<UsbDevice> connectedDevices)

    • Method Detail

      • getName

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

      • getVendor

        public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.lang.Comparable<UsbDevice>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • indentUsb

        private static java.lang.String indentUsb​(UsbDevice usbDevice,
                                          int indent)
        Helper method for indenting chained USB devices
        Parameters:
        usbDevice - A USB device to print
        indent - number of spaces to indent
        Returns:
        The device toString, indented