com.facebook.litho

Class ComponentsSystrace

java.lang.Object

com.facebook.litho.ComponentsSystrace

public class ComponentsSystrace
extends Object

This is intended as a hook into android.os.Trace, but allows you to provide your own functionality. Use it as

ComponentsSystrace.beginSection("tag"); ... ComponentsSystrace.endSection(); As a default, it simply calls android.os.Trace (see DefaultComponentsSystrace). You may supply your own with provide(Systrace).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComponentsSystrace.ArgsBuilder Object that accumulates arguments.
static interface	ComponentsSystrace.Systrace

Field Summary

Fields

Modifier and Type	Field and Description
static ComponentsSystrace.ArgsBuilder	NO_OP_ARGS_BUILDER Convenience implementation of ArgsBuilder to use when we aren't tracing.

Method Summary

Modifier and Type	Method and Description
static void	beginSection(String name) Writes a trace message to indicate that a given section of code has begun.
static void	beginSectionAsync(String name) Writes a trace message to indicate that a given section of code has begun.
static void	beginSectionAsync(String name, int cookie) Writes a trace message to indicate that a given section of code has begun.
static ComponentsSystrace.ArgsBuilder	beginSectionWithArgs(String name)
static void	endSection() Writes a trace message to indicate that a given section of code has ended.
static void	endSectionAsync(String name) Writes a trace message to indicate that the current method has ended.
static void	endSectionAsync(String name, int cookie) Writes a trace message to indicate that the current method has ended.
static ComponentsSystrace.Systrace	getSystrace()
static boolean	isTracing()
static void	provide(ComponentsSystrace.Systrace instance) This should be called exactly once at app startup, before any Litho work happens.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP_ARGS_BUILDER

public static final ComponentsSystrace.ArgsBuilder NO_OP_ARGS_BUILDER

Convenience implementation of ArgsBuilder to use when we aren't tracing.

Method Detail

provide

public static void provide(ComponentsSystrace.Systrace instance)

This should be called exactly once at app startup, before any Litho work happens.

getSystrace

public static ComponentsSystrace.Systrace getSystrace()

beginSection

public static void beginSection(String name)

Writes a trace message to indicate that a given section of code has begun. This call must be followed by a corresponding call to endSection() on the same thread.

beginSectionAsync

public static void beginSectionAsync(String name)

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endSectionAsync(String) using the same tag. Unlike beginSection(String) and endSection(), asynchronous events do not need to be nested. The name and cookie used to begin an event must be used to end it.

Depending on provided ComponentsSystrace.Systrace instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

beginSectionAsync

public static void beginSectionAsync(String name,
                                     int cookie)

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endSectionAsync(String, int) using the same tag. Unlike beginSection(String) and endSection(), asynchronous events do not need to be nested. The name and cookie used to begin an event must be used to end it.

Depending on provided ComponentsSystrace.Systrace instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

beginSectionWithArgs

public static ComponentsSystrace.ArgsBuilder beginSectionWithArgs(String name)

endSection

public static void endSection()

Writes a trace message to indicate that a given section of code has ended. This call must be preceded by a corresponding call to beginSection(String). Calling this method will mark the end of the most recently begun section of code, so care must be taken to ensure that beginSection / endSection pairs are properly nested and called from the same thread.

endSectionAsync

public static void endSectionAsync(String name)

Writes a trace message to indicate that the current method has ended. Must be called exactly once for each call to beginSectionAsync(String) using the same tag, name and cookie.

Depending on provided ComponentsSystrace.Systrace instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

endSectionAsync

public static void endSectionAsync(String name,
                                   int cookie)

Writes a trace message to indicate that the current method has ended. Must be called exactly once for each call to beginSectionAsync(String, int) using the same tag, name and cookie.

Depending on provided ComponentsSystrace.Systrace instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

isTracing

public static boolean isTracing()