Package com.firebase.ui.database

Class FirebaseRecyclerOptions.Builder<T>

java.lang.Object

com.firebase.ui.database.FirebaseRecyclerOptions.Builder<T>

Type Parameters:

T - the model class for the FirebaseRecyclerAdapter.

Enclosing class:

FirebaseRecyclerOptions<T>

public static final class FirebaseRecyclerOptions.Builder<T>
extends Object

Builder for a FirebaseRecyclerOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FirebaseRecyclerOptions<T>	build()	Build a FirebaseRecyclerOptions from the provided arguments.
FirebaseRecyclerOptions.Builder<T>	setIndexedQuery(com.google.firebase.database.Query keyQuery, com.google.firebase.database.DatabaseReference dataRef, SnapshotParser<T> snapshotParser)	Set an indexed Firebase query to listen to, along with a SnapshotParser to parse snapshots into model objects.
FirebaseRecyclerOptions.Builder<T>	setIndexedQuery(com.google.firebase.database.Query keyQuery, com.google.firebase.database.DatabaseReference dataRef, Class<T> modelClass)	Set an indexed Firebase query to listen to, along with a Class to which snapshots should be parsed.
FirebaseRecyclerOptions.Builder<T>	setLifecycleOwner(androidx.lifecycle.LifecycleOwner owner)	Set the (optional) LifecycleOwner.
FirebaseRecyclerOptions.Builder<T>	setQuery(com.google.firebase.database.Query query, SnapshotParser<T> snapshotParser)	Set the Firebase query to listen to, along with a SnapshotParser to parse snapshots into model objects.
FirebaseRecyclerOptions.Builder<T>	setQuery(com.google.firebase.database.Query query, Class<T> modelClass)	Set the Firebase query to listen to, along with a Class to which snapshots should be parsed.
FirebaseRecyclerOptions.Builder<T>	setSnapshotArray(ObservableSnapshotArray<T> snapshots)	Directly set the ObservableSnapshotArray to be listened to.

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 FirebaseRecyclerOptions.Builder<T> setSnapshotArray(@NonNull
                                                           ObservableSnapshotArray<T> snapshots)

Directly set the ObservableSnapshotArray to be listened to.

Do not call this method after calling setQuery.

setQuery

@NonNull
public FirebaseRecyclerOptions.Builder<T> setQuery(@NonNull
                                                   com.google.firebase.database.Query query,
                                                   @NonNull
                                                   SnapshotParser<T> snapshotParser)

Set the Firebase query to listen to, along with a SnapshotParser to parse snapshots into model objects.

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

setQuery

@NonNull
public FirebaseRecyclerOptions.Builder<T> setQuery(@NonNull
                                                   com.google.firebase.database.Query query,
                                                   @NonNull
                                                   Class<T> modelClass)

Set the Firebase query to listen to, along with a Class to which snapshots should be parsed.

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

setIndexedQuery

@NonNull
public FirebaseRecyclerOptions.Builder<T> setIndexedQuery(@NonNull
                                                          com.google.firebase.database.Query keyQuery,
                                                          @NonNull
                                                          com.google.firebase.database.DatabaseReference dataRef,
                                                          @NonNull
                                                          SnapshotParser<T> snapshotParser)

Set an indexed Firebase query to listen to, along with a SnapshotParser to parse snapshots into model objects. Keys are identified by the keyQuery and then data is fetched using those keys from the dataRef.

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

setIndexedQuery

@NonNull
public FirebaseRecyclerOptions.Builder<T> setIndexedQuery(@NonNull
                                                          com.google.firebase.database.Query keyQuery,
                                                          @NonNull
                                                          com.google.firebase.database.DatabaseReference dataRef,
                                                          @NonNull
                                                          Class<T> modelClass)

Set an indexed Firebase query to listen to, along with a Class to which snapshots should be parsed. Keys are identified by the keyQuery and then data is fetched using those keys from the dataRef.

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

setLifecycleOwner

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

Set the (optional) LifecycleOwner. Listens will start and stop after the appropriate lifecycle events.

build

@NonNull
public FirebaseRecyclerOptions<T> build()

Build a FirebaseRecyclerOptions from the provided arguments.