litho-widget/com.facebook.litho.widget/ComponentWarmer

ComponentWarmer

open class ComponentWarmer

Pool for pre-computing and storing ComponentTrees. Can be used to pre-compute and store ComponentTrees before they are inserted in a RecyclerBinder. The RecyclerBinder will fetch the precomputed ComponentTree from the pool if it's available instead of computing a layout calculation when the item needs to be computed.

Constructors

ComponentWarmer

constructor(c: ComponentContext, widthSpec: Int, heightSpec: Int)

Sets up a ComponentTreeHolderPreparerWithSizeImpl as the of this instance.

constructor()

Creates a ComponentWarmer instance which is not ready to prepare items yet.

constructor(cache: ComponentWarmer.Cache)

constructor(recyclerBinder: RecyclerBinder)

Creates a ComponentWarmer for this RecyclerBinder.

constructor(recyclerBinder: RecyclerBinder, @Nullable cache: ComponentWarmer.Cache)

Same as ComponentWarmer but uses the passed in Cache instance to manage the internal cache.

constructor(factory: ComponentWarmer.ComponentTreeHolderPreparer)

Creates a ComponentWarmer which will use the provided ComponentTreeHolderPreparer instance to create ComponentTreeHolder instances for preparing and caching items.

constructor(factory: ComponentWarmer.ComponentTreeHolderPreparer, @Nullable cache: ComponentWarmer.Cache)

Same as ComponentWarmer but uses the passed in Cache instance to manage the internal cache.

Types

interface Cache

interface CacheListener

ComponentTreeHolderPreparer

interface ComponentTreeHolderPreparer

ComponentTreeHolderPreparerWithSizeImpl

open inner class ComponentTreeHolderPreparerWithSizeImpl : ComponentWarmer.ComponentTreeHolderPreparer

ComponentWarmerReadyListener

interface ComponentWarmerReadyListener

Properties

COMPONENT_WARMER_PREPARE_HANDLER

val COMPONENT_WARMER_PREPARE_HANDLER: String = "component_warmer_prepare_handler"

COMPONENT_WARMER_TAG

val COMPONENT_WARMER_TAG: String = "component_warmer_tag"

DEFAULT_MAX_SIZE

val DEFAULT_MAX_SIZE: Int = 10

Functions

open fun cancelPrepare(tag: String)

Cancels the prepare execution for the item with the given tag if it's currently running and it removes the item from the cache.

open fun consume(tag: String): ComponentTreeHolder

If it exists, it returns the cached ComponentTreeHolder for this tag and removes it from cache.

open fun evictAll()

open fun isReady(): Boolean

open fun prepare(tag: String, componentRenderInfo: ComponentRenderInfo, @Nullable size: Size)

Synchronously prepare the ComponentTree for the given ComponentRenderInfo.

open fun prepare(tag: String, componentRenderInfo: ComponentRenderInfo, @Nullable size: Size, handler: RunnableHandler)

Synchronously post preparing the ComponentTree for the given ComponentRenderInfo to the handler.

open fun prepareAsync(tag: String, componentRenderInfo: ComponentRenderInfo)

Asynchronously prepare the ComponentTree for the given ComponentRenderInfo.

open fun remove(tag: String)

setComponentWarmerReadyListener

open fun setComponentWarmerReadyListener(listener: ComponentWarmer.ComponentWarmerReadyListener)

setReleaseEvictedEntries

open fun setReleaseEvictedEntries(releaseEvictedEntries: Boolean)