com.facebook.battery.metrics.api

Class SystemMetricsCollector<T extends SystemMetrics>

java.lang.Object

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

Direct Known Subclasses:

AppWakeupMetricsCollector, BluetoothMetricsCollector, CameraMetricsCollector, CompositeMetricsCollector, CpuFrequencyMetricsCollector, CpuMetricsCollector, DeviceBatteryMetricsCollector, NetworkMetricsCollector, RadioStateCollector, TimeMetricsCollector, WakeLockMetricsCollector

public abstract class SystemMetricsCollector<T extends SystemMetrics>
extends java.lang.Object

Takes snapshots of a given metric. There are generally two types of metrics collectors - - those that depend on an underlying api, such as the CpuMetricsCollector which reads from /proc. - those that are simply boxes of values and are triggered by custom instrumentation, such as the CameraMetricsCollector which should be triggered with every call to the android camera api.

Constructor Summary

Constructors

Constructor and Description
SystemMetricsCollector()

Method Summary

Modifier and Type	Method and Description
abstract T	createMetrics() Creates an empty instance of the corresponding system metrics.
abstract boolean	getSnapshot(T 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

SystemMetricsCollector

public SystemMetricsCollector()

Method Detail

getSnapshot

public abstract boolean getSnapshot(T snapshot)

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

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public abstract T createMetrics()

Creates an empty instance of the corresponding system metrics.

Explicitly having this function available reduces a significant amount of boilerplate

Returns:

New System Metrics object