oshi.hardware.UsbDevice Maven / Gradle / Ivy
/**
* Oshi (https://github.com/dblock/oshi)
*
* Copyright (c) 2010 - 2016 The Oshi Project Team
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Maintainers:
* dblock[at]dblock[dot]org
* widdis[at]gmail[dot]com
* enrico.bianchi[at]gmail[dot]com
*
* Contributors:
* https://github.com/dblock/oshi/graphs/contributors
*/
package oshi.hardware;
import oshi.json.OshiJsonObject;
/**
* 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 widdis[at]gmail[dot]com
*/
public interface UsbDevice extends OshiJsonObject, Comparable {
/**
* 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();
/**
* Other devices connected to this hub
*
* @return An array of other devices connected to this hub, if any, or an
* empty array if none
*/
UsbDevice[] getConnectedDevices();
}