Renaming from webclient review (#31)

`additionalReferences` -> `inMemoryPins`

Author: Greg Soltis

firebase-firestore/src/main/java/com/google/firebase/firestore/local/LocalStore.java

@@ -146,7 +146,7 @@ public LocalStore(Persistence persistence, User initialUser) {
     queryEngine = new SimpleQueryEngine(localDocuments);
 
     localViewReferences = new ReferenceSet();
-    persistence.getReferenceDelegate().setAdditionalReferences(localViewReferences);
+    persistence.getReferenceDelegate().setInMemoryPins(localViewReferences);
 
     targetIds = new SparseArray<>();
     heldBatchResults = new ArrayList<>();

firebase-firestore/src/main/java/com/google/firebase/firestore/local/MemoryEagerReferenceDelegate.java

@@ -21,7 +21,7 @@
 
 /** Provides eager garbage collection for MemoryPersistence. */
 class MemoryEagerReferenceDelegate implements ReferenceDelegate {
-  private ReferenceSet additionalReferences;
+  private ReferenceSet inMemoryPins;
   private final MemoryPersistence persistence;
   private Set<DocumentKey> orphanedDocuments;
 
@@ -35,8 +35,8 @@ public long getCurrentSequenceNumber() {
   }
 
   @Override
-  public void setAdditionalReferences(ReferenceSet additionalReferences) {
-    this.additionalReferences = additionalReferences;
+  public void setInMemoryPins(ReferenceSet inMemoryPins) {
+    this.inMemoryPins = inMemoryPins;
   }
 
   @Override
@@ -108,7 +108,7 @@ private boolean isReferenced(DocumentKey key) {
       return true;
     }
 
-    if (additionalReferences != null && additionalReferences.containsKey(key)) {
+    if (inMemoryPins != null && inMemoryPins.containsKey(key)) {
       return true;
     }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/local/MemoryLruReferenceDelegate.java

@@ -27,7 +27,7 @@
 class MemoryLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
   private final MemoryPersistence persistence;
   private final Map<DocumentKey, Long> orphanedSequenceNumbers;
-  private ReferenceSet additionalReferences;
+  private ReferenceSet inMemoryPins;
   private final LruGarbageCollector garbageCollector;
   private final ListenSequence listenSequence;
   private long currentSequenceNumber;
@@ -88,8 +88,8 @@ public void forEachOrphanedDocumentSequenceNumber(Consumer<Long> consumer) {
   }
 
   @Override
-  public void setAdditionalReferences(ReferenceSet additionalReferences) {
-    this.additionalReferences = additionalReferences;
+  public void setInMemoryPins(ReferenceSet inMemoryPins) {
+    this.inMemoryPins = inMemoryPins;
   }
 
   @Override
@@ -144,7 +144,7 @@ public boolean isPinned(DocumentKey key, long upperBound) {
       return true;
     }
 
-    if (additionalReferences.containsKey(key)) {
+    if (inMemoryPins.containsKey(key)) {
       return true;
     }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/local/ReferenceDelegate.java

@@ -32,7 +32,7 @@ interface ReferenceDelegate {
    * Registers a ReferenceSet of documents that should be considered 'referenced' and not eligible
    * for removal during garbage collection.
    */
-  void setAdditionalReferences(ReferenceSet additionalReferences);
+  void setInMemoryPins(ReferenceSet inMemoryPins);
 
   /** Notify the delegate that the given document was added to a target. */
   void addReference(DocumentKey key);

firebase-firestore/src/main/java/com/google/firebase/firestore/local/SQLiteLruReferenceDelegate.java

@@ -28,7 +28,7 @@ class SQLiteLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
   private ListenSequence listenSequence;
   private long currentSequenceNumber;
   private final LruGarbageCollector garbageCollector;
-  private ReferenceSet additionalReferences;
+  private ReferenceSet inMemoryPins;
 
   SQLiteLruReferenceDelegate(SQLitePersistence persistence) {
     this.currentSequenceNumber = ListenSequence.INVALID;
@@ -88,8 +88,8 @@ public void forEachOrphanedDocumentSequenceNumber(Consumer<Long> consumer) {
   }
 
   @Override
-  public void setAdditionalReferences(ReferenceSet additionalReferences) {
-    this.additionalReferences = additionalReferences;
+  public void setInMemoryPins(ReferenceSet inMemoryPins) {
+    this.inMemoryPins = inMemoryPins;
   }
 
   @Override
@@ -126,7 +126,7 @@ private boolean mutationQueuesContainKey(DocumentKey key) {
    * equal to the upper bound for the collection run.
    */
   private boolean isPinned(DocumentKey key) {
-    if (additionalReferences.containsKey(key)) {
+    if (inMemoryPins.containsKey(key)) {
       return true;
     }
 

firebase-firestore/src/test/java/com/google/firebase/firestore/local/LruGarbageCollectorTestCase.java

@@ -81,7 +81,7 @@ public void tearDown() {
 
   private void newTestResources() {
     persistence = createPersistence();
-    persistence.getReferenceDelegate().setAdditionalReferences(new ReferenceSet());
+    persistence.getReferenceDelegate().setInMemoryPins(new ReferenceSet());
     queryCache = persistence.getQueryCache();
     documentCache = persistence.getRemoteDocumentCache();
     User user = new User("user");
@@ -410,7 +410,7 @@ public void testRemoveTargetsThenGC() {
     // All docs in oldest target are still around
     // One blind write is gone, the first one not added to oldest target
     // Documents removed from middle target are gone, except ones added to oldest target
-    // Documents from newest target are gone, except
+    // Documents from newest target are gone, except those added to the old target as well
 
     // Through the various steps, track which documents we expect to be removed vs
     // documents we expect to be retained.