Move errors up to base class

Change-Id: I5fddbe75f2c99c5ae832db2e44f09105634cbef3

Author: samtstern

common/src/main/java/com/firebase/ui/common/BaseObservableSnapshotArray.java

@@ -8,18 +8,19 @@
 import java.util.concurrent.CopyOnWriteArrayList;
 
 /**
- * Exposes a collection of {@link S} items in a database as a {@link List} of {@link E} objects.
+ * Exposes a collection of {@link S} items in a database as a {@link List} of {@link T} objects.
  * To observe the list attach a {@link L} listener.
  *
  * @param <S> the snapshot class.
+ * @param <E> the error type raised for the listener.
  * @param <L> the listener class.
- * @param <E> the model object class.
+ * @param <T> the model object class.
  */
-public abstract class BaseObservableSnapshotArray<S, L extends BaseChangeEventListener<S,?>, E>
+public abstract class BaseObservableSnapshotArray<S, E, L extends BaseChangeEventListener<S, E>, T>
         extends AbstractList<S> {
 
     private final List<L> mListeners = new CopyOnWriteArrayList<>();
-    private BaseSnapshotParser<S, E> mParser;
+    private BaseSnapshotParser<S, T> mParser;
 
     /**
      * True if there has been a "data changed" event since the array was created, false otherwise.
@@ -37,7 +38,7 @@ public BaseObservableSnapshotArray() {}
      *
      * @param parser the {@link BaseSnapshotParser} to use
      */
-    public BaseObservableSnapshotArray(@NonNull BaseSnapshotParser<S, E> parser) {
+    public BaseObservableSnapshotArray(@NonNull BaseSnapshotParser<S, T> parser) {
         mParser = Preconditions.checkNotNull(parser);
     }
 
@@ -146,7 +147,7 @@ public final boolean isListening(L listener) {
      * type. This uses the {@link BaseSnapshotParser} passed to the constructor. If the parser was not
      * initialized this will throw an unchecked exception.
      */
-    public E getObject(int index) {
+    public T getObject(int index) {
         if (mParser == null) {
             throw new IllegalStateException("getObject() called before snapshot parser set.");
         }
@@ -171,11 +172,17 @@ protected void notifyListenersOnDataChanged() {
         }
     }
 
-    protected BaseSnapshotParser<S, E> getSnapshotParser() {
+    protected void notifyListenersOnError(E e) {
+        for (L listener : getListeners()) {
+            listener.onError(e);
+        }
+    }
+
+    protected BaseSnapshotParser<S, T> getSnapshotParser() {
         return mParser;
     }
 
-    protected void setSnapshotParser(BaseSnapshotParser<S, E> parser) {
+    protected void setSnapshotParser(BaseSnapshotParser<S, T> parser) {
         mParser = parser;
     }
 }

database/src/main/java/com/firebase/ui/database/FirebaseArray.java

@@ -121,7 +121,7 @@ public void onDataChange(DataSnapshot dataSnapshot) {
 
     @Override
     public void onCancelled(DatabaseError error) {
-        notifyListenersOnCancelled(error);
+        notifyListenersOnError(error);
     }
 
     private int getIndexForKey(String key) {

database/src/main/java/com/firebase/ui/database/FirebaseIndexArray.java

@@ -194,6 +194,16 @@ protected void onKeyRemoved(DataSnapshot data, int index) {
         }
     }
 
+    @Override
+    public DataSnapshot get(int i) {
+        return mDataSnapshots.get(i);
+    }
+
+    @Override
+    public int size() {
+        return mKeySnapshots.size();
+    }
+
     @Override
     public boolean equals(Object obj) {
         if (this == obj) return true;
@@ -260,7 +270,7 @@ public void onDataChange(DataSnapshot snapshot) {
 
         @Override
         public void onCancelled(DatabaseError error) {
-            notifyListenersOnCancelled(error);
+            notifyListenersOnError(error);
         }
     }
 }

database/src/main/java/com/firebase/ui/database/ObservableSnapshotArray.java

@@ -12,10 +12,10 @@
  * Exposes a collection of items in Firebase as a {@link List} of {@link DataSnapshot}. To observe
  * the list attach a {@link com.google.firebase.database.ChildEventListener}.
  *
- * @param <E> a POJO class to which the DataSnapshots can be converted.
+ * @param <T> a POJO class to which the DataSnapshots can be converted.
  */
-public abstract class ObservableSnapshotArray<E>
-        extends BaseObservableSnapshotArray<DataSnapshot, ChangeEventListener, E> {
+public abstract class ObservableSnapshotArray<T>
+        extends BaseObservableSnapshotArray<DataSnapshot, DatabaseError, ChangeEventListener, T> {
 
     /**
      * Default constructor. Must set the snapshot parser before user.
@@ -31,7 +31,7 @@ public ObservableSnapshotArray() {
      * @param clazz the class as which DataSnapshots should be parsed.
      * @see ClassSnapshotParser
      */
-    public ObservableSnapshotArray(@NonNull Class<E> clazz) {
+    public ObservableSnapshotArray(@NonNull Class<T> clazz) {
         super(new ClassSnapshotParser<>(clazz));
     }
 
@@ -40,13 +40,15 @@ public ObservableSnapshotArray(@NonNull Class<E> clazz) {
      *
      * @param parser the {@link SnapshotParser} to use
      */
-    public ObservableSnapshotArray(@NonNull SnapshotParser<E> parser) {
+    public ObservableSnapshotArray(@NonNull SnapshotParser<T> parser) {
         super(parser);
     }
 
+    /**
+     * Use {@link BaseObservableSnapshotArray#notifyListenersOnError(Object)}.
+     */
+    @Deprecated
     protected void notifyListenersOnCancelled(DatabaseError error) {
-        for (ChangeEventListener listener : getListeners()) {
-            listener.onError(error);
-        }
+        notifyListenersOnError(error);
     }
 }

firestore/src/main/java/com/firebase/ui/firestore/FirestoreArray.java

@@ -67,7 +67,7 @@ protected void onDestroy() {
     public void onEvent(QuerySnapshot snapshots, FirebaseFirestoreException e) {
         if (e != null) {
             Log.w(TAG, "Error in snapshot listener", e);
-            notifyOnError(e);
+            notifyListenersOnError(e);
             return;
         }
 

firestore/src/main/java/com/firebase/ui/firestore/ObservableSnapshotArray.java

@@ -10,8 +10,8 @@
 /**
  * Subclass of {@link BaseObservableSnapshotArray} for Firestore data.
  */
-public abstract class ObservableSnapshotArray<E>
-        extends BaseObservableSnapshotArray<DocumentSnapshot, ChangeEventListener, E> {
+public abstract class ObservableSnapshotArray<T>
+        extends BaseObservableSnapshotArray<DocumentSnapshot, FirebaseFirestoreException, ChangeEventListener, T> {
 
     public ObservableSnapshotArray() {
         super();
@@ -20,14 +20,7 @@ public ObservableSnapshotArray() {
     /**
      * See {@link BaseObservableSnapshotArray#BaseObservableSnapshotArray(BaseSnapshotParser)}
      */
-    public ObservableSnapshotArray(@NonNull SnapshotParser<E> parser) {
+    public ObservableSnapshotArray(@NonNull SnapshotParser<T> parser) {
         super(parser);
     }
-
-    // TODO: There should be a way to move this into the base class
-    protected void notifyOnError(FirebaseFirestoreException e) {
-        for (ChangeEventListener listener : getListeners()) {
-            listener.onError(e);
-        }
-    }
 }