ComponentTree.Builder

java.lang.Object
- com.facebook.litho.ComponentTree.Builder

Enclosing class:

ComponentTree
```
public static class ComponentTree.Builder
extends Object
```
A builder class that can be used to create a ComponentTree.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder(ComponentContext context)

Constructors
Modifier	Constructor and Description
`protected`	`Builder(ComponentContext context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ComponentTree.Builder`	`asyncStateUpdates(boolean enabled)` Specify whether the ComponentTree allows async state updates.
`ComponentTree`	`build()` Builds a `ComponentTree` using the parameters specified in this builder.
`ComponentTree.Builder`	`canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)` Experimental, do not use! If enabled, a layout computation can be interrupted on a bg thread and resumed on the UI thread if it's needed immediately.
`ComponentTree.Builder`	`hasMounted(boolean hasMounted)` Sets whether the 'hasMounted' flag should be set on this ComponentTree (for use with appear animations).
`ComponentTree.Builder`	`hooksHandler(HooksHandler hooksHandler)`
`ComponentTree.Builder`	`incrementalMount(boolean isEnabled)` Whether or not to enable the incremental mount optimization.
`ComponentTree.Builder`	`incrementalVisibility(boolean isEnabled)`
`ComponentTree.Builder`	`isFirstMount(boolean isFirstMount)`
`ComponentTree.Builder`	`isReconciliationEnabled(boolean isEnabled)` Sets if reconciliation is enabled
`ComponentTree.Builder`	`layoutDiffing(boolean enabled)` Deprecated.
`ComponentTree.Builder`	`layoutThreadHandler(LithoHandler handler)` Specify the looper to use for running layouts on.
`ComponentTree.Builder`	`layoutThreadLooper(Looper looper)` Specify the looper to use for running layouts on.
`ComponentTree.Builder`	`logger(ComponentsLogger logger, String logTag)`
`ComponentTree.Builder`	`measureListener(ComponentTree.MeasureListener measureListener)`
`ComponentTree.Builder`	`overrideComponentTreeId(int overrideComponentTreeId)` Gives the ability to override the auto-generated ComponentTree id: this is generally not useful in the majority of circumstances, so don't use it unless you really know what you're doing.
`ComponentTree.Builder`	`preAllocateMountContentHandler(LithoHandler handler)` Specify the handler for to preAllocateMountContent
`ComponentTree.Builder`	`preallocateOnDefaultHandler(boolean preallocateOnDefaultHandler)` If true, mount content preallocation will use a default layout handler to preallocate mount content on a background thread if no other layout handler is provided through `preAllocateMountContentHandler(LithoHandler)`.
`ComponentTree.Builder`	`previousRenderState(RenderState previousRenderState)` Specify an existing previous render state that the ComponentTree can use to set the current values for providing previous versions of @Prop/@State variables.
`ComponentTree.Builder`	`recyclingMode(int recyclingMode)` Experimental, do not use!! If used recycling for components may not happen.
`ComponentTree.Builder`	`shouldPreallocateMountContentPerMountSpec(boolean preallocatePerMountSpec)` If true, this ComponentTree will only preallocate mount specs that are enabled for preallocation with `MountSpec#canPreallocate()`.
`ComponentTree.Builder`	`stateHandler(StateHandler stateHandler)` Specify an initial state handler object that the ComponentTree can use to set the current values for states.
`ComponentTree.Builder`	`useCancelableLayoutFutures(boolean isEnabled)` Experimental, do not use! If enabled, cancel a layout calculation before it finishes if there's another layout pending with a newer state of the ComponentTree.
`ComponentTree.Builder`	`visibilityProcessing(boolean isEnabled)`
`ComponentTree.Builder`	`withRoot(Component root)` Specify root for the component tree

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder(ComponentContext context)
```
- Method Detail
  - withRoot
```
public ComponentTree.Builder withRoot(Component root)
```
    Specify root for the component tree
    IMPORTANT: If you do not set this, a default root will be set and you can reset root after build and attach of the component tree
  - incrementalMount
```
public ComponentTree.Builder incrementalMount(boolean isEnabled)
```
    Whether or not to enable the incremental mount optimization. True by default.
    IMPORTANT: if you set this to false, visibility events will NOT FIRE. Please don't use this unless you really need to.
  - visibilityProcessing
```
public ComponentTree.Builder visibilityProcessing(boolean isEnabled)
```
  - layoutDiffing
```
@Deprecated
public ComponentTree.Builder layoutDiffing(boolean enabled)
```
    Deprecated.
    
    Whether or not to enable layout tree diffing. This will reduce the cost of updates at the expense of using extra memory. True by default.
    We will remove this option soon, please consider turning it on (which is on by default)
  - layoutThreadLooper
```
public ComponentTree.Builder layoutThreadLooper(Looper looper)
```
    Specify the looper to use for running layouts on. Note that in rare cases layout must run on the UI thread. For example, if you rotate the screen, we must measure on the UI thread. If you don't specify a Looper here, the Components default Looper will be used.
  - preAllocateMountContentHandler
```
public ComponentTree.Builder preAllocateMountContentHandler(LithoHandler handler)
```
    Specify the handler for to preAllocateMountContent
  - shouldPreallocateMountContentPerMountSpec
```
public ComponentTree.Builder shouldPreallocateMountContentPerMountSpec(boolean preallocatePerMountSpec)
```
    If true, this ComponentTree will only preallocate mount specs that are enabled for preallocation with MountSpec#canPreallocate(). If false, it preallocates all mount content.
  - preallocateOnDefaultHandler
```
public ComponentTree.Builder preallocateOnDefaultHandler(boolean preallocateOnDefaultHandler)
```
    If true, mount content preallocation will use a default layout handler to preallocate mount content on a background thread if no other layout handler is provided through preAllocateMountContentHandler(LithoHandler).
  - layoutThreadHandler
```
public ComponentTree.Builder layoutThreadHandler(LithoHandler handler)
```
    Specify the looper to use for running layouts on. Note that in rare cases layout must run on the UI thread. For example, if you rotate the screen, we must measure on the UI thread. If you don't specify a Looper here, the Components default Looper will be used.
  - stateHandler
```
public ComponentTree.Builder stateHandler(StateHandler stateHandler)
```
    Specify an initial state handler object that the ComponentTree can use to set the current values for states.
  - hooksHandler
```
public ComponentTree.Builder hooksHandler(HooksHandler hooksHandler)
```
  - previousRenderState
```
public ComponentTree.Builder previousRenderState(RenderState previousRenderState)
```
    Specify an existing previous render state that the ComponentTree can use to set the current values for providing previous versions of @Prop/@State variables.
  - asyncStateUpdates
```
public ComponentTree.Builder asyncStateUpdates(boolean enabled)
```
    Specify whether the ComponentTree allows async state updates. This is enabled by default.
  - overrideComponentTreeId
```
public ComponentTree.Builder overrideComponentTreeId(int overrideComponentTreeId)
```
    Gives the ability to override the auto-generated ComponentTree id: this is generally not useful in the majority of circumstances, so don't use it unless you really know what you're doing.
  - hasMounted
```
public ComponentTree.Builder hasMounted(boolean hasMounted)
```
    Sets whether the 'hasMounted' flag should be set on this ComponentTree (for use with appear animations).
  - isFirstMount
```
public ComponentTree.Builder isFirstMount(boolean isFirstMount)
```
  - measureListener
```
public ComponentTree.Builder measureListener(ComponentTree.MeasureListener measureListener)
```
  - isReconciliationEnabled
```
public ComponentTree.Builder isReconciliationEnabled(boolean isEnabled)
```
    Sets if reconciliation is enabled
  - recyclingMode
```
public ComponentTree.Builder recyclingMode(int recyclingMode)
```
    Experimental, do not use!! If used recycling for components may not happen.
  - useCancelableLayoutFutures
```
public ComponentTree.Builder useCancelableLayoutFutures(boolean isEnabled)
```
    Experimental, do not use! If enabled, cancel a layout calculation before it finishes if there's another layout pending with a newer state of the ComponentTree.
  - incrementalVisibility
```
public ComponentTree.Builder incrementalVisibility(boolean isEnabled)
```
  - canInterruptAndMoveLayoutsBetweenThreads
```
public ComponentTree.Builder canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)
```
    Experimental, do not use! If enabled, a layout computation can be interrupted on a bg thread and resumed on the UI thread if it's needed immediately.
  - logger
```
public ComponentTree.Builder logger(ComponentsLogger logger,
                                    String logTag)
```
  - build
```
public ComponentTree build()
```
    Builds a ComponentTree using the parameters specified in this builder.

Class ComponentTree.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

withRoot

incrementalMount

visibilityProcessing

layoutDiffing

layoutThreadLooper

preAllocateMountContentHandler

shouldPreallocateMountContentPerMountSpec

preallocateOnDefaultHandler

layoutThreadHandler

stateHandler

hooksHandler

previousRenderState

asyncStateUpdates

overrideComponentTreeId

hasMounted

isFirstMount

measureListener

isReconciliationEnabled

recyclingMode

useCancelableLayoutFutures

incrementalVisibility

canInterruptAndMoveLayoutsBetweenThreads

logger

build