improve javadoc

keith-turner · Sep 30, 2024 · 8cc15ad · 8cc15ad
1 parent 16b351a
commit 8cc15ad
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/core/src/main/java/org/apache/accumulo/core/data/LoadPlan.java b/core/src/main/java/org/apache/accumulo/core/data/LoadPlan.java
@@ -412,6 +412,12 @@ static SplitResolver from(SortedSet<Text> splits) {
     TableSplits apply(Text row);
   }
 
+  /**
+   * Computes a load plan for a given rfile. This will open the rfile and find every
+   * {@link TableSplits} that overlaps rows in the file and add those to the returned load plan.
+   *
+   * @since 3.1.0
+   */
   public static LoadPlan compute(URI file, SplitResolver splitResolver) throws IOException {
     return compute(file, Map.of(), splitResolver);
   }
@@ -420,6 +426,8 @@ public static LoadPlan compute(URI file, SplitResolver splitResolver) throws IOE
    * Computes a load plan for a given rfile. This will open the rfile and find every
    * {@link TableSplits} that overlaps rows in the file and add those to the returned load plan.
    *
+   * @param properties used when opening the rfile, see
+   *        {@link org.apache.accumulo.core.client.rfile.RFile.ScannerOptions#withTableProperties(Map)}
    * @since 3.1.0
    */
   public static LoadPlan compute(URI file, Map<String,String> properties,