oshi.json.hardware.impl

Class PowerSourceImpl

java.lang.Object

oshi.json.json.AbstractOshiJsonObject

oshi.json.hardware.impl.PowerSourceImpl

All Implemented Interfaces:

Serializable, PowerSource, OshiJsonObject

public class PowerSourceImpl
extends AbstractOshiJsonObject
implements PowerSource

Wrapper class to implement PowerSource interface with platform-specific objects

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PowerSourceImpl(PowerSource powerSource) Creates a new platform-specific PowerSource object wrapping the provided argument

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.
javax.json.JsonObject	toJSON(Properties properties) Returns this object as a JsonObject.

Methods inherited from class oshi.json.json.AbstractOshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.json.json.OshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON

Constructor Detail

PowerSourceImpl

public PowerSourceImpl(PowerSource powerSource)

Creates a new platform-specific PowerSource object wrapping the provided argument

Parameters:

powerSource - a platform-specific PowerSource object

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)

toJSON

public javax.json.JsonObject toJSON(Properties properties)

Returns this object as a JsonObject. The provided properties will be set on this object to configure the type of information returned using this and future invocations of OshiJsonObject.toJSON().

Specified by:

toJSON in interface OshiJsonObject

Parameters:

properties - Properties to configure returned results

Returns:

a JsonObject for this class.