com.firebase.ui.database

Class FirebaseIndexRecyclerAdapter<T,VH extends RecyclerView.ViewHolder>

java.lang.Object

<any>

com.firebase.ui.database.FirebaseRecyclerAdapter<T,VH>

com.firebase.ui.database.FirebaseIndexRecyclerAdapter<T,VH>

Type Parameters:

T - The Java class that maps to the type of objects stored in the Firebase location.

VH - The ViewHolder class that contains the Views in the layout that is shown for each object.

public abstract class FirebaseIndexRecyclerAdapter<T,VH extends RecyclerView.ViewHolder>
extends FirebaseRecyclerAdapter<T,VH>

This class is a generic way of backing an RecyclerView with a Firebase location. It handles all of the child events at the given Firebase location. It marshals received data into the given class type.

To use this class in your app, subclass it passing in all required parameters and implement the populateViewHolder method.

     private static class ChatMessageViewHolder extends RecyclerView.ViewHolder {
         TextView messageText;
         TextView nameText;

         public ChatMessageViewHolder(View itemView) {
             super(itemView);
             nameText = (TextView)itemView.findViewById(android.R.id.text1);
             messageText = (TextView) itemView.findViewById(android.R.id.text2);
         }
     }

     FirebaseIndexRecyclerAdapter adapter;
     DatabaseReference ref = FirebaseDatabase.getInstance().getReference();

     RecyclerView recycler = (RecyclerView) findViewById(R.id.messages_recycler);
     recycler.setHasFixedSize(true);
     recycler.setLayoutManager(new LinearLayoutManager(this));

     adapter = new FirebaseIndexRecyclerAdapter(
          ChatMessage.class, android.R.layout.two_line_list_item, ChatMessageViewHolder.class, keyRef, dataRef) {
         public void populateViewHolder(ChatMessageViewHolder chatMessageViewHolder,
                                        ChatMessage chatMessage,
                                        int position) {
             chatMessageViewHolder.nameText.setText(chatMessage.getName());
             chatMessageViewHolder.messageText.setText(chatMessage.getMessage());
         }
     };
     recycler.setAdapter(mAdapter);
 

Field Summary

Fields inherited from class com.firebase.ui.database.FirebaseRecyclerAdapter

mModelLayout, mViewHolderClass

Constructor Summary

Constructors

Constructor and Description
FirebaseIndexRecyclerAdapter(java.lang.Class<T> modelClass, int modelLayout, java.lang.Class<VH> viewHolderClass, Query keyRef, Query dataRef)

Method Summary

Methods inherited from class com.firebase.ui.database.FirebaseRecyclerAdapter

cleanup, getItem, getItemCount, getItemId, getItemViewType, getRef, onBindViewHolder, onCancelled, onChildChanged, onCreateViewHolder, onDataChanged, parseSnapshot, populateViewHolder

Methods inherited from class java.lang.Object

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

Constructor Detail

FirebaseIndexRecyclerAdapter

public FirebaseIndexRecyclerAdapter(java.lang.Class<T> modelClass,
                                    @LayoutRes
                                    int modelLayout,
                                    java.lang.Class<VH> viewHolderClass,
                                    Query keyRef,
                                    Query dataRef)

Parameters:

modelClass - Firebase will marshall the data at a location into an instance of a class that you provide

modelLayout - This is the layout used to represent a single item in the list. You will be responsible for populating an instance of the corresponding view with the data from an instance of modelClass.

viewHolderClass - The class that hold references to all sub-views in an instance modelLayout.

keyRef - The Firebase location containing the list of keys to be found in dataRef. Can also be a slice of a location, using some combination of limit(), startAt(), and endAt().

dataRef - The Firebase location to watch for data changes. Each key key found at keyRef's location represents a list item in the RecyclerView.