Package oshi.hardware.common

Class AbstractUsbDevice

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected UsbDevice[] connectedDevices  
    protected java.lang.String name  
    protected java.lang.String productId  
    protected java.lang.String serialNumber  
    protected java.lang.String uniqueDeviceId  
    protected java.lang.String vendor  
    protected java.lang.String vendorId  

  • Constructor Summary

    Constructors 
    Constructor Description
    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, UsbDevice[] connectedDevices)
    Constructor for AbstractUsbDevice.

  • Method Summary

    Modifier and Type Method Description
    int compareTo​(UsbDevice usb)  
    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
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • AbstractUsbDevice

      public 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, UsbDevice[] connectedDevices)

      Constructor for AbstractUsbDevice.

      Parameters:
      name - a String object.
      vendor - a String object.
      vendorId - a String object.
      productId - a String object.
      serialNumber - a String object.
      uniqueDeviceId - a String object.
      connectedDevices - an array of UsbDevice objects.

  • Method Details

    • 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 UsbDevice[] getConnectedDevices()
      Description copied from interface: UsbDevice
      Other devices connected to this hub
      Specified by:
      getConnectedDevices in interface UsbDevice
      Returns:
      An array of other devices connected to this hub, if any, or an empty array 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