Class FreeBsdPowerSource

java.lang.Object

oshi.hardware.common.AbstractPowerSource

oshi.hardware.common.platform.unix.freebsd.FreeBsdPowerSource

All Implemented Interfaces:

PowerSource

public abstract class FreeBsdPowerSource
extends AbstractPowerSource

Shared FreeBSD power-source logic. Subclasses provide the sysctl backend (JNA or FFM) via queryBattery(String, BiFunction, PowerSourceFactory).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	FreeBsdPowerSource.PowerSourceFactory<T extends FreeBsdPowerSource>	Factory for creating platform-specific FreeBsdPowerSource instances.

Nested classes/interfaces inherited from interface PowerSource

PowerSource.CapacityUnits

Modifier and Type	Interface	Description
static enum	PowerSource.CapacityUnits	Units of Battery Capacity

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FreeBsdPowerSource(String psName, String psDeviceName, double psRemainingCapacityPercent, double psTimeRemainingEstimated, double psTimeRemainingInstant, double psPowerUsageRate, double psVoltage, double psAmperage, boolean psPowerOnLine, boolean psCharging, boolean psDischarging, PowerSource.CapacityUnits psCapacityUnits, int psCurrentCapacity, int psMaxCapacity, int psDesignCapacity, int psCycleCount, String psChemistry, LocalDate psManufactureDate, String psManufacturer, String psSerialNumber, double psTemperature)

Method Summary

Modifier and Type	Method	Description
protected static <T extends FreeBsdPowerSource> List<PowerSource>	queryBattery(String name, BiFunction<String,Integer,Integer> sysctlInt, FreeBsdPowerSource.PowerSourceFactory<T> factory)	Queries battery information and constructs a power source instance using the provided sysctl accessor and factory.

Methods inherited from class AbstractPowerSource

getAmperage, getCapacityUnits, getChemistry, getCurrentCapacity, getCycleCount, getDesignCapacity, getDeviceName, getManufactureDate, getManufacturer, getMaxCapacity, getName, getPowerUsageRate, getRemainingCapacityPercent, getSerialNumber, getTemperature, getTimeRemainingEstimated, getTimeRemainingInstant, getVoltage, isCharging, isDischarging, isPowerOnLine, queryPowerSources, toString, updateAttributes

Modifier and Type	Method	Description
double	getAmperage()	Amperage of the battery, in milliAmperes (mA).
PowerSource.CapacityUnits	getCapacityUnits()	Reports =the units of PowerSource.getCurrentCapacity(), PowerSource.getMaxCapacity(), and PowerSource.getDesignCapacity()
String	getChemistry()	The battery chemistry (e.g., Lithium Ion).
int	getCurrentCapacity()	The current (remaining) capacity of the battery.
int	getCycleCount()	The cycle count of the battery, if known.
int	getDesignCapacity()	The design (original) capacity of the battery.
String	getDeviceName()	Name of the power source at the device level.
LocalDate	getManufactureDate()	The battery's date of manufacture.
String	getManufacturer()	The name of the battery's manufacturer.
int	getMaxCapacity()	The maximum capacity of the battery.
String	getName()	Name of the power source at the Operating System level.
double	getPowerUsageRate()	Power Usage Rate of the battery, in milliWatts (mW).
double	getRemainingCapacityPercent()	Estimated remaining capacity as a fraction of max capacity.
String	getSerialNumber()	The battery's serial number.
double	getTemperature()	The battery's temperature, in degrees Celsius.
double	getTimeRemainingEstimated()	Estimated time remaining on the power source, in seconds, as reported by the operating system.
double	getTimeRemainingInstant()	Estimated time remaining on the power source, in seconds, as reported by the battery.
double	getVoltage()	Voltage of the battery, in Volts.
boolean	isCharging()	Reports whether the battery is charging.
boolean	isDischarging()	Reports whether the battery is discharging.
boolean	isPowerOnLine()	Reports whether the device is plugged in to an external power source.
protected abstract List<PowerSource>	queryPowerSources()	Returns a fresh list of power sources for this platform, used by AbstractPowerSource.updateAttributes().
String	toString()
boolean	updateAttributes()	Updates statistics on this battery.

Methods inherited from class Object

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

Constructor Details

FreeBsdPowerSource

protected FreeBsdPowerSource(String psName,
 String psDeviceName,
 double psRemainingCapacityPercent,
 double psTimeRemainingEstimated,
 double psTimeRemainingInstant,
 double psPowerUsageRate,
 double psVoltage,
 double psAmperage,
 boolean psPowerOnLine,
 boolean psCharging,
 boolean psDischarging,
 PowerSource.CapacityUnits psCapacityUnits,
 int psCurrentCapacity,
 int psMaxCapacity,
 int psDesignCapacity,
 int psCycleCount,
 String psChemistry,
 LocalDate psManufactureDate,
 String psManufacturer,
 String psSerialNumber,
 double psTemperature)

Method Details

queryBattery

protected static <T extends FreeBsdPowerSource>
List<PowerSource> queryBattery(String name,
 BiFunction<String,Integer,Integer> sysctlInt,
 FreeBsdPowerSource.PowerSourceFactory<T> factory)

Queries battery information and constructs a power source instance using the provided sysctl accessor and factory.

Type Parameters:

T - the concrete power source type

Parameters:

name - the battery name (e.g. "BAT0")

sysctlInt - reads an integer sysctl given (name, default)

factory - constructs the platform-specific instance

Returns:

a list containing the power source