com.facebook.litho

Class DebugComponentDescriptionHelper

java.lang.Object

com.facebook.litho.DebugComponentDescriptionHelper

public class DebugComponentDescriptionHelper
extends java.lang.Object

Describes DebugComponents for use in testing and debugging. Note that ComponentsConfiguration.isEndToEndTestRun must be enabled in order for this data to be collected.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DebugComponentDescriptionHelper.ExtraDescription An interface for callsite to append extra description into StringBuilder by given DebugComponent.

Constructor Summary

Constructors

Constructor and Description
DebugComponentDescriptionHelper()

Method Summary

Modifier and Type	Method and Description
static void	addViewDescription(DebugComponent debugComponent, java.lang.StringBuilder sb, int leftOffset, int topOffset, boolean embedded, boolean withProps)
static void	addViewDescription(DebugComponent debugComponent, java.lang.StringBuilder sb, int leftOffset, int topOffset, boolean embedded, boolean withProps, DebugComponentDescriptionHelper.ExtraDescription extraDescription) Appends a compact description of a DebugComponent for debugging purposes.
static JSONObject	getExtraProps(java.lang.Object node)

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugComponentDescriptionHelper

public DebugComponentDescriptionHelper()

Method Detail

addViewDescription

public static void addViewDescription(DebugComponent debugComponent,
                                      java.lang.StringBuilder sb,
                                      int leftOffset,
                                      int topOffset,
                                      boolean embedded,
                                      boolean withProps)

addViewDescription

public static void addViewDescription(DebugComponent debugComponent,
                                      java.lang.StringBuilder sb,
                                      int leftOffset,
                                      int topOffset,
                                      boolean embedded,
                                      boolean withProps,
                                      DebugComponentDescriptionHelper.ExtraDescription extraDescription)

Appends a compact description of a DebugComponent for debugging purposes.

Parameters:

debugComponent - The DebugComponent

sb - The StringBuilder to which the description is appended

leftOffset - Offset of the parent component relative to litho view

topOffset - Offset of the parent component relative to litho view

embedded - Whether the call is embedded in "adb dumpsys activity"

extraDescription - An interface for callsite to append extra description.

getExtraProps

public static JSONObject getExtraProps(java.lang.Object node)