Module com.github.oshi

Package oshi.hardware.platform.linux

Class LinuxHardwareAbstractionLayer

java.lang.Object

oshi.hardware.common.AbstractHardwareAbstractionLayer

oshi.hardware.platform.linux.LinuxHardwareAbstractionLayer

All Implemented Interfaces:

HardwareAbstractionLayer

@ThreadSafe
public final class LinuxHardwareAbstractionLayer
extends AbstractHardwareAbstractionLayer

LinuxHardwareAbstractionLayer class.

Constructor Summary

Constructors

Constructor	Description
LinuxHardwareAbstractionLayer()

Method Summary

Modifier and Type	Method	Description
ComputerSystem	createComputerSystem()	Instantiates the platform-specific ComputerSystem object
GlobalMemory	createMemory()	Instantiates the platform-specific GlobalMemory object
CentralProcessor	createProcessor()	Instantiates the platform-specific CentralProcessor object
Sensors	createSensors()	Instantiates the platform-specific Sensors object
List<HWDiskStore>	getDiskStores()	Instantiates a list of HWDiskStore objects, representing physical hard disks or other similar storage devices.
List<Display>	getDisplays()	Instantiates a list of Display objects, representing monitors or other video output devices.
List<GraphicsCard>	getGraphicsCards()	Instantiates a list of GraphicsCard objects, representing the Graphics cards.
List<LogicalVolumeGroup>	getLogicalVolumeGroups()	Instantiates a list of LogicalVolumeGroup objects, representing a storage pool or group of devices, partitions, volumes, or other implementation specific means of file storage.
List<NetworkIF>	getNetworkIFs(boolean includeLocalInterfaces)	Gets a list NetworkIF objects, representing a network interface.
List<PowerSource>	getPowerSources()	Instantiates a list of PowerSource objects, representing batteries, etc.
List<SoundCard>	getSoundCards()	Instantiates a list of SoundCard objects, representing the Sound cards.
List<UsbDevice>	getUsbDevices(boolean tree)	Instantiates a list of UsbDevice objects, representing devices connected via a usb port (including internal devices).

Methods inherited from class oshi.hardware.common.AbstractHardwareAbstractionLayer

getComputerSystem, getMemory, getNetworkIFs, getProcessor, getSensors

Methods inherited from class java.lang.Object

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

Constructor Details

LinuxHardwareAbstractionLayer

public LinuxHardwareAbstractionLayer()

Method Details

createComputerSystem

public ComputerSystem createComputerSystem()

Description copied from class: AbstractHardwareAbstractionLayer

Instantiates the platform-specific ComputerSystem object

Specified by:

createComputerSystem in class AbstractHardwareAbstractionLayer

Returns:

platform-specific ComputerSystem object

createMemory

public GlobalMemory createMemory()

Description copied from class: AbstractHardwareAbstractionLayer

Instantiates the platform-specific GlobalMemory object

Specified by:

createMemory in class AbstractHardwareAbstractionLayer

Returns:

platform-specific GlobalMemory object

createProcessor

public CentralProcessor createProcessor()

Description copied from class: AbstractHardwareAbstractionLayer

Instantiates the platform-specific CentralProcessor object

Specified by:

createProcessor in class AbstractHardwareAbstractionLayer

Returns:

platform-specific CentralProcessor object

createSensors

public Sensors createSensors()

Description copied from class: AbstractHardwareAbstractionLayer

Instantiates the platform-specific Sensors object

Specified by:

createSensors in class AbstractHardwareAbstractionLayer

Returns:

platform-specific Sensors object

getPowerSources

public List<PowerSource> getPowerSources()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of PowerSource objects, representing batteries, etc.

Returns:

A list of PowerSource objects or an empty list if none are present.

getDiskStores

public List<HWDiskStore> getDiskStores()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of HWDiskStore objects, representing physical hard disks or other similar storage devices.

Returns:

A list of HWDiskStore objects or an empty list if none are present.

getLogicalVolumeGroups

public List<LogicalVolumeGroup> getLogicalVolumeGroups()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of LogicalVolumeGroup objects, representing a storage pool or group of devices, partitions, volumes, or other implementation specific means of file storage.

If not yet implemented or if logical volume groups do not exist, returns an empty list.

Currently implemented for Linux (LVM2), macOS (Core Storage), and Windows (Storage Spaces).

Returns:

A list of LogicalVolumeGroup objects or an empty list if none are present.

getDisplays

public List<Display> getDisplays()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of Display objects, representing monitors or other video output devices.

Returns:

A list of Display objects or an empty list if none are present.

getNetworkIFs

public List<NetworkIF> getNetworkIFs(boolean includeLocalInterfaces)

Description copied from interface: HardwareAbstractionLayer

Gets a list NetworkIF objects, representing a network interface.

Parameters:

includeLocalInterfaces - whether to include local interfaces (loopback or no hardware address) in the result

Returns:

A list of NetworkIF objects representing the interfaces

getUsbDevices

public List<UsbDevice> getUsbDevices(boolean tree)

Description copied from interface: HardwareAbstractionLayer

Instantiates a list 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 list.

Parameters:

tree - If true, returns devices connected to the existing device, accessible via UsbDevice.getConnectedDevices(). If false returns devices as a flat list with no connected device information.

Returns:

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

getSoundCards

public List<SoundCard> getSoundCards()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of SoundCard objects, representing the Sound cards.

Returns:

A list of SoundCard objects or an empty list if none are present.

getGraphicsCards

public List<GraphicsCard> getGraphicsCards()

Description copied from interface: HardwareAbstractionLayer

Instantiates a list of GraphicsCard objects, representing the Graphics cards.

Returns:

A list of objects or an empty list if none are present.