Package com.firebase.ui.firestore

Class FirestoreRecyclerOptions.Builder<T>

java.lang.Object

com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder<T>

Type Parameters:

T - the model class for the FirestoreRecyclerAdapter.

Enclosing class:

FirestoreRecyclerOptions<T>

public static final class FirestoreRecyclerOptions.Builder<T>
extends java.lang.Object

Builder for FirestoreRecyclerOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FirestoreRecyclerOptions<T>	build()	Build a FirestoreRecyclerOptions from the provided arguments.
FirestoreRecyclerOptions.Builder<T>	setLifecycleOwner(androidx.lifecycle.LifecycleOwner owner)	Set a LifecycleOwner for the adapter.
FirestoreRecyclerOptions.Builder<T>	setQuery(com.google.firebase.firestore.Query query, SnapshotParser<T> parser)	Calls setQuery(Query, MetadataChanges, Class) with metadata changes excluded.
FirestoreRecyclerOptions.Builder<T>	setQuery(com.google.firebase.firestore.Query query, com.google.firebase.firestore.MetadataChanges changes, SnapshotParser<T> parser)	Set the query to use (with options) and provide a custom SnapshotParser.
FirestoreRecyclerOptions.Builder<T>	setQuery(com.google.firebase.firestore.Query query, com.google.firebase.firestore.MetadataChanges changes, java.lang.Class<T> modelClass)	Set the query to use (with options) and provide a model class to which each snapshot will be converted.
FirestoreRecyclerOptions.Builder<T>	setQuery(com.google.firebase.firestore.Query query, java.lang.Class<T> modelClass)	Calls setQuery(Query, MetadataChanges, Class) with metadata changes excluded.
FirestoreRecyclerOptions.Builder<T>	setSnapshotArray(ObservableSnapshotArray<T> snapshots)	Directly set the ObservableSnapshotArray.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setSnapshotArray

@NonNull
public FirestoreRecyclerOptions.Builder<T> setSnapshotArray(@NonNull
                                                            ObservableSnapshotArray<T> snapshots)

Directly set the ObservableSnapshotArray.

Do not call this method after calling setQuery.

setQuery

@NonNull
public FirestoreRecyclerOptions.Builder<T> setQuery(@NonNull
                                                    com.google.firebase.firestore.Query query,
                                                    @NonNull
                                                    SnapshotParser<T> parser)

Calls setQuery(Query, MetadataChanges, Class) with metadata changes excluded.

setQuery

@NonNull
public FirestoreRecyclerOptions.Builder<T> setQuery(@NonNull
                                                    com.google.firebase.firestore.Query query,
                                                    @NonNull
                                                    java.lang.Class<T> modelClass)

Calls setQuery(Query, MetadataChanges, Class) with metadata changes excluded.

setQuery

@NonNull
public FirestoreRecyclerOptions.Builder<T> setQuery(@NonNull
                                                    com.google.firebase.firestore.Query query,
                                                    @NonNull
                                                    com.google.firebase.firestore.MetadataChanges changes,
                                                    @NonNull
                                                    java.lang.Class<T> modelClass)

Set the query to use (with options) and provide a model class to which each snapshot will be converted.

Do not call this method after calling setSnapshotArray(ObservableSnapshotArray).

setQuery

@NonNull
public FirestoreRecyclerOptions.Builder<T> setQuery(@NonNull
                                                    com.google.firebase.firestore.Query query,
                                                    @NonNull
                                                    com.google.firebase.firestore.MetadataChanges changes,
                                                    @NonNull
                                                    SnapshotParser<T> parser)

Set the query to use (with options) and provide a custom SnapshotParser.

Do not call this method after calling setSnapshotArray(ObservableSnapshotArray).

setLifecycleOwner

@NonNull
public FirestoreRecyclerOptions.Builder<T> setLifecycleOwner(@Nullable
                                                             androidx.lifecycle.LifecycleOwner owner)

Set a LifecycleOwner for the adapter. Listening will stop/start after the appropriate lifecycle events.

build

@NonNull
public FirestoreRecyclerOptions<T> build()

Build a FirestoreRecyclerOptions from the provided arguments.