oshi.hardware.common

Class AbstractUsbDevice

java.lang.Object

oshi.hardware.common.AbstractUsbDevice

All Implemented Interfaces:

Comparable<UsbDevice>, UsbDevice

Direct Known Subclasses:

FreeBsdUsbDevice, LinuxUsbDevice, MacUsbDevice, SolarisUsbDevice, WindowsUsbDevice

public abstract class AbstractUsbDevice
extends Object
implements UsbDevice

A USB device

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractUsbDevice(String name, String vendor, String vendorId, String productId, String serialNumber, String uniqueDeviceId, UsbDevice[] connectedDevices) Constructor for AbstractUsbDevice.

Method Summary

Modifier and Type	Method and Description
int	compareTo(UsbDevice usb)
UsbDevice[]	getConnectedDevices() Other devices connected to this hub
String	getName() Name of the USB device
String	getProductId() Product ID of the USB device
String	getSerialNumber() Serial number of the USB device
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)
String	getVendor() Vendor that manufactured the USB device
String	getVendorId() ID of the vendor that manufactured the USB device
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

vendor

protected String vendor

vendorId

protected String vendorId

productId

protected String productId

serialNumber

protected String serialNumber

uniqueDeviceId

protected String uniqueDeviceId

connectedDevices

protected UsbDevice[] connectedDevices

Constructor Detail

AbstractUsbDevice

public AbstractUsbDevice(String name,
                         String vendor,
                         String vendorId,
                         String productId,
                         String serialNumber,
                         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 Detail

getName

public String getName()

Name of the USB device

Specified by:

getName in interface UsbDevice

Returns:

The device name

getVendor

public String getVendor()

Vendor that manufactured the USB device

Specified by:

getVendor in interface UsbDevice

Returns:

The vendor name

getVendorId

public String getVendorId()

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()

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()

Serial number of the USB device

Specified by:

getSerialNumber in interface UsbDevice

Returns:

The serial number, if known

getUniqueDeviceId

public 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)

Specified by:

getUniqueDeviceId in interface UsbDevice

Returns:

The Unique Device ID

getConnectedDevices

public UsbDevice[] getConnectedDevices()

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 Comparable<UsbDevice>

toString

public String toString()

Overrides:

toString in class Object