From 772b5bbaf719a28a65a9f5a624d5212e3bdcb091 Mon Sep 17 00:00:00 2001
From: Janak Ramakrishnan <janakr@google.com>
Date: Wed, 29 Jun 2016 00:20:36 +0000
Subject: Minor documentation and visibility tweaks to InMemoryNodeEntry and
 InvalidatedNodeEntry.

--
MOS_MIGRATED_REVID=126139179
---
 .../google/devtools/build/skyframe/BuildingState.java    | 16 ++++++++--------
 .../devtools/build/skyframe/InMemoryNodeEntry.java       | 11 +++++------
 2 files changed, 13 insertions(+), 14 deletions(-)

(limited to 'src')

diff --git a/src/main/java/com/google/devtools/build/skyframe/BuildingState.java b/src/main/java/com/google/devtools/build/skyframe/BuildingState.java
index 6969f286a5..989a56c72b 100644
--- a/src/main/java/com/google/devtools/build/skyframe/BuildingState.java
+++ b/src/main/java/com/google/devtools/build/skyframe/BuildingState.java
@@ -110,11 +110,11 @@ public class BuildingState {
   private final GroupedList<SkyKey> directDeps = new GroupedList<>();
 
   /**
-   * The set of reverse dependencies that are registered before the node has finished building.
-   * Upon building, these reverse deps will be signaled and then stored in the permanent
-   * {@code ValueEntry#reverseDeps}.
+   * The set of reverse dependencies that are registered before the node has finished building. Upon
+   * building, these reverse deps will be signaled and then stored in the permanent {@link
+   * InMemoryNodeEntry#reverseDeps}.
    */
-  private Object reverseDepsToSignal = ImmutableList.of();
+  protected Object reverseDepsToSignal = ImmutableList.of();
   private List<Object> reverseDepsDataToConsolidate = null;
 
   private static final ReverseDepsUtil<BuildingState> REVERSE_DEPS_UTIL =
@@ -155,7 +155,7 @@ public class BuildingState {
    * it means that this node is being built for the first time. See {@link #directDeps} for more on
    * dependency group storage.
    */
-  private final GroupedList<SkyKey> lastBuildDirectDeps;
+  protected final GroupedList<SkyKey> lastBuildDirectDeps;
 
   /**
    * Group of children to be checked next in the process of determining if this entry needs to be
@@ -386,10 +386,10 @@ public class BuildingState {
   }
 
   /**
-   * Returns the direct deps (in groups) found on this build. Should only be called when the node
-   * is done.
+   * Returns the direct deps (in groups) found on this build. Should only be called when the node is
+   * done.
    *
-   * @see InMemoryNodeEntry#setStateFinishedAndReturnReverseDeps
+   * @see InMemoryNodeEntry#setStateFinishedAndReturnReverseDepsToSignal
    */
   GroupedList<SkyKey> getFinishedDirectDeps() {
     return directDeps;
diff --git a/src/main/java/com/google/devtools/build/skyframe/InMemoryNodeEntry.java b/src/main/java/com/google/devtools/build/skyframe/InMemoryNodeEntry.java
index a886e267cc..39dafca382 100644
--- a/src/main/java/com/google/devtools/build/skyframe/InMemoryNodeEntry.java
+++ b/src/main/java/com/google/devtools/build/skyframe/InMemoryNodeEntry.java
@@ -83,7 +83,6 @@ public class InMemoryNodeEntry implements NodeEntry {
    * <p>In case of a single object we store the object unwrapped, without the list, for
    * memory-efficiency.
    */
-  @VisibleForTesting
   protected Object reverseDeps = ImmutableList.of();
 
   /**
@@ -194,14 +193,14 @@ public class InMemoryNodeEntry implements NodeEntry {
   }
 
   /**
-   * Puts entry in "done" state, as checked by {@link #isDone}. Subclasses that override one should
-   * override the other.
+   * Puts entry in "done" state, as checked by {@link #isDone}. Subclasses that override one may
+   * need to override the other.
    */
   protected void markDone() {
     buildingState = null;
   }
 
-  protected synchronized Set<SkyKey> setStateFinishedAndReturnReverseDeps() {
+  protected synchronized Set<SkyKey> setStateFinishedAndReturnReverseDepsToSignal() {
     // Get reverse deps that need to be signaled.
     ImmutableSet<SkyKey> reverseDepsToSignal = buildingState.getReverseDepsToSignal();
     getReverseDepsUtil().addReverseDeps(this, reverseDepsToSignal);
@@ -245,7 +244,7 @@ public class InMemoryNodeEntry implements NodeEntry {
       this.value = value;
     }
 
-    return setStateFinishedAndReturnReverseDeps();
+    return setStateFinishedAndReturnReverseDepsToSignal();
   }
 
   protected ReverseDepsUtil<InMemoryNodeEntry> getReverseDepsUtil() {
@@ -369,7 +368,7 @@ public class InMemoryNodeEntry implements NodeEntry {
         this);
     Preconditions.checkState(isDirty(), this);
     Preconditions.checkState(!buildingState.isChanged(), "shouldn't be changed: %s", this);
-    return setStateFinishedAndReturnReverseDeps();
+    return setStateFinishedAndReturnReverseDepsToSignal();
   }
 
   @Override
-- 
cgit v1.2.3