oshi.json.hardware.impl

Class HardwareAbstractionLayerImpl

java.lang.Object

oshi.json.json.AbstractOshiJsonObject

oshi.json.hardware.impl.HardwareAbstractionLayerImpl

All Implemented Interfaces:

Serializable, HardwareAbstractionLayer, OshiJsonObject

public class HardwareAbstractionLayerImpl
extends AbstractOshiJsonObject
implements HardwareAbstractionLayer

Wrapper class to implement HardwareAbstractionLayer interface with platform-specific objects

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HardwareAbstractionLayerImpl(HardwareAbstractionLayer hardware) Creates a new platform-specific HardwareAbstractionLayer object wrapping the provided argument

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).
javax.json.JsonObject	toJSON(Properties properties) Returns this object as a JsonObject.

Methods inherited from class oshi.json.json.AbstractOshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.json.json.OshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON

Constructor Detail

HardwareAbstractionLayerImpl

public HardwareAbstractionLayerImpl(HardwareAbstractionLayer hardware)

Creates a new platform-specific HardwareAbstractionLayer object wrapping the provided argument

Parameters:

hardware - a platform-specific HardwareAbstractionLayer object

Method Detail

getComputerSystem

public ComputerSystem getComputerSystem()

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

Specified by:

getComputerSystem in interface HardwareAbstractionLayer

Returns:

a ComputerSystem object.

getProcessor

public CentralProcessor getProcessor()

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

Specified by:

getProcessor in interface HardwareAbstractionLayer

Returns:

A CentralProcessor object.

getMemory

public GlobalMemory getMemory()

Instantiates a GlobalMemory object.

Specified by:

getMemory in interface HardwareAbstractionLayer

Returns:

A memory object.

getPowerSources

public PowerSource[] getPowerSources()

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

Specified by:

getPowerSources in interface HardwareAbstractionLayer

Returns:

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

getDiskStores

public HWDiskStore[] getDiskStores()

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

Specified by:

getDiskStores in interface HardwareAbstractionLayer

Returns:

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

getNetworkIFs

public NetworkIF[] getNetworkIFs()

Instantiates an array of NetworkIF objects, representing a network interface

Specified by:

getNetworkIFs in interface HardwareAbstractionLayer

Returns:

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

getDisplays

public Display[] getDisplays()

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

Specified by:

getDisplays in interface HardwareAbstractionLayer

Returns:

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

getSensors

public Sensors getSensors()

Instantiates a Sensors object, representing CPU temperature and fan speed

Specified by:

getSensors in interface HardwareAbstractionLayer

Returns:

A Sensors object

getUsbDevices

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

Specified by:

getUsbDevices in interface HardwareAbstractionLayer

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

toJSON

public javax.json.JsonObject toJSON(Properties properties)

Returns this object as a JsonObject. The provided properties will be set on this object to configure the type of information returned using this and future invocations of OshiJsonObject.toJSON().

Specified by:

toJSON in interface OshiJsonObject

Parameters:

properties - Properties to configure returned results

Returns:

a JsonObject for this class.