com.facebook.litho

Class LogTreePopulator

java.lang.Object

com.facebook.litho.LogTreePopulator

public final class LogTreePopulator
extends java.lang.Object

This class provides utilities for extracting information through ComponentsLogger.getExtraAnnotations(TreeProps) and transforming them so they can be logged.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAnnotationBundleFromLogger(ComponentContext scopedContext, ComponentsLogger logger) Extract treeprops from a scoped ComponentContext and turn them into a single colon-separated string.
static PerfEvent	populatePerfEventFromLogger(ComponentContext c, ComponentsLogger logger, PerfEvent perfEvent) Annotate a log event with the log tag set in the context, and extract the TreeProps from a given ComponentContext and convert them into perf event annotations using a ComponentsLogger implementation.
static PerfEvent	populatePerfEventFromLogger(ComponentContext c, ComponentsLogger logger, java.lang.String logTag, PerfEvent perfEvent) Annotate a log event with the log tag set in the context, and extract the TreeProps from a given ComponentContext and convert them into perf event annotations using a ComponentsLogger implementation.

Methods inherited from class java.lang.Object

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

Method Detail

populatePerfEventFromLogger

public static PerfEvent populatePerfEventFromLogger(ComponentContext c,
                                                    ComponentsLogger logger,
                                                    PerfEvent perfEvent)

Annotate a log event with the log tag set in the context, and extract the TreeProps from a given ComponentContext and convert them into perf event annotations using a ComponentsLogger implementation.

Returns:

Annotated perf event, or null if the resulting event isn't deemed worthy of reporting.

populatePerfEventFromLogger

public static PerfEvent populatePerfEventFromLogger(ComponentContext c,
                                                    ComponentsLogger logger,
                                                    java.lang.String logTag,
                                                    PerfEvent perfEvent)

Annotate a log event with the log tag set in the context, and extract the TreeProps from a given ComponentContext and convert them into perf event annotations using a ComponentsLogger implementation.

Returns:

Annotated perf event, or null if the resulting event isn't deemed worthy of reporting.

getAnnotationBundleFromLogger

public static java.lang.String getAnnotationBundleFromLogger(ComponentContext scopedContext,
                                                             ComponentsLogger logger)

Extract treeprops from a scoped ComponentContext and turn them into a single colon-separated string.

Parameters:

scopedContext - ComponentContext to extract tree props from.

logger - ComponentsLogger to convert treeprops into perf event annotations.

Returns:

String of extracted props with key-value pairs separated by ':'.

See Also:

populatePerfEventFromLogger(ComponentContext, ComponentsLogger, PerfEvent)