ComponentsConfiguration

java.lang.Object
- com.facebook.litho.config.ComponentsConfiguration

```
public class ComponentsConfiguration
extends java.lang.Object
```
Hi there, traveller! This configuration class is not meant to be used by end-users of Litho. It contains mainly flags for features that are either under active development and not ready for public consumption, or for use in experiments.
These values are safe defaults and should not require manual changes.
This class hosts all the config parameters that the ComponentTree configures it self .... enable and disable features ... A Component tree uses the defaultComponentsConfiguration by default but a ComponentsConfiguration.Builder can be used to create new instances of the config to override the default parameters ... The default config values can also be overridden by manually setting their values in defaultBuilder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ComponentsConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentsConfiguration.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`boostPerfLayoutStateFuture` If true, the `perfBoosterFactory` will be used to indicate that LayoutStateFuture thread can use the perf boost
`static boolean`	`CAN_CHECK_GLOBAL_ANIMATOR_SETTINGS` Whether we can access properties in Settings.Global for animations.
`static boolean`	`canInterruptAndMoveLayoutsBetweenThreads`
`static java.util.Set<java.lang.String>`	`componentPreallocationBlocklist`
`static boolean`	`computeRangeOnSyncLayout` Start parallel layout of visible range just before serial synchronous layouts in RecyclerBinder
`static boolean`	`crashIfExceedingStateUpdateThreshold`
`static int`	`DEFAULT_BACKGROUND_THREAD_PRIORITY` The default priority for threads that perform background layout calculations.
`static int`	`DEFAULT_CHANGE_SET_THREAD_PRIORITY` The default priority for threads that perform background sections change set calculations.
`static boolean`	`disableGetAnnotationUsage` field.getAnnotation() has bugs which is causing java crashes in the App, in addition to this we suspect this might be a reason for few other native crashes as well.
`static boolean`	`emitMessageForZeroSizedTexture`
`static boolean`	`enableErrorBoundaryComponent`
`static boolean`	`enableMountableComponents`
`static boolean`	`enableMountableInMessenger`
`static boolean`	`enableMountableInNewsFeed`
`static boolean`	`enableMountableRecycler`
`static boolean`	`enableMountableRecyclerInGroups`
`static boolean`	`enableMountableTwoBindersRecycler`
`static boolean`	`enableNestedTreePreallocation` If true, uses the root ComponentTree's mount content preallocation handler to perform preallocation for nested trees.
`static boolean`	`enableRecyclerBinderStableId`
`static boolean`	`enableSeparateAnimatorBinder`
`static boolean`	`enableStateUpdatesBatching`
`static boolean`	`enableThreadTracingStacktrace`
`static boolean`	`enableTransitionsExtension`
`static boolean`	`enableVisibilityExtension`
`static boolean`	`fixMemoryLeakInRecyclerBinder`
`static boolean`	`forceEnableTransitionsForInstrumentationTests` By default end-to-end tests will disable transitions and this flag lets to explicitly enable transitions to test animation related behavior.
`static boolean`	`furyEventCallbackInstrumentation` This toggles whether fury should instrument the Litho event callback event
`static int`	`hostComponentPoolSize`
`static boolean`	`hostComponentRecyclingByMountStateIsEnabled`
`static boolean`	`hostComponentRecyclingByWindowIsEnabled` These params are part of an experiment to try to re-enable host recycling while avoiding native RenderThread crashes we've seen when trying to reuse ComponentHosts.
`static boolean`	`initStickyHeaderInLayoutWhenComponentTreeIsNull` Initialize sticky header during layout when its component tree is null
`static boolean`	`IS_INTERNAL_BUILD` Indicates whether this is an internal build.
`static boolean`	`isAnimationDisabled`
`static boolean`	`isBuildAndLayoutSplitEnabled`
`static boolean`	`isDebugHierarchyEnabled` Lightweight tracking of component class hierarchy of MountItems.
`static boolean`	`isDebugModeEnabled` Option to enabled debug mode.
`static boolean`	`isEndToEndTestRun` Populates additional metadata to find mounted components at runtime.
`static boolean`	`isIncrementalMountGloballyDisabled` When `true`, disables incremental mount globally.
`static boolean`	`isLayoutDiffingEnabled` Sets if layout diffing is enabled.
`static boolean`	`isReconciliationEnabled` Sets if is reconciliation is enabled
`static boolean`	`isSplitStateHandlersEnabled`
`static boolean`	`isTimelineEnabled` When `true` ComponentTree records state change snapshots
`static boolean`	`keepLithoNodes` Keeps the litho node tree in the LayoutState.
`static long`	`layoutThreadKeepAliveTimeMs`
`static boolean`	`lithoViewSelfManageViewPortChanges` Used by LithoViews to determine whether or not to self-manage the view-port changes, rather than rely on calls to notifyVisibleBoundsChanged.
`static boolean`	`NEEDS_THEME_SYNCHRONIZATION` Whether we need to account for lack of synchronization while accessing Themes.
`static int`	`overlappingRenderingViewSizeLimit`
`static java.lang.Boolean`	`overrideLayoutDiffing`
`static java.lang.Boolean`	`overrideReconciliation`
`static int`	`partialAlphaWarningSizeThresold`
`static LithoPerfBoosterFactory`	`perfBoosterFactory`
`static boolean`	`requestMountForPrefetchedItems`
`static boolean`	`reuseLastMeasuredNodeInComponentMeasure`
`static boolean`	`shouldAddHostViewForRootComponent`
`static boolean`	`shouldAllowCoreThreadTimeout` This toggles whether should timeout core threads or not
`static boolean`	`shouldCompareCommonPropsInIsEquivalentTo`
`static boolean`	`shouldCompareRootCommonPropsInSingleComponentSection`
`static boolean`	`shouldContinueIncrementalMountWhenVisibileRectIsEmpty` When true, IM will not stop when the LithoView's visible rect is empty, and will proceed to unmount everything.
`static boolean`	`shouldDelegateContentDescriptionChangeEvent`
`static boolean`	`shouldDisableBgFgOutputs`
`static boolean`	`shouldUsePositionInParentForMounting` This toggles whether Litho's MountState uses the position of the item in the host view to mount/unmount or uses the position in the LayoutState.
`static int`	`textureSizeWarningLimit`
`static LayoutThreadPoolConfiguration`	`threadPoolConfiguration` If non-null, a thread pool will be used for async layouts instead of a single layout thread.
`static java.lang.String`	`timelineDocsLink`
`static boolean`	`unsafeHostComponentRecyclingIsEnabled`
`static boolean`	`USE_INCREMENTAL_MOUNT_HELPER` Indicates that the incremental mount helper is required for this build.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ComponentsConfiguration.Builder`	`create()`
`static ComponentsConfiguration.Builder`	`create(ComponentsConfiguration componentsConfiguration)`
`static ComponentsConfiguration`	`getDefaultComponentsConfiguration()`
`static ComponentsConfiguration.Builder`	`getDefaultComponentsConfigurationBuilder()`
`boolean`	`getIgnoreNullLayoutStateError()` Deprecated.
`boolean`	`getUseCancelableLayoutFutures()`
`static boolean`	`isNonMainThreadFocusRequestThrowingEnabled()`
`static boolean`	`isRenderInfoDebuggingEnabled()`
`boolean`	`keepLithoNodeAndLayoutResultTreeWithReconciliation()`
`static boolean`	`reduceMemorySpikeDataDiffSection()`
`static boolean`	`reduceMemorySpikeGetUri()`
`static boolean`	`reduceMemorySpikeUserSession()`
`static void`	`setDefaultComponentsConfigurationBuilder(ComponentsConfiguration.Builder componentsConfigurationBuilder)`
`static void`	`setIsNonMainThreadFocusRequestThrowingEnabled(boolean enabled)`
`static void`	`setReduceMemorySpikeDataDiffSection()`
`static void`	`setReduceMemorySpikeGetUri()`
`static void`	`setReduceMemorySpikeUserSession()`
`boolean`	`shouldReuseOutputs()`

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

- Field Detail
  - IS_INTERNAL_BUILD
```
public static final boolean IS_INTERNAL_BUILD
```
    Indicates whether this is an internal build. Note that the implementation of BuildConfig that this class is compiled against may not be the one that is included in the APK. See: android_build_config.
  - USE_INCREMENTAL_MOUNT_HELPER
```
public static final boolean USE_INCREMENTAL_MOUNT_HELPER
```
    Indicates that the incremental mount helper is required for this build.
  - CAN_CHECK_GLOBAL_ANIMATOR_SETTINGS
```
public static final boolean CAN_CHECK_GLOBAL_ANIMATOR_SETTINGS
```
    Whether we can access properties in Settings.Global for animations.
  - NEEDS_THEME_SYNCHRONIZATION
```
public static final boolean NEEDS_THEME_SYNCHRONIZATION
```
    Whether we need to account for lack of synchronization while accessing Themes.
  - DEFAULT_BACKGROUND_THREAD_PRIORITY
```
public static int DEFAULT_BACKGROUND_THREAD_PRIORITY
```
    The default priority for threads that perform background layout calculations.
  - DEFAULT_CHANGE_SET_THREAD_PRIORITY
```
public static final int DEFAULT_CHANGE_SET_THREAD_PRIORITY
```
    The default priority for threads that perform background sections change set calculations.
    
    See Also:
    
    Constant Field Values
  - isDebugModeEnabled
```
public static boolean isDebugModeEnabled
```
    Option to enabled debug mode. This will save extra data asscociated with each node and allow more info about the hierarchy to be retrieved. Used to enable stetho integration. It is highly discouraged to enable this in production builds. Due to how the Litho releases are distributed in open source IS_INTERNAL_BUILD will always be false. It is therefore required to override this value using your own application build configs. Recommended place for this is in a Application subclass onCreate() method.
  - isDebugHierarchyEnabled
```
public static boolean isDebugHierarchyEnabled
```
    Lightweight tracking of component class hierarchy of MountItems.
  - isEndToEndTestRun
```
public static boolean isEndToEndTestRun
```
    Populates additional metadata to find mounted components at runtime. Defaults to the presence of an
```
IS_TESTING
```
    system property at startup but can be overridden at runtime.
  - isAnimationDisabled
```
public static boolean isAnimationDisabled
```
  - forceEnableTransitionsForInstrumentationTests
```
public static boolean forceEnableTransitionsForInstrumentationTests
```
    By default end-to-end tests will disable transitions and this flag lets to explicitly enable transitions to test animation related behavior.
  - enableErrorBoundaryComponent
```
public static boolean enableErrorBoundaryComponent
```
  - threadPoolConfiguration
```
public static LayoutThreadPoolConfiguration threadPoolConfiguration
```
    If non-null, a thread pool will be used for async layouts instead of a single layout thread.
  - enableThreadTracingStacktrace
```
public static boolean enableThreadTracingStacktrace
```
  - isReconciliationEnabled
```
public static boolean isReconciliationEnabled
```
    Sets if is reconciliation is enabled
  - overrideReconciliation
```
public static java.lang.Boolean overrideReconciliation
```
  - overrideLayoutDiffing
```
public static java.lang.Boolean overrideLayoutDiffing
```
  - isLayoutDiffingEnabled
```
public static boolean isLayoutDiffingEnabled
```
    Sets if layout diffing is enabled. This should be used in conjugation with .
  - canInterruptAndMoveLayoutsBetweenThreads
```
public static boolean canInterruptAndMoveLayoutsBetweenThreads
```
  - disableGetAnnotationUsage
```
public static boolean disableGetAnnotationUsage
```
    field.getAnnotation() has bugs which is causing java crashes in the App, in addition to this we suspect this might be a reason for few other native crashes as well. Adding this flag to verify if this is the root cause.
  - perfBoosterFactory
```
public static LithoPerfBoosterFactory perfBoosterFactory
```
  - boostPerfLayoutStateFuture
```
public static boolean boostPerfLayoutStateFuture
```
    If true, the perfBoosterFactory will be used to indicate that LayoutStateFuture thread can use the perf boost
  - computeRangeOnSyncLayout
```
public static boolean computeRangeOnSyncLayout
```
    Start parallel layout of visible range just before serial synchronous layouts in RecyclerBinder
  - shouldDisableBgFgOutputs
```
public static boolean shouldDisableBgFgOutputs
```
  - shouldAddHostViewForRootComponent
```
public static boolean shouldAddHostViewForRootComponent
```
  - shouldContinueIncrementalMountWhenVisibileRectIsEmpty
```
public static boolean shouldContinueIncrementalMountWhenVisibileRectIsEmpty
```
    When true, IM will not stop when the LithoView's visible rect is empty, and will proceed to unmount everything.
  - isIncrementalMountGloballyDisabled
```
public static boolean isIncrementalMountGloballyDisabled
```
    When true, disables incremental mount globally.
  - keepLithoNodes
```
public static boolean keepLithoNodes
```
    Keeps the litho node tree in the LayoutState. This will increase memory use.
  - lithoViewSelfManageViewPortChanges
```
public static boolean lithoViewSelfManageViewPortChanges
```
    Used by LithoViews to determine whether or not to self-manage the view-port changes, rather than rely on calls to notifyVisibleBoundsChanged.
  - emitMessageForZeroSizedTexture
```
public static boolean emitMessageForZeroSizedTexture
```
  - textureSizeWarningLimit
```
public static int textureSizeWarningLimit
```
  - overlappingRenderingViewSizeLimit
```
public static int overlappingRenderingViewSizeLimit
```
  - partialAlphaWarningSizeThresold
```
public static int partialAlphaWarningSizeThresold
```
  - componentPreallocationBlocklist
```
public static java.util.Set<java.lang.String> componentPreallocationBlocklist
```
  - isTimelineEnabled
```
public static boolean isTimelineEnabled
```
    When true ComponentTree records state change snapshots
  - timelineDocsLink
```
public static java.lang.String timelineDocsLink
```
  - initStickyHeaderInLayoutWhenComponentTreeIsNull
```
public static boolean initStickyHeaderInLayoutWhenComponentTreeIsNull
```
    Initialize sticky header during layout when its component tree is null
  - enableNestedTreePreallocation
```
public static boolean enableNestedTreePreallocation
```
    If true, uses the root ComponentTree's mount content preallocation handler to perform preallocation for nested trees.
  - enableVisibilityExtension
```
public static boolean enableVisibilityExtension
```
  - enableTransitionsExtension
```
public static boolean enableTransitionsExtension
```
  - hostComponentRecyclingByWindowIsEnabled
```
public static boolean hostComponentRecyclingByWindowIsEnabled
```
    These params are part of an experiment to try to re-enable host recycling while avoiding native RenderThread crashes we've seen when trying to reuse ComponentHosts.
  - hostComponentRecyclingByMountStateIsEnabled
```
public static boolean hostComponentRecyclingByMountStateIsEnabled
```
  - unsafeHostComponentRecyclingIsEnabled
```
public static boolean unsafeHostComponentRecyclingIsEnabled
```
  - hostComponentPoolSize
```
public static int hostComponentPoolSize
```
  - furyEventCallbackInstrumentation
```
public static boolean furyEventCallbackInstrumentation
```
    This toggles whether fury should instrument the Litho event callback event
  - shouldUsePositionInParentForMounting
```
public static boolean shouldUsePositionInParentForMounting
```
    This toggles whether Litho's MountState uses the position of the item in the host view to mount/unmount or uses the position in the LayoutState. The default is to use the position in the LayoutState.
  - isBuildAndLayoutSplitEnabled
```
public static boolean isBuildAndLayoutSplitEnabled
```
  - isSplitStateHandlersEnabled
```
public static boolean isSplitStateHandlersEnabled
```
  - reuseLastMeasuredNodeInComponentMeasure
```
public static boolean reuseLastMeasuredNodeInComponentMeasure
```
  - shouldCompareCommonPropsInIsEquivalentTo
```
public static boolean shouldCompareCommonPropsInIsEquivalentTo
```
  - shouldCompareRootCommonPropsInSingleComponentSection
```
public static boolean shouldCompareRootCommonPropsInSingleComponentSection
```
  - shouldDelegateContentDescriptionChangeEvent
```
public static boolean shouldDelegateContentDescriptionChangeEvent
```
  - shouldAllowCoreThreadTimeout
```
public static boolean shouldAllowCoreThreadTimeout
```
    This toggles whether should timeout core threads or not
  - layoutThreadKeepAliveTimeMs
```
public static long layoutThreadKeepAliveTimeMs
```
  - crashIfExceedingStateUpdateThreshold
```
public static boolean crashIfExceedingStateUpdateThreshold
```
  - enableRecyclerBinderStableId
```
public static boolean enableRecyclerBinderStableId
```
  - requestMountForPrefetchedItems
```
public static boolean requestMountForPrefetchedItems
```
  - fixMemoryLeakInRecyclerBinder
```
public static boolean fixMemoryLeakInRecyclerBinder
```
  - enableMountableComponents
```
public static boolean enableMountableComponents
```
  - enableMountableRecycler
```
public static boolean enableMountableRecycler
```
  - enableMountableTwoBindersRecycler
```
public static boolean enableMountableTwoBindersRecycler
```
  - enableMountableInNewsFeed
```
public static boolean enableMountableInNewsFeed
```
  - enableMountableInMessenger
```
public static boolean enableMountableInMessenger
```
  - enableSeparateAnimatorBinder
```
public static boolean enableSeparateAnimatorBinder
```
  - enableMountableRecyclerInGroups
```
public static boolean enableMountableRecyclerInGroups
```
  - enableStateUpdatesBatching
```
public static boolean enableStateUpdatesBatching
```
- Method Detail
  - isRenderInfoDebuggingEnabled
```
public static boolean isRenderInfoDebuggingEnabled()
```
  - setReduceMemorySpikeUserSession
```
public static void setReduceMemorySpikeUserSession()
```
  - reduceMemorySpikeUserSession
```
public static boolean reduceMemorySpikeUserSession()
```
  - setReduceMemorySpikeDataDiffSection
```
public static void setReduceMemorySpikeDataDiffSection()
```
  - reduceMemorySpikeDataDiffSection
```
public static boolean reduceMemorySpikeDataDiffSection()
```
  - setReduceMemorySpikeGetUri
```
public static void setReduceMemorySpikeGetUri()
```
  - reduceMemorySpikeGetUri
```
public static boolean reduceMemorySpikeGetUri()
```
  - setDefaultComponentsConfigurationBuilder
```
public static void setDefaultComponentsConfigurationBuilder(ComponentsConfiguration.Builder componentsConfigurationBuilder)
```
  - getDefaultComponentsConfiguration
```
public static ComponentsConfiguration getDefaultComponentsConfiguration()
```
  - getDefaultComponentsConfigurationBuilder
```
public static ComponentsConfiguration.Builder getDefaultComponentsConfigurationBuilder()
```
  - getUseCancelableLayoutFutures
```
public boolean getUseCancelableLayoutFutures()
```
  - getIgnoreNullLayoutStateError
```
@Deprecated
public boolean getIgnoreNullLayoutStateError()
```
    Deprecated.
    
    Only used for testing. If true, the framework will not throw an error if a null LayoutState is returned from a layout calculation in illegal cases (such as for a sync layout calculation).
  - shouldReuseOutputs
```
public boolean shouldReuseOutputs()
```
  - keepLithoNodeAndLayoutResultTreeWithReconciliation
```
public boolean keepLithoNodeAndLayoutResultTreeWithReconciliation()
```
  - setIsNonMainThreadFocusRequestThrowingEnabled
```
public static void setIsNonMainThreadFocusRequestThrowingEnabled(boolean enabled)
```
  - isNonMainThreadFocusRequestThrowingEnabled
```
public static boolean isNonMainThreadFocusRequestThrowingEnabled()
```
  - create
```
public static ComponentsConfiguration.Builder create()
```
  - create
```
public static ComponentsConfiguration.Builder create(ComponentsConfiguration componentsConfiguration)
```

Class ComponentsConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IS_INTERNAL_BUILD

USE_INCREMENTAL_MOUNT_HELPER

CAN_CHECK_GLOBAL_ANIMATOR_SETTINGS

NEEDS_THEME_SYNCHRONIZATION

DEFAULT_BACKGROUND_THREAD_PRIORITY

DEFAULT_CHANGE_SET_THREAD_PRIORITY

isDebugModeEnabled

isDebugHierarchyEnabled

isEndToEndTestRun

isAnimationDisabled

forceEnableTransitionsForInstrumentationTests

enableErrorBoundaryComponent

threadPoolConfiguration

enableThreadTracingStacktrace

isReconciliationEnabled

overrideReconciliation

overrideLayoutDiffing

isLayoutDiffingEnabled

canInterruptAndMoveLayoutsBetweenThreads

disableGetAnnotationUsage

perfBoosterFactory

boostPerfLayoutStateFuture

computeRangeOnSyncLayout

shouldDisableBgFgOutputs

shouldAddHostViewForRootComponent

shouldContinueIncrementalMountWhenVisibileRectIsEmpty

isIncrementalMountGloballyDisabled

keepLithoNodes

lithoViewSelfManageViewPortChanges

emitMessageForZeroSizedTexture

textureSizeWarningLimit

overlappingRenderingViewSizeLimit

partialAlphaWarningSizeThresold

componentPreallocationBlocklist

isTimelineEnabled

timelineDocsLink

initStickyHeaderInLayoutWhenComponentTreeIsNull

enableNestedTreePreallocation

enableVisibilityExtension

enableTransitionsExtension

hostComponentRecyclingByWindowIsEnabled

hostComponentRecyclingByMountStateIsEnabled

unsafeHostComponentRecyclingIsEnabled

hostComponentPoolSize

furyEventCallbackInstrumentation

shouldUsePositionInParentForMounting

isBuildAndLayoutSplitEnabled

isSplitStateHandlersEnabled

reuseLastMeasuredNodeInComponentMeasure

shouldCompareCommonPropsInIsEquivalentTo

shouldCompareRootCommonPropsInSingleComponentSection

shouldDelegateContentDescriptionChangeEvent

shouldAllowCoreThreadTimeout

layoutThreadKeepAliveTimeMs

crashIfExceedingStateUpdateThreshold

enableRecyclerBinderStableId

requestMountForPrefetchedItems

fixMemoryLeakInRecyclerBinder

enableMountableComponents

enableMountableRecycler

enableMountableTwoBindersRecycler

enableMountableInNewsFeed

enableMountableInMessenger

enableSeparateAnimatorBinder

enableMountableRecyclerInGroups

enableStateUpdatesBatching

Method Detail

isRenderInfoDebuggingEnabled

setReduceMemorySpikeUserSession

reduceMemorySpikeUserSession

setReduceMemorySpikeDataDiffSection

reduceMemorySpikeDataDiffSection

setReduceMemorySpikeGetUri

reduceMemorySpikeGetUri