Package io.github.eggy03.dmidecode.service.memory

Class DMIPhysicalMemoryArrayService

java.lang.Object

io.github.eggy03.dmidecode.service.memory.DMIPhysicalMemoryArrayService

All Implemented Interfaces:

OptionalCommonDMIServiceInterface<DMIPhysicalMemoryArray>

public class DMIPhysicalMemoryArrayService
extends Object
implements OptionalCommonDMIServiceInterface<DMIPhysicalMemoryArray>

Service class for fetching physical memory array information from the system.

This class executes the DMIType.PHYSICAL_MEMORY_ARRAY dmidecode command and maps the resulting output into a DMIPhysicalMemoryArray object.

Usage examples

 DMIPhysicalMemoryArrayService service = new DMIPhysicalMemoryArrayService();
 Optional<DMIPhysicalMemoryArray> memoryArray = service.get(10);
 

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private final DMIPhysicalMemoryArrayMapper	mapper
private final TerminalService	terminalService

Constructor Summary

Constructors

Constructor	Description
DMIPhysicalMemoryArrayService()	Creates DMIPhysicalMemoryArrayService with default configuration.
DMIPhysicalMemoryArrayService(@NonNull TerminalService terminalService, @NonNull DMIPhysicalMemoryArrayMapper mapper)	Package Private constructor with injectable dependencies

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<DMIPhysicalMemoryArray>	get(long timeout)	Retrieves physical memory array information present in the system using an isolated dmidecode process with a configurable timeout.

Methods inherited from class java.lang.Object

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

Field Details

terminalService

private final TerminalService terminalService

mapper

private final DMIPhysicalMemoryArrayMapper mapper

Constructor Details

DMIPhysicalMemoryArrayService

public DMIPhysicalMemoryArrayService()

Creates DMIPhysicalMemoryArrayService with default configuration.

Since:

0.3.0

DMIPhysicalMemoryArrayService

DMIPhysicalMemoryArrayService(@NonNull TerminalService terminalService,
 @NonNull DMIPhysicalMemoryArrayMapper mapper)

Package Private constructor with injectable dependencies

Parameters:

terminalService - the TerminalService instance to use, must not be null

mapper - the mapper instance to use, must not be null

Since:

0.3.0

Method Details

get

public @NonNull Optional<DMIPhysicalMemoryArray> get(long timeout)

Retrieves physical memory array information present in the system using an isolated dmidecode process with a configurable timeout.

The process is pre-maturely terminated if execution exceeds the specified timeout.

Specified by:

get in interface OptionalCommonDMIServiceInterface<DMIPhysicalMemoryArray>

Parameters:

timeout - the maximum time (in seconds) to wait for the dmidecode command to complete before terminating the process

Returns:

an Optional containing DMIPhysicalMemoryArray information if present, or Optional.empty() if no physical memory array entry is detected

Since:

0.1.0