Added javadoc for NodeShardResult and NodesToAllocate

Signed-off-by: Shivansh Arora <shivansh.arora@protonmail.com>
shiv0408 · Sep 15, 2023 · 26ae860 · 26ae860
1 parent e7c778c
commit 26ae860
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java b/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java
@@ -506,6 +506,9 @@ protected static NodesToAllocate buildNodesToAllocate(
 
     protected abstract FetchResult<NodeGatewayStartedShards> fetchData(ShardRouting shard, RoutingAllocation allocation);
 
+    /**
+     * This class encapsulates the result of a call to {@link #buildNodeShardsResult}
+     */
     protected static class NodeShardsResult {
         final NodeShardStates orderedAllocationCandidates;
         final int allocationsFound;
@@ -516,6 +519,9 @@ protected static class NodeShardsResult {
         }
     }
 
+    /**
+     * This class encapsulates the result of a call to {@link #buildNodesToAllocate(RoutingAllocation, NodeShardStates, ShardRouting, boolean)}
+     * */
     protected static class NodesToAllocate {
         final List<? extends DecidedNode> yesNodeShards;
         final List<? extends DecidedNode> throttleNodeShards;