ComponentsConfiguration

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

```
public class ComponentsConfiguration
extends 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.

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 boolean`	`checkNeedsRemeasure` If true, we also check if the RecyclerBinder needs remeasuring when checking if it's been measured.
`static boolean`	`debugHighlightInteractiveBounds` Debug option to highlight interactive areas in mounted components.
`static boolean`	`debugHighlightMountBounds` Debug option to highlight mount bounds of mounted components.
`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`	`delegateToRenderCoreMount`
`static boolean`	`disableComponentHostPool` (Hopefully) temporary measure as we're investigating a major crash in libhwui.
`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 String`	`disablePoolsEnd`
`static String`	`disablePoolsStart`
`static boolean`	`disableTransitionsExtensionForMountDelegate`
`static boolean`	`enableErrorBoundaryComponent`
`static boolean`	`enableLithoViewDebugOverlay` LithoView overlay showing whether its ComponentTree was computed on UI thread (red) or bg thread (green).
`static boolean`	`enableOnErrorHandling` Enable exception delegation to `OnError`.
`static boolean`	`enableRenderInfoDebugging` If true, information about RenderInfos will be passed to Flipper's layout inspector.
`static boolean`	`enableShouldCreateLayoutWithNewSizeSpec` Whether the OnShouldCreateLayoutWithNewSizeSpec is used with Layout Spec with size spec.
`static boolean`	`enableThreadTracingStacktrace`
`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`	`ignoreStateUpdatesForScreenshotTest`
`static boolean`	`incrementalVisibilityHandling`
`static boolean`	`inheritPriorityFromUiThread` Whether the background thread that's currently running the layout should have its priority raised to the thread priority of the UI thread.
`static boolean`	`IS_INTERNAL_BUILD` Indicates whether this is an internal build.
`static boolean`	`isAnimationDisabled`
`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`	`isGlobalComponentsPoolEnabled`
`static boolean`	`isHooksImplEnabled` When `true` internal hooks implementation is applied.
`static boolean`	`isIncrementalMountGloballyDisabled` When `true`, disables incremental mount globally.
`static boolean`	`isLayoutDiffingEnabled` Sets if layout diffing is enabled.
`static boolean`	`isPoolBisectEnabled` Bisect mount pool to find the buggy implementation causing native crashes.
`static boolean`	`isReconciliationEnabled` Sets if is reconciliation is enabled
`static boolean`	`lazyComparableAnimatedColorDrawable` specifies if the ComparableAnimatedColorDrawable should be initialized in a lazy way
`static boolean`	`NEEDS_THEME_SYNCHRONIZATION` Whether we need to account for lack of synchronization while accessing Themes.
`static boolean`	`onlyProcessAutogeneratedTransitionIdsWhenNecessary` Enables more smart approach to processing autogenerated transition ids in TransitionManager.setupTransitions(), taking into account whether there are transitions that target all layout, and the fact that appear/disappear animations cannot be defined for autogenerated ids
`static LithoPerfBoosterFactory`	`perfBoosterFactory`
`static boolean`	`prioritizeRenderingOnParallel`
`static boolean`	`shouldDisableDrawableOutputs`
`static boolean`	`shouldForceAsyncStateUpdate` Enabling this will force all updateStateSync methods to be updateStateAsync.
`static boolean`	`shouldForceComponentUpdateOnOrientationChange` If `false` we won't force Component to update when Device Orientation change, and rely on its size change.
`static boolean`	`shouldUseDeepCloneDuringReconciliation` When enabled reconciliation will use the deep clone method of the InternalNode with the simplified implementation of shallow copy.
`static boolean`	`skipVisChecksForFullyVisible`
`static LayoutThreadPoolConfiguration`	`threadPoolConfiguration` If non-null, a thread pool will be used for async layouts instead of a single layout thread.
`static LayoutThreadPoolConfiguration`	`threadPoolForBackgroundThreadsConfig` Configuration for creating a thread pool of threads used for background layout.
`static boolean`	`unmountAllWhenComponentTreeSetToNull` Whether to unmount all contents of LithoView when its ComponentTree is set to null.
`static boolean`	`USE_INCREMENTAL_MOUNT_HELPER` Indicates that the incremental mount helper is required for this build.
`static boolean`	`useCancelableLayoutFutures`
`static boolean`	`useExtensionsWithMountDelegate`
`static boolean`	`useGlobalKeys` If false, global keys will not be generated (litho level state updates won't work).
`static boolean`	`useIncrementalMountExtension`
`static boolean`	`useInternalNodesForLayoutDiffing` When enabled it would use Internal Nodes for layout diffing instead Diff Nodes.
`static boolean`	`useNewGenerateMechanismForGlobalKeys` If true, global keys will be generated in Layout, otherwise a component itself responsible for the global key generation.
`static boolean`	`useSharedFutureOnParallel`
`static boolean`	`useVisibilityExtension`

Constructor Summary

Constructors
Constructor and Description

ComponentsConfiguration()

Constructors
Constructor and Description
`ComponentsConfiguration()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static boolean isRenderInfoDebuggingEnabled()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isRenderInfoDebuggingEnabled()`

- 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.
  - debugHighlightInteractiveBounds
```
public static boolean debugHighlightInteractiveBounds
```
    Debug option to highlight interactive areas in mounted components.
  - enableLithoViewDebugOverlay
```
public static boolean enableLithoViewDebugOverlay
```
    LithoView overlay showing whether its ComponentTree was computed on UI thread (red) or bg thread (green).
  - debugHighlightMountBounds
```
public static boolean debugHighlightMountBounds
```
    Debug option to highlight mount bounds of mounted components.
  - 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.
  - enableOnErrorHandling
```
public static boolean enableOnErrorHandling
```
    Enable exception delegation to OnError.
  - enableErrorBoundaryComponent
```
public static boolean enableErrorBoundaryComponent
```
  - useGlobalKeys
```
public static boolean useGlobalKeys
```
    If false, global keys will not be generated (litho level state updates won't work). It's highly discouraged to to change this to false, unless you handle all your updates outside of the litho framework
  - useNewGenerateMechanismForGlobalKeys
```
public static boolean useNewGenerateMechanismForGlobalKeys
```
    If true, global keys will be generated in Layout, otherwise a component itself responsible for the global key generation.
  - unmountAllWhenComponentTreeSetToNull
```
public static boolean unmountAllWhenComponentTreeSetToNull
```
    Whether to unmount all contents of LithoView when its ComponentTree is set to null.
  - threadPoolForBackgroundThreadsConfig
```
public static LayoutThreadPoolConfiguration threadPoolForBackgroundThreadsConfig
```
    Configuration for creating a thread pool of threads used for background layout. If null, a single default thread will be used for background layout.
  - 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
```
  - inheritPriorityFromUiThread
```
public static boolean inheritPriorityFromUiThread
```
    Whether the background thread that's currently running the layout should have its priority raised to the thread priority of the UI thread.
  - enableShouldCreateLayoutWithNewSizeSpec
```
public static boolean enableShouldCreateLayoutWithNewSizeSpec
```
    Whether the OnShouldCreateLayoutWithNewSizeSpec is used with Layout Spec with size spec. This will also disable the associated layout caching.
  - onlyProcessAutogeneratedTransitionIdsWhenNecessary
```
public static boolean onlyProcessAutogeneratedTransitionIdsWhenNecessary
```
    Enables more smart approach to processing autogenerated transition ids in TransitionManager.setupTransitions(), taking into account whether there are transitions that target all layout, and the fact that appear/disappear animations cannot be defined for autogenerated ids
  - isReconciliationEnabled
```
public static boolean isReconciliationEnabled
```
    Sets if is reconciliation is enabled
  - isLayoutDiffingEnabled
```
public static boolean isLayoutDiffingEnabled
```
    Sets if layout diffing is enabled. This should be used in conjugation with .
  - lazyComparableAnimatedColorDrawable
```
public static boolean lazyComparableAnimatedColorDrawable
```
    specifies if the ComparableAnimatedColorDrawable should be initialized in a lazy way
  - enableRenderInfoDebugging
```
public static boolean enableRenderInfoDebugging
```
    If true, information about RenderInfos will be passed to Flipper's layout inspector.
  - useCancelableLayoutFutures
```
public static boolean useCancelableLayoutFutures
```
  - canInterruptAndMoveLayoutsBetweenThreads
```
public static boolean canInterruptAndMoveLayoutsBetweenThreads
```
  - skipVisChecksForFullyVisible
```
public static boolean skipVisChecksForFullyVisible
```
  - 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.
  - isPoolBisectEnabled
```
public static boolean isPoolBisectEnabled
```
    Bisect mount pool to find the buggy implementation causing native crashes.
  - disablePoolsStart
```
public static String disablePoolsStart
```
  - disablePoolsEnd
```
public static String disablePoolsEnd
```
  - ignoreStateUpdatesForScreenshotTest
```
public static boolean ignoreStateUpdatesForScreenshotTest
```
  - prioritizeRenderingOnParallel
```
public static boolean prioritizeRenderingOnParallel
```
  - useSharedFutureOnParallel
```
public static boolean useSharedFutureOnParallel
```
  - checkNeedsRemeasure
```
public static boolean checkNeedsRemeasure
```
    If true, we also check if the RecyclerBinder needs remeasuring when checking if it's been measured.
  - disableComponentHostPool
```
public static boolean disableComponentHostPool
```
    (Hopefully) temporary measure as we're investigating a major crash in libhwui.
  - 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
  - shouldUseDeepCloneDuringReconciliation
```
public static boolean shouldUseDeepCloneDuringReconciliation
```
    When enabled reconciliation will use the deep clone method of the InternalNode with the simplified implementation of shallow copy.
  - useInternalNodesForLayoutDiffing
```
public static boolean useInternalNodesForLayoutDiffing
```
    When enabled it would use Internal Nodes for layout diffing instead Diff Nodes.
  - incrementalVisibilityHandling
```
public static boolean incrementalVisibilityHandling
```
  - shouldForceAsyncStateUpdate
```
public static boolean shouldForceAsyncStateUpdate
```
    Enabling this will force all updateStateSync methods to be updateStateAsync. *
  - useExtensionsWithMountDelegate
```
public static boolean useExtensionsWithMountDelegate
```
  - delegateToRenderCoreMount
```
public static boolean delegateToRenderCoreMount
```
  - disableTransitionsExtensionForMountDelegate
```
public static boolean disableTransitionsExtensionForMountDelegate
```
  - shouldDisableDrawableOutputs
```
public static boolean shouldDisableDrawableOutputs
```
  - useIncrementalMountExtension
```
public static boolean useIncrementalMountExtension
```
  - useVisibilityExtension
```
public static boolean useVisibilityExtension
```
  - shouldForceComponentUpdateOnOrientationChange
```
public static boolean shouldForceComponentUpdateOnOrientationChange
```
    If false we won't force Component to update when Device Orientation change, and rely on its size change.
  - isGlobalComponentsPoolEnabled
```
public static boolean isGlobalComponentsPoolEnabled
```
  - isHooksImplEnabled
```
public static boolean isHooksImplEnabled
```
    When true internal hooks implementation is applied.
  - isIncrementalMountGloballyDisabled
```
public static boolean isIncrementalMountGloballyDisabled
```
    When true, disables incremental mount globally.
- Constructor Detail
  - ComponentsConfiguration
```
public ComponentsConfiguration()
```
- Method Detail
  - isRenderInfoDebuggingEnabled
```
public static boolean isRenderInfoDebuggingEnabled()
```

Class ComponentsConfiguration

Field Summary

Constructor 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

debugHighlightInteractiveBounds

enableLithoViewDebugOverlay

debugHighlightMountBounds

isEndToEndTestRun

isAnimationDisabled

forceEnableTransitionsForInstrumentationTests

enableOnErrorHandling

enableErrorBoundaryComponent

useGlobalKeys

useNewGenerateMechanismForGlobalKeys

unmountAllWhenComponentTreeSetToNull

threadPoolForBackgroundThreadsConfig

threadPoolConfiguration

enableThreadTracingStacktrace

inheritPriorityFromUiThread

enableShouldCreateLayoutWithNewSizeSpec

onlyProcessAutogeneratedTransitionIdsWhenNecessary

isReconciliationEnabled

isLayoutDiffingEnabled

lazyComparableAnimatedColorDrawable

enableRenderInfoDebugging

useCancelableLayoutFutures

canInterruptAndMoveLayoutsBetweenThreads

skipVisChecksForFullyVisible

disableGetAnnotationUsage

isPoolBisectEnabled

disablePoolsStart

disablePoolsEnd

ignoreStateUpdatesForScreenshotTest

prioritizeRenderingOnParallel

useSharedFutureOnParallel

checkNeedsRemeasure

disableComponentHostPool

perfBoosterFactory

boostPerfLayoutStateFuture

shouldUseDeepCloneDuringReconciliation

useInternalNodesForLayoutDiffing

incrementalVisibilityHandling

shouldForceAsyncStateUpdate

useExtensionsWithMountDelegate

delegateToRenderCoreMount

disableTransitionsExtensionForMountDelegate

shouldDisableDrawableOutputs

useIncrementalMountExtension

useVisibilityExtension

shouldForceComponentUpdateOnOrientationChange

isGlobalComponentsPoolEnabled

isHooksImplEnabled

isIncrementalMountGloballyDisabled

Constructor Detail

ComponentsConfiguration

Method Detail

isRenderInfoDebuggingEnabled