Package com.firebase.ui.database.paging
Class DatabasePagingOptions.Builder<T>
- java.lang.Object
-
- com.firebase.ui.database.paging.DatabasePagingOptions.Builder<T>
-
- Enclosing class:
- DatabasePagingOptions<T>
public static final class DatabasePagingOptions.Builder<T> extends Object
Builder forDatabasePagingOptions.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DatabasePagingOptions<T>build()Build theDatabasePagingOptionsobject.DatabasePagingOptions.Builder<T>setDiffCallback(androidx.recyclerview.widget.DiffUtil.ItemCallback<com.google.firebase.database.DataSnapshot> diffCallback)Sets an optional customDiffUtil.ItemCallbackto compareDatabasePagingOptions.Builderobjects.DatabasePagingOptions.Builder<T>setLifecycleOwner(androidx.lifecycle.LifecycleOwner owner)Sets an optionalLifecycleOwnerto control the lifecycle of the adapter.DatabasePagingOptions.Builder<T>setQuery(com.google.firebase.database.Query query, androidx.paging.PagingConfig config, SnapshotParser<T> parser)Sets the Database query to paginate.DatabasePagingOptions.Builder<T>setQuery(com.google.firebase.database.Query query, androidx.paging.PagingConfig config, Class<T> modelClass)Sets the query using aClassSnapshotParserbased on the given class.
-
-
-
Method Detail
-
setQuery
@NonNull public DatabasePagingOptions.Builder<T> setQuery(@NonNull com.google.firebase.database.Query query, @NonNull androidx.paging.PagingConfig config, @NonNull Class<T> modelClass)
Sets the query using aClassSnapshotParserbased on the given class. SeesetQuery(Query, PagingConfig, SnapshotParser).
-
setQuery
@NonNull public DatabasePagingOptions.Builder<T> setQuery(@NonNull com.google.firebase.database.Query query, @NonNull androidx.paging.PagingConfig config, SnapshotParser<T> parser)
Sets the Database query to paginate.- Parameters:
query- the FirebaseDatabase query. This query should only contain orderByKey(), orderByChild() and orderByValue() clauses. Any limit will cause an error such as limitToLast() or limitToFirst().config- paging configuration, passed directly to the support paging library.parser- theSnapshotParserto parseDataSnapshotinto model objects.- Returns:
- this, for chaining.
-
setDiffCallback
@NonNull public DatabasePagingOptions.Builder<T> setDiffCallback(@NonNull androidx.recyclerview.widget.DiffUtil.ItemCallback<com.google.firebase.database.DataSnapshot> diffCallback)
Sets an optional customDiffUtil.ItemCallbackto compareDatabasePagingOptions.Builderobjects.- Returns:
- this, for chaining.
-
setLifecycleOwner
@NonNull public DatabasePagingOptions.Builder<T> setLifecycleOwner(@NonNull androidx.lifecycle.LifecycleOwner owner)
Sets an optionalLifecycleOwnerto control the lifecycle of the adapter. Otherwise, you must manually callFirebaseRecyclerPagingAdapter.startListening()andFirebaseRecyclerPagingAdapter.stopListening().- Returns:
- this, for chaining.
-
build
@NonNull public DatabasePagingOptions<T> build()
Build theDatabasePagingOptionsobject.
-
-