Uses of Annotation Interface
oshi.annotation.PublicApi

Packages that use PublicApi

Package	Description
oshi.hardware	[oshi-common API] Provides cross-platform implementation to retrieve hardware information such as CPU, Memory, Display, Disks, Network Interfaces, Power Sources, Sensors, and USB Devices
oshi.software.os	[oshi-common API] Provides cross-platform common API to retrieve OS, FileSystem, and Process information
oshi.spi	Service Provider Interface for OSHI's SystemInfo entry points.
oshi.util	Provides utilities for parsing, formatting, and other access

Uses of PublicApi in oshi.hardware

Classes in oshi.hardware with annotations of type PublicApi

Modifier and Type	Interface	Description
interface	Baseboard	The Baseboard represents the system board, also called motherboard, logic board, etc.
interface	BluetoothDevice	Represents a Bluetooth device (paired or connected) known to the system, analogous to UsbDevice for USB peripherals.
interface	CentralProcessor	This class represents the entire Central Processing Unit (CPU) of a computer system, which may contain one or more physical packages (sockets), one or more physical processors (cores), and one or more logical processors (what the Operating System sees, which may include hyperthreaded cores.)
static class	CentralProcessor.LogicalProcessor	A class representing a Logical Processor and its replationship to physical processors, physical packages, and logical groupings such as NUMA Nodes and Processor groups, useful for identifying processor topology.
static class	CentralProcessor.PhysicalProcessor	A class representing a Physical Processor (a core) providing per-core statistics that may vary, particularly in hybrid/modular processors.
static class	CentralProcessor.ProcessorCache	A class representing CPU Cache Memory.
static enum	CentralProcessor.ProcessorCache.Type	The type of cache.
static final class	CentralProcessor.ProcessorIdentifier	A class encapsulating ghe CPU's identifier strings ,including name, vendor, stepping, model, and family information (also called the signature of a CPU)
static enum	CentralProcessor.TickType	Index of CPU tick counters in the CentralProcessor.getSystemCpuLoadTicks() and CentralProcessor.getProcessorCpuLoadTicks() arrays.
interface	ComputerSystem	The ComputerSystem represents the physical hardware, of a computer system/product and includes BIOS/firmware and a motherboard, logic board, etc.
interface	Display	Display refers to the information regarding a video source and monitor identified by the EDID standard.
interface	Firmware	The Firmware represents the low level BIOS or equivalent.
interface	GlobalMemory	The GlobalMemory class tracks information about the use of a computer's physical memory (RAM) as well as any available virtual memory.
interface	GpuStats	A session handle for sampling dynamic GPU metrics.
final class	GpuTicks	An immutable snapshot of cumulative GPU active and idle tick counters in opaque, platform-native units.
interface	GraphicsCard	Represents a graphics card (GPU) installed in the system.
interface	HardwareAbstractionLayer	A hardware abstraction layer.
interface	HWDiskStore	A storage mechanism where data are recorded by various electronic, magnetic, optical, or mechanical changes to a surface layer of one or more rotating disks or or flash storage such as a removable or solid state drive.
class	HWPartition	A region on a hard disk or other secondary storage, so that an operating system can manage information in each region separately.
interface	LogicalVolumeGroup	A logical volume group implemented as part of logical volume management, combining the space on one or more storage devices such as disks or partitions (physical volumes) into a storage pool, and subsequently allocating that space to virtual partitions (logical volumes) as block devices accessible to the file system.
interface	NetworkIF	A network interface in the machine, including statistics.
static enum	NetworkIF.IfOperStatus	The current operational state of a network interface.
class	PhysicalMemory	The PhysicalMemory class represents a physical memory device located on a computer system and available to the operating system.
interface	PowerSource	A Power Source represents a battery or UPS device with some capacity and charge/discharge state.
static enum	PowerSource.CapacityUnits	Units of Battery Capacity
interface	Printer	Represents a printer device available to the operating system, including its name, driver, status, and connection type (local or network).
static enum	Printer.PrinterStatus	Printer status enumeration.
interface	Sensors	Sensors include hardware sensors to monitor temperature, fan speed, and other information.
interface	SoundCard	Represents a sound card (audio adapter) installed in the system, providing the card name, driver version, and codec information.
interface	UsbDevice	A USB device is a device connected via a USB port, possibly internally/permanently.
interface	VirtualMemory	The VirtualMemory class tracks information about the use of a computer's virtual memory (swap file) which temporarily moves rarely accessed information to a disk or other storage device.

Uses of PublicApi in oshi.software.os

Classes in oshi.software.os with annotations of type PublicApi

Modifier and Type	Class	Description
class	ApplicationInfo	Represents common information about an installed application across different operating systems.
interface	CgroupInfo	Represents cgroup (control group) information for containerized environments.
interface	FileSystem	The File System is a logical arrangement, usually in a hierarchial tree, where files are placed for storage and retrieval.
interface	InternetProtocolStats	Provides key statistics for TCP and UDP network protocols, including aggregate counters and per-connection details.
static final class	InternetProtocolStats.IPConnection	Encapsulates information associated with an IP connection.
static enum	InternetProtocolStats.TcpState	The TCP connection state as described in RFC 793.
static final class	InternetProtocolStats.TcpStats	Encapsulates statistics associated with a TCP connection.
static final class	InternetProtocolStats.UdpStats	Encapsulates statistics associated with a UDP connection.
interface	NetworkParams	Provides network parameters of the running operating system, including the hostname, domain name, DNS server addresses, and default gateways for IPv4 and IPv6.
interface	OperatingSystem	An operating system (OS) is the software on a computer that manages the way different programs use its hardware, and regulates the ways that a user controls the computer.
static class	OperatingSystem.OSVersionInfo	A class representing the Operating System version details.
static final class	OperatingSystem.ProcessFiltering	Constants which may be used to filter Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).
static final class	OperatingSystem.ProcessSorting	Constants which may be used to sort Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).
class	OSDesktopWindow	This class encapsulates information about a window on the operating system's GUI desktop.
interface	OSFileStore	A FileStore represents a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.
interface	OSProcess	Represents a Process on the operating system, which may contain multiple threads.
static enum	OSProcess.State	Process and Thread Execution States
class	OSService	Operating system services are responsible for the management of platform resources, including the processor, memory, files, and input and output.
static enum	OSService.State	Service Execution States
class	OSSession	This class encapsulates information about users who are currently logged in to an operating system.
interface	OSThread	Represents a Thread/Task on the operating system.
static final class	OSThread.ThreadFiltering	Constants which may be used to filter Thread lists

Uses of PublicApi in oshi.spi

Classes in oshi.spi with annotations of type PublicApi

Modifier and Type	Class	Description
final class	SystemInfoFactory	Factory that uses ServiceLoader to discover and select the best available SystemInfoProvider.
interface	SystemInfoProvider	Service Provider Interface for OSHI's SystemInfo entry points.

Uses of PublicApi in oshi.util

Classes in oshi.util with annotations of type PublicApi

Modifier and Type	Class	Description
enum	PlatformEnum	An enumeration of supported operating systems.