Clean up code

Author: cherylEnkidu

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/AggregationTest.java

@@ -28,7 +28,6 @@
 import static org.hamcrest.CoreMatchers.instanceOf;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
@@ -49,6 +48,7 @@
 
 @RunWith(AndroidJUnit4.class)
 public class AggregationTest {
+
   @After
   public void tearDown() {
     IntegrationTestUtil.tearDown();
@@ -100,18 +100,18 @@ public void testAggregateCountQueryEquals() {
             .orderBy("c")
             .aggregate(AggregateField.count());
 
-    assertTrue(query1.equals(query1_same));
-    assertTrue(query2.equals(query2_same));
-    assertTrue(query3.equals(query3_same));
+    assertEquals(query1, query1_same);
+    assertEquals(query2, query2_same);
+    assertEquals(query3, query3_same);
 
     assertEquals(query1.hashCode(), query1_same.hashCode());
     assertEquals(query2.hashCode(), query2_same.hashCode());
     assertEquals(query3.hashCode(), query3_same.hashCode());
 
-    assertFalse(query1.equals(null));
-    assertFalse(query1.equals("string"));
-    assertFalse(query1.equals(query2));
-    assertFalse(query2.equals(query3));
+    assertNotNull(query1);
+    assertNotEquals("string", query1);
+    assertNotEquals(query1, query2);
+    assertNotEquals(query2, query3);
     assertNotEquals(query1.hashCode(), query2.hashCode());
     assertNotEquals(query2.hashCode(), query3.hashCode());
   }
@@ -151,18 +151,18 @@ public void testAggregateSumQueryEquals() {
             .orderBy("c")
             .aggregate(sum("baz"));
 
-    assertTrue(query1.equals(query1_same));
-    assertTrue(query2.equals(query2_same));
-    assertTrue(query3.equals(query3_same));
+    assertEquals(query1, query1_same);
+    assertEquals(query2, query2_same);
+    assertEquals(query3, query3_same);
 
     assertEquals(query1.hashCode(), query1_same.hashCode());
     assertEquals(query2.hashCode(), query2_same.hashCode());
     assertEquals(query3.hashCode(), query3_same.hashCode());
 
-    assertFalse(query1.equals(null));
-    assertFalse(query1.equals("string"));
-    assertFalse(query1.equals(query2));
-    assertFalse(query2.equals(query3));
+    assertNotNull(query1);
+    assertNotEquals("string", query1);
+    assertNotEquals(query1, query2);
+    assertNotEquals(query2, query3);
     assertNotEquals(query1.hashCode(), query2.hashCode());
     assertNotEquals(query2.hashCode(), query3.hashCode());
   }
@@ -202,18 +202,18 @@ public void testAggregateAvgQueryEquals() {
             .orderBy("c")
             .aggregate(average("baz"));
 
-    assertTrue(query1.equals(query1_same));
-    assertTrue(query2.equals(query2_same));
-    assertTrue(query3.equals(query3_same));
+    assertEquals(query1, query1_same);
+    assertEquals(query2, query2_same);
+    assertEquals(query3, query3_same);
 
     assertEquals(query1.hashCode(), query1_same.hashCode());
     assertEquals(query2.hashCode(), query2_same.hashCode());
     assertEquals(query3.hashCode(), query3_same.hashCode());
 
-    assertFalse(query1.equals(null));
-    assertFalse(query1.equals("string"));
-    assertFalse(query1.equals(query2));
-    assertFalse(query2.equals(query3));
+    assertNotNull(query1);
+    assertNotEquals("string", query1);
+    assertNotEquals(query1, query2);
+    assertNotEquals(query2, query3);
     assertNotEquals(query1.hashCode(), query2.hashCode());
     assertNotEquals(query2.hashCode(), query3.hashCode());
   }
@@ -226,9 +226,9 @@ public void testAggregateQueryNotEquals() {
     AggregateQuery query2 = coll.aggregate(sum("baz"));
     AggregateQuery query3 = coll.aggregate(average("baz"));
 
-    assertFalse(query1.equals(query2));
-    assertFalse(query2.equals(query3));
-    assertFalse(query3.equals(query1));
+    assertNotEquals(query1, query2);
+    assertNotEquals(query2, query3);
+    assertNotEquals(query3, query1);
     assertNotEquals(query1.hashCode(), query2.hashCode());
     assertNotEquals(query2.hashCode(), query3.hashCode());
     assertNotEquals(query3.hashCode(), query1.hashCode());
@@ -248,9 +248,9 @@ public void testAggregateQueryNotEquals() {
             .limit(100)
             .aggregate(average("baz"));
 
-    assertFalse(query4.equals(query5));
-    assertFalse(query5.equals(query6));
-    assertFalse(query6.equals(query4));
+    assertNotEquals(query4, query5);
+    assertNotEquals(query5, query6);
+    assertNotEquals(query6, query4);
     assertNotEquals(query4.hashCode(), query5.hashCode());
     assertNotEquals(query5.hashCode(), query6.hashCode());
     assertNotEquals(query6.hashCode(), query4.hashCode());

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateField.java

@@ -16,9 +16,12 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import java.util.Objects;
 
-/** Represents an aggregation that can be performed by Firestore. */
+// TODO(sumavg): Remove the `hide` and scope annotations.
+/** @hide */
+@RestrictTo(RestrictTo.Scope.LIBRARY)
 public abstract class AggregateField {
   @Nullable private final FieldPath fieldPath;
 
@@ -44,6 +47,7 @@ public String getFieldPath() {
   }
 
   /** Returns the alias used internally for this aggregate field. */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @NonNull
   public String getAlias() {
     return alias;
@@ -67,10 +71,11 @@ public boolean equals(Object other) {
     if (!(other instanceof AggregateField)) {
       return false;
     }
-    if (fieldPath == null || ((AggregateField) other).fieldPath == null) {
-      return fieldPath == null && ((AggregateField) other).fieldPath == null;
-    }
+
     AggregateField otherAggregateField = (AggregateField) other;
+    if (fieldPath == null || otherAggregateField.fieldPath == null) {
+      return fieldPath == null && otherAggregateField.fieldPath == null;
+    }
     return operator.equals(otherAggregateField.getOperator())
         && getFieldPath().equals(otherAggregateField.getFieldPath());
   }

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateQuery.java

@@ -15,6 +15,7 @@
 package com.google.firebase.firestore;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.firebase.firestore.util.Executors;
@@ -47,6 +48,9 @@ public Query getQuery() {
   }
 
   /** Returns the AggregateFields included inside this object. */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @NonNull
   public List<AggregateField> getAggregateFields() {
     return aggregateFieldList;

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateQuerySnapshot.java

@@ -18,6 +18,7 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import com.google.firestore.v1.Value;
 import java.util.Map;
 import java.util.Objects;
@@ -50,19 +51,7 @@ public AggregateQuery getQuery() {
 
   /** Returns the number of documents in the result set of the underlying query. */
   public long getCount() {
-    AggregateField countField = AggregateField.count();
-    Object value = get(countField);
-    if (value == null) {
-      throw new IllegalArgumentException(
-          "RunAggregationQueryResponse alias " + countField.getAlias() + " is null");
-    } else if (!(value instanceof Long)) {
-      throw new IllegalArgumentException(
-          "RunAggregationQueryResponse alias "
-              + countField.getAlias()
-              + " has incorrect type: "
-              + value.getClass().getName());
-    }
-    return (long) value;
+    return get(AggregateField.count());
   }
 
   /**
@@ -73,6 +62,9 @@ public long getCount() {
    * @param aggregateField The aggregation for which the value is requested.
    * @return The result of the given aggregation.
    */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @Nullable
   public Object get(@Nonnull AggregateField aggregateField) {
     if (!data.containsKey(aggregateField.getAlias())) {
@@ -96,6 +88,30 @@ public Object get(@Nonnull AggregateField aggregateField) {
     }
   }
 
+  /**
+   * Returns the number of documents in the result set of the underlying query.
+   *
+   * @param countAggregateField The count aggregation for which the value is requested.
+   * @return The result of the given count aggregation.
+   */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  public long get(@Nonnull AggregateField.CountAggregateField countAggregateField) {
+    Object value = get((AggregateField) countAggregateField);
+    if (value == null) {
+      throw new IllegalArgumentException(
+          "RunAggregationQueryResponse alias " + countAggregateField.getAlias() + " is null");
+    } else if (!(value instanceof Long)) {
+      throw new IllegalArgumentException(
+          "RunAggregationQueryResponse alias "
+              + countAggregateField.getAlias()
+              + " has incorrect type: "
+              + value.getClass().getName());
+    }
+    return (long) value;
+  }
+
   /**
    * Returns the result of the given average aggregation. Since the result of an average aggregation
    * performed by the server is always a double, this convenience overload can be used in lieu of
@@ -105,6 +121,9 @@ public Object get(@Nonnull AggregateField aggregateField) {
    * @param averageAggregateField The average aggregation for which the value is requested.
    * @return The result of the given average aggregation.
    */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @Nullable
   public Double get(@Nonnull AggregateField.AverageAggregateField averageAggregateField) {
     return (Double) get((AggregateField) averageAggregateField);
@@ -119,6 +138,9 @@ public Double get(@Nonnull AggregateField.AverageAggregateField averageAggregate
    * @param aggregateField The aggregation for which the value is requested.
    * @return The result of the given average aggregation as a double.
    */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @Nullable
   public Double getDouble(@Nonnull AggregateField aggregateField) {
     Number result = (Number) get(aggregateField);
@@ -133,6 +155,9 @@ public Double getDouble(@Nonnull AggregateField aggregateField) {
    * @param aggregateField The aggregation for which the value is requested.
    * @return The result of the given average aggregation as a long.
    */
+  // TODO(sumavg): Remove the `hide` and scope annotations.
+  /** @hide */
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   @Nullable
   public Long getLong(@Nonnull AggregateField aggregateField) {
     Number result = (Number) get(aggregateField);