com.facebook.battery.metrics.wakelock

Class WakeLockMetrics

java.lang.Object

com.facebook.battery.metrics.core.SystemMetrics<WakeLockMetrics>

com.facebook.battery.metrics.wakelock.WakeLockMetrics

All Implemented Interfaces:

java.io.Serializable

public class WakeLockMetrics
extends SystemMetrics<WakeLockMetrics>

Maintains state about total active wakelocks and the current time available.

A wakelock metrics object can also maintain attribution data if enabled at creation time -- this will come at the cost of extra memory to maintain this information.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
long	heldTimeMs
boolean	isAttributionEnabled
<any>	tagTimeMs

Constructor Summary

Constructors

Constructor and Description
WakeLockMetrics() Create a WakeLockMetrics object without attribution enabled.
WakeLockMetrics(boolean isAttributionEnabled) Create a WakeLockMetrics object and enable attribution based on the argument.

Method Summary

Modifier and Type	Method and Description
WakeLockMetrics	diff(WakeLockMetrics b, WakeLockMetrics output) Subtract the object passed in from the current object.
boolean	equals(java.lang.Object o)
int	hashCode()
WakeLockMetrics	set(WakeLockMetrics b) Sets all fields in this to values from the SystemMetrics object passed in: a _deep_ copy that shouldn't share any values with other metrics objects.
WakeLockMetrics	sum(WakeLockMetrics b, WakeLockMetrics output) Add values from the SystemMetrics object passed in and sets them on the output object, if available.
java.lang.String	toString()

Methods inherited from class com.facebook.battery.metrics.core.SystemMetrics

diff, sum

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

tagTimeMs

public final <any> tagTimeMs

isAttributionEnabled

public boolean isAttributionEnabled

heldTimeMs

public long heldTimeMs

Constructor Detail

WakeLockMetrics

public WakeLockMetrics()

Create a WakeLockMetrics object without attribution enabled.

WakeLockMetrics

public WakeLockMetrics(boolean isAttributionEnabled)

Create a WakeLockMetrics object and enable attribution based on the argument.

Method Detail

sum

public WakeLockMetrics sum(WakeLockMetrics b,
                           WakeLockMetrics output)

Description copied from class: SystemMetrics

Add values from the SystemMetrics object passed in and sets them on the output object, if available. Does not modify the original object.

For convenience, this function accepts null values and will allocate an output object if none is passed in.

Specified by:

sum in class SystemMetrics<WakeLockMetrics>

Returns:

output set to (this + b)

diff

public WakeLockMetrics diff(WakeLockMetrics b,
                            WakeLockMetrics output)

Description copied from class: SystemMetrics

Subtract the object passed in from the current object. Does not modify the original object.

For convenience, this function accepts null values and will allocate an output object if none is passed in.

Specified by:

diff in class SystemMetrics<WakeLockMetrics>

Returns:

output set to (this - b)

set

public WakeLockMetrics set(WakeLockMetrics b)

Description copied from class: SystemMetrics

Sets all fields in this to values from the SystemMetrics object passed in: a _deep_ copy that shouldn't share any values with other metrics objects.

Specified by:

set in class SystemMetrics<WakeLockMetrics>

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object