[accumulo] branch main updated: Update Upgrader interface comments to include expected system state. (#2225)

[ed...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

edcoleman pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/main by this push:
     new 3da639a  Update Upgrader interface comments to include expected system state. (#2225)
3da639a is described below

commit 3da639ac6c49ad1b9671230e3443632d27887f75
Author: EdColeman <de...@etcoleman.com>
AuthorDate: Fri Aug 6 13:17:16 2021 -0400

    Update Upgrader interface comments to include expected system state. (#2225)
    
    * Update interface comments to include expected system state.
    
    Capture discussion on PR #2185 to update javadoc comments.
    Doc update only - contains no code changes.
    
    * update phrasing per PR comments
    
    Co-authored-by: Ed Coleman etcoleman <ed...@apache.org>
---
 .../apache/accumulo/manager/upgrade/Upgrader.java   | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/server/manager/src/main/java/org/apache/accumulo/manager/upgrade/Upgrader.java b/server/manager/src/main/java/org/apache/accumulo/manager/upgrade/Upgrader.java
index 157a474..a797921 100644
--- a/server/manager/src/main/java/org/apache/accumulo/manager/upgrade/Upgrader.java
+++ b/server/manager/src/main/java/org/apache/accumulo/manager/upgrade/Upgrader.java
@@ -30,9 +30,30 @@ import org.apache.accumulo.server.ServerContext;
  * complete and then be run again later.
  */
 public interface Upgrader {
+
+  /**
+   * Update entries in ZooKeeper - called before the root tablet is loaded.
+   *
+   * @param ctx
+   *          the server context.
+   */
   void upgradeZookeeper(ServerContext ctx);
 
+  /**
+   * Update the root tablet - called after the root tablet is loaded and before the metadata table
+   * is loaded.
+   *
+   * @param ctx
+   *          the server context.
+   */
   void upgradeRoot(ServerContext ctx);
 
+  /**
+   * Update the metadata table - called after the metadata table is loaded and before loading user
+   * tablets.
+   *
+   * @param ctx
+   *          the server context.
+   */
   void upgradeMetadata(ServerContext ctx);
 }