com.facebook.battery.metrics.devicebattery

Class DeviceBatteryMetricsCollector

java.lang.Object

com.facebook.battery.metrics.api.SystemMetricsCollector<DeviceBatteryMetrics>

com.facebook.battery.metrics.devicebattery.DeviceBatteryMetricsCollector

public class DeviceBatteryMetricsCollector
extends SystemMetricsCollector<DeviceBatteryMetrics>

Collects data about DeviceBatteryMetrics. This relies on maintaining the charging state and hence will probably not work in Doze mode (N+) where the broadcasts for power connected/disconnected are not guranteed to be relayed to the app.

Constructor Summary

Constructors

Constructor and Description
DeviceBatteryMetricsCollector(Context context)

Method Summary

Modifier and Type	Method and Description
DeviceBatteryMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(DeviceBatteryMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceBatteryMetricsCollector

public DeviceBatteryMetricsCollector(Context context)

Method Detail

getSnapshot

public boolean getSnapshot(DeviceBatteryMetrics snapshot)

Description copied from class: SystemMetricsCollector

Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.

Specified by:

getSnapshot in class SystemMetricsCollector<DeviceBatteryMetrics>

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public DeviceBatteryMetrics createMetrics()

Description copied from class: SystemMetricsCollector

Creates an empty instance of the corresponding system metrics.

Explicitly having this function available reduces a significant amount of boilerplate

Specified by:

createMetrics in class SystemMetricsCollector<DeviceBatteryMetrics>

Returns:

New System Metrics object