com.facebook.litho.sections

Class SectionTree.Builder

java.lang.Object

com.facebook.litho.sections.SectionTree.Builder

Enclosing class:

SectionTree

public static class SectionTree.Builder
extends java.lang.Object

A builder class that can be used to create a SectionTree.

Method Summary

Modifier and Type	Method and Description
SectionTree.Builder	asyncPropUpdates(boolean asyncPropUpdates) If enabled, any prop updates done with setRoot will be on a background thread.
SectionTree.Builder	asyncStateUpdates(boolean asyncStateUpdates) If enabled, all state updates will be performed on a background thread.
SectionTree	build()
SectionTree.Builder	changeSetThreadHandler(RunnableHandler changeSetThreadHandler) An optional Handler where ChangeSet calculation should happen.
SectionTree.Builder	forceSyncStateUpdates(boolean forceSyncStateUpdates) If enabled, all state updates will be performed on the main thread.
SectionTree.Builder	postToFrontOfQueueForFirstChangeset(boolean postToFrontOfQueueForFirstChangeset)
SectionTree.Builder	tag(java.lang.String tag) If enabled, a tag will define the section tree being built

Methods inherited from class java.lang.Object

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

Method Detail

changeSetThreadHandler

public SectionTree.Builder changeSetThreadHandler(RunnableHandler changeSetThreadHandler)

An optional Handler where ChangeSet calculation should happen. If not provided the framework will use its default background thread.

asyncStateUpdates

public SectionTree.Builder asyncStateUpdates(boolean asyncStateUpdates)

If enabled, all state updates will be performed on a background thread.

forceSyncStateUpdates

public SectionTree.Builder forceSyncStateUpdates(boolean forceSyncStateUpdates)

If enabled, all state updates will be performed on the main thread. This may be necessary to use if your data model is not thread safe (e.g. model objects can be mutated from another thread), meaning changesets on the datamodel list cannot be computed in the background.

NB: This may come at significant performance cost.

asyncPropUpdates

public SectionTree.Builder asyncPropUpdates(boolean asyncPropUpdates)

If enabled, any prop updates done with setRoot will be on a background thread. This excludes the very first setRoot where there isn't an existing section. That one will still be on the main thread.

tag

public SectionTree.Builder tag(java.lang.String tag)

If enabled, a tag will define the section tree being built

Parameters:

tag - tag that labels the section tree

Returns:

postToFrontOfQueueForFirstChangeset

public SectionTree.Builder postToFrontOfQueueForFirstChangeset(boolean postToFrontOfQueueForFirstChangeset)

build

public SectionTree build()

Returns:

the SectionTree.