com.facebook.litho

Class DebugComponentTimeMachine

java.lang.Object

com.facebook.litho.DebugComponentTimeMachine

public final class DebugComponentTimeMachine
extends java.lang.Object

This class provides the means to save and restore ComponentTrees for time-traveling debugging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DebugComponentTimeMachine.TreeRevision
static class	DebugComponentTimeMachine.TreeRevisions

Method Summary

Modifier and Type	Method and Description
static DebugComponentTimeMachine.TreeRevisions	getTimeline(DebugComponent component) Finds the timeline corresponding to a component
static boolean	loadTimelineSnapshot(DebugComponent node, java.lang.String destination) Applies a StateHandler to a Component node from the cache
static boolean	maybeSkipNextSnapshot(DebugComponent node) Prevents the next call to saveTimelineSnapshot for this DebugComponent
static boolean	saveTimelineSnapshot(ComponentTree componentTree, Component root, TreeState treeState, TreeProps props, int source, java.lang.String attribution) Caches a StateHandler and Component root alongside metadata for them
static void	skipNextSnapshot(ComponentTree tree) Prevents the next call to saveTimelineSnapshot for this ComponentTree

Methods inherited from class java.lang.Object

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

Method Detail

getTimeline

public static DebugComponentTimeMachine.TreeRevisions getTimeline(DebugComponent component)

Finds the timeline corresponding to a component

Parameters:

component - the component the timeline is for

Returns:

the timeline or null

saveTimelineSnapshot

public static boolean saveTimelineSnapshot(ComponentTree componentTree,
                                           Component root,
                                           TreeState treeState,
                                           TreeProps props,
                                           int source,
                                           java.lang.String attribution)

Caches a StateHandler and Component root alongside metadata for them

Parameters:

componentTree - the ComponentTree we want to save the snapshot for

root - the component to save the timeline for

stateHandler - the state handler for the context in the root

props - the props of the component root

source - the cause of the redraw that will be saved

attribution - the context of the cause of the redraw

Returns:

whether a snapshot was saved

loadTimelineSnapshot

public static boolean loadTimelineSnapshot(DebugComponent node,
                                           java.lang.String destination)

Applies a StateHandler to a Component node from the cache

Parameters:

node - the component the timeline is for

destination - the TreeRevision#key at the timeline we'll be traveling to

Returns:

whether the snapshot was loaded

skipNextSnapshot

public static void skipNextSnapshot(ComponentTree tree)

Prevents the next call to saveTimelineSnapshot for this ComponentTree

Parameters:

tree - the component tree the timeline is for

maybeSkipNextSnapshot

public static boolean maybeSkipNextSnapshot(DebugComponent node)

Prevents the next call to saveTimelineSnapshot for this DebugComponent

Parameters:

node - the component the timeline is for

Returns:

false if the node failed to get its ComponentTree