oshi.json.hardware

Interface HardwareAbstractionLayer

All Superinterfaces:

OshiJsonObject, Serializable

All Known Implementing Classes:

HardwareAbstractionLayerImpl

public interface HardwareAbstractionLayer
extends OshiJsonObject

A hardware abstraction layer. Provides access to hardware items such as processors, memory, battery, and disks.

Author:

dblock[at]dblock[dot]org

Method Summary

Modifier and Type	Method and Description
ComputerSystem	getComputerSystem() Instantiates a ComputerSystem object.
HWDiskStore[]	getDiskStores() Instantiates an array of HWDiskStore objects, representing a physical hard disk or other similar storage device
Display[]	getDisplays() Instantiates an array of Display objects, representing monitors or other video output devices.
GlobalMemory	getMemory() Instantiates a GlobalMemory object.
NetworkIF[]	getNetworkIFs() Instantiates an array of NetworkIF objects, representing a network interface
PowerSource[]	getPowerSources() Instantiates an array of PowerSource objects, representing batteries, etc.
CentralProcessor	getProcessor() Instantiates a CentralProcessor object.
Sensors	getSensors() Instantiates a Sensors object, representing CPU temperature and fan speed
UsbDevice[]	getUsbDevices(boolean tree) Instantiates an array of UsbDevice objects, representing devices connected via a usb port (including internal devices).

Methods inherited from interface oshi.json.json.OshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toJSON, toPrettyJSON, toPrettyJSON

Method Detail

getComputerSystem

ComputerSystem getComputerSystem()

Instantiates a ComputerSystem object. This represents the physical hardware, including components such as BIOS/Firmware and a motherboard, logic board, etc.

Returns:

a ComputerSystem object.

getProcessor

CentralProcessor getProcessor()

Instantiates a CentralProcessor object. This represents one or more Logical CPUs.

Returns:

A CentralProcessor object.

getMemory

GlobalMemory getMemory()

Instantiates a GlobalMemory object.

Returns:

A memory object.

getPowerSources

PowerSource[] getPowerSources()

Instantiates an array of PowerSource objects, representing batteries, etc.

Returns:

An array of PowerSource objects or an empty array if none are present.

getDiskStores

HWDiskStore[] getDiskStores()

Instantiates an array of HWDiskStore objects, representing a physical hard disk or other similar storage device

Returns:

An array of HWDiskStore objects or an empty array if none are present.

getNetworkIFs

NetworkIF[] getNetworkIFs()

Instantiates an array of NetworkIF objects, representing a network interface

Returns:

An array of HWNetworkStore objects or an empty array if none are present.

getDisplays

Display[] getDisplays()

Instantiates an array of Display objects, representing monitors or other video output devices.

Returns:

An array of Display objects or an empty array if none are present.

getSensors

Sensors getSensors()

Instantiates a Sensors object, representing CPU temperature and fan speed

Returns:

A Sensors object

getUsbDevices

UsbDevice[] getUsbDevices(boolean tree)

Instantiates an array of UsbDevice objects, representing devices connected via a usb port (including internal devices). If the value of tree is true, the top level devices returned from this method are the USB Controllers; connected hubs and devices in its device tree share that controller's bandwidth. If the value of tree is false, USB devices (not controllers) are listed in a single flat array. In the JSON output, this parameter may be specified by the "hardware.usbDevices.tree" property value.

Parameters:

tree - WHether to display devices in a nested tree format from their controllers

Returns:

An array of UsbDevice objects representing (optionally) the USB Controllers and devices connected to them, or an empty array if none are present