Package org.robolectric.shadows

Class ShadowTrace

java.lang.Object

org.robolectric.shadows.ShadowTrace

@Implements(android.os.Trace.class)
public class ShadowTrace
extends Object

Shadow implementation for Trace, which stores the traces locally in arrays (unlike the real implementation) and allows reading them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowTrace.AsyncTraceSection	AutoValue representation of a trace triggered by one of the async apis
static class	ShadowTrace.Counter	Counters emitted with the setCounter API

Constructor Summary

Constructors

Constructor	Description
ShadowTrace()

Method Summary

Modifier and Type	Method	Description
protected static void	beginAsyncSection(String sectionName, int cookie)	Starts a new async trace section with given name.
protected static void	beginSection(String sectionName)	Starts a new trace section with given name.
static void	doNotUseSetCrashOnIncorrectUsage(boolean crashOnIncorrectUsage)	Do not use this method unless absolutely necessary.
protected static void	endAsyncSection(String sectionName, int cookie)	Ends async trace trace section.
protected static void	endSection()	Ends the most recent active trace section.
static com.google.common.collect.ImmutableList<ShadowTrace.Counter>	getCounters()	Returns an ordered list of previous counters.
static com.google.common.collect.ImmutableSet<ShadowTrace.AsyncTraceSection>	getCurrentAsyncSections()	Returns a set of all the current active async trace sections.
static Deque<String>	getCurrentSections()	Returns a stack of the currently active trace sections for the current thread.
static com.google.common.collect.ImmutableSet<ShadowTrace.AsyncTraceSection>	getPreviousAsyncSections()	Returns a set of all the previously active async trace sections.
static Queue<String>	getPreviousSections()	Returns a queue of all the previously active trace sections for the current thread.
protected static boolean	isEnabled()	Returns whether systrace is enabled.
protected static long	nativeGetEnabledTags()
static void	reset()	Resets internal lists of active trace sections.
protected static void	setAppTracingAllowed(boolean appTracingAllowed)
protected static void	setCounter(String counterName, long counterValue)
static void	setEnabled(boolean enabled)	Sets the systrace to enabled or disabled.

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowTrace

public ShadowTrace()

Method Details

beginSection

@Implementation(minSdk=18) protected static void beginSection(String sectionName)

Starts a new trace section with given name.

endSection

@Implementation(minSdk=18) protected static void endSection()

Ends the most recent active trace section.

beginAsyncSection

@Implementation(minSdk=29) protected static void beginAsyncSection(String sectionName, int cookie)

Starts a new async trace section with given name.

endAsyncSection

@Implementation(minSdk=29) protected static void endAsyncSection(String sectionName, int cookie)

Ends async trace trace section.

nativeGetEnabledTags

@Implementation(minSdk=18) protected static long nativeGetEnabledTags()

setAppTracingAllowed

@Implementation(minSdk=18) protected static void setAppTracingAllowed(boolean appTracingAllowed)

isEnabled

@Implementation(minSdk=29) protected static boolean isEnabled()

Returns whether systrace is enabled.

setCounter

@Implementation(minSdk=29) protected static void setCounter(String counterName, long counterValue)

setEnabled

public static void setEnabled(boolean enabled)

Sets the systrace to enabled or disabled.

getCurrentSections

public static Deque<String> getCurrentSections()

Returns a stack of the currently active trace sections for the current thread.

getPreviousSections

public static Queue<String> getPreviousSections()

Returns a queue of all the previously active trace sections for the current thread.

getCurrentAsyncSections

public static com.google.common.collect.ImmutableSet<ShadowTrace.AsyncTraceSection> getCurrentAsyncSections()

Returns a set of all the current active async trace sections.

getPreviousAsyncSections

public static com.google.common.collect.ImmutableSet<ShadowTrace.AsyncTraceSection> getPreviousAsyncSections()

Returns a set of all the previously active async trace sections.

getCounters

public static com.google.common.collect.ImmutableList<ShadowTrace.Counter> getCounters()

Returns an ordered list of previous counters.

doNotUseSetCrashOnIncorrectUsage

public static void doNotUseSetCrashOnIncorrectUsage(boolean crashOnIncorrectUsage)

Do not use this method unless absolutely necessary. Prefer fixing the tests instead.

Sets whether to crash on incorrect usage (e.g., calling endSection() before beginSection(java.lang.String). Default value - true.

reset

@Resetter public static void reset()

Resets internal lists of active trace sections.