com.facebook.battery.metrics.appwakeup

Class AppWakeupMetricsCollector

java.lang.Object

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

com.facebook.battery.metrics.appwakeup.AppWakeupMetricsCollector

public class AppWakeupMetricsCollector
extends SystemMetricsCollector<AppWakeupMetrics>

This class is used to record and aggregate the wakeups in the app. It exposes methods to record start recordWakeupStart(AppWakeupMetrics.WakeupReason, String) and end recordWakeupEnd(String) of a wakeup

Constructor Summary

Constructors

Constructor and Description
AppWakeupMetricsCollector()

Method Summary

Modifier and Type	Method and Description
AppWakeupMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(AppWakeupMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.
void	recordWakeupEnd(java.lang.String id) Record the end of a wakeup.
void	recordWakeupStart(AppWakeupMetrics.WakeupReason reason, java.lang.String id) Record the start of a wakeup.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppWakeupMetricsCollector

public AppWakeupMetricsCollector()

Method Detail

getSnapshot

public boolean getSnapshot(AppWakeupMetrics 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<AppWakeupMetrics>

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public AppWakeupMetrics 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<AppWakeupMetrics>

Returns:

New System Metrics object

recordWakeupStart

public void recordWakeupStart(AppWakeupMetrics.WakeupReason reason,
                              java.lang.String id)

Record the start of a wakeup. If this method is called twice without calling recordWakeupEnd in between, we ignore the second recordWakeupStart call.

Parameters:

reason - One of the wakeup types defined in WakeupReason

id - Identifier of the wakeup

recordWakeupEnd

public void recordWakeupEnd(java.lang.String id)

Record the end of a wakeup. If this method is called without calling a corresponding recordWakeupStart, then we do nothing.

Parameters:

id - Identifier of the wakeup