oshi.hardware.common

Class AbstractPowerSource

java.lang.Object

oshi.hardware.common.AbstractPowerSource

All Implemented Interfaces:

Serializable, PowerSource

Direct Known Subclasses:

FreeBsdPowerSource, LinuxPowerSource, MacPowerSource, SolarisPowerSource, WindowsPowerSource

public abstract class AbstractPowerSource
extends Object
implements PowerSource

A Power Source

Author:

widdis[at]gmail[dot]com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected double	remainingCapacity
protected double	timeRemaining

Constructor Summary

Constructors

Constructor and Description
AbstractPowerSource(String newName, double newRemainingCapacity, double newTimeRemaining) Super constructor used by platform-specific implementations of PowerSource

Method Summary

Modifier and Type	Method and Description
String	getName() Name of the power source (e.g., InternalBattery-0)
double	getRemainingCapacity() Remaining capacity as a fraction of max capacity.
double	getTimeRemaining() Estimated time remaining on the power source, in seconds.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

remainingCapacity

protected double remainingCapacity

timeRemaining

protected double timeRemaining

Constructor Detail

AbstractPowerSource

public AbstractPowerSource(String newName,
                           double newRemainingCapacity,
                           double newTimeRemaining)

Super constructor used by platform-specific implementations of PowerSource

Parameters:

newName - The name to assign

newRemainingCapacity - Fraction of remaining capacity

newTimeRemaining - Seconds of time remaining

Method Detail

getName

public String getName()

Name of the power source (e.g., InternalBattery-0)

Specified by:

getName in interface PowerSource

Returns:

The power source name

getRemainingCapacity

public double getRemainingCapacity()

Remaining capacity as a fraction of max capacity.

Specified by:

getRemainingCapacity in interface PowerSource

Returns:

A value between 0.0 (fully drained) and 1.0 (fully charged)

getTimeRemaining

public double getTimeRemaining()

Estimated time remaining on the power source, in seconds.

Specified by:

getTimeRemaining in interface PowerSource

Returns:

If positive, seconds remaining. If negative, -1.0 (calculating) or -2.0 (unlimited)