com.facebook.battery.metrics.time

Class TimeMetricsCollector

java.lang.Object

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

com.facebook.battery.metrics.time.TimeMetricsCollector

public class TimeMetricsCollector
extends SystemMetricsCollector<TimeMetrics>

Records system uptime (doesn't include time when the phone was asleep) and realtime (actual time elapsed). This is a fairly core collector that can be used to normalize the values obtained by all other collectors for comparison.

Constructor Summary

Constructors

Constructor and Description
TimeMetricsCollector()

Method Summary

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

TimeMetricsCollector

public TimeMetricsCollector()

Method Detail

getSnapshot

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

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

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

Returns:

New System Metrics object