The Android Developer Challenge is back! Submit your idea before December 2.

RecycledViewPool

open class RecycledViewPool
kotlin.Any
   ↳ androidx.recyclerview.widget.RecyclerView.RecycledViewPool

RecycledViewPool lets you share Views between multiple RecyclerViews.

If you want to recycle views across RecyclerViews, create an instance of RecycledViewPool and use RecyclerView#setRecycledViewPool(RecycledViewPool).

RecyclerView automatically creates a pool for itself if you don't provide one.

Summary

Public constructors

RecycledViewPool lets you share Views between multiple RecyclerViews.

Public methods

open Unit

Discard all ViewHolders.

open RecyclerView.ViewHolder?
getRecycledView(viewType: Int)

Acquire a ViewHolder of the specified type from the pool, or null if none are present.

open Int

Returns the current number of Views held by the RecycledViewPool of the given view type.

open Unit

Add a scrap ViewHolder to the pool.

open Unit
setMaxRecycledViews(viewType: Int, max: Int)

Sets the maximum number of ViewHolders to hold in the pool before discarding.

Public constructors

<init>

RecycledViewPool()

RecycledViewPool lets you share Views between multiple RecyclerViews.

If you want to recycle views across RecyclerViews, create an instance of RecycledViewPool and use RecyclerView#setRecycledViewPool(RecycledViewPool).

RecyclerView automatically creates a pool for itself if you don't provide one.

Public methods

clear

open fun clear(): Unit

Discard all ViewHolders.

getRecycledView

@Nullable open fun getRecycledView(viewType: Int): RecyclerView.ViewHolder?

Acquire a ViewHolder of the specified type from the pool, or null if none are present.

Parameters
viewType Int: ViewHolder type.
Return
RecyclerView.ViewHolder?: ViewHolder of the specified type acquired from the pool, or null if none are present.

getRecycledViewCount

open fun getRecycledViewCount(viewType: Int): Int

Returns the current number of Views held by the RecycledViewPool of the given view type.

putRecycledView

open fun putRecycledView(scrap: RecyclerView.ViewHolder!): Unit

Add a scrap ViewHolder to the pool.

If the pool is already full for that ViewHolder's type, it will be immediately discarded.

Parameters
scrap RecyclerView.ViewHolder!: ViewHolder to be added to the pool.

setMaxRecycledViews

open fun setMaxRecycledViews(viewType: Int, max: Int): Unit

Sets the maximum number of ViewHolders to hold in the pool before discarding.

Parameters
viewType Int: ViewHolder Type
max Int: Maximum number