Add javadoc

Signed-off-by: Sachin Kale <kalsac@amazon.com>
opensearch-project · Jun 30, 2023 · 9e8bcf8 · 9e8bcf8
1 parent 089e319
commit 9e8bcf8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java b/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java
@@ -196,6 +196,12 @@ default long readBlobPreferredLength() {
      */
     Map<String, BlobMetadata> listBlobsByPrefix(String blobNamePrefix) throws IOException;
 
+    /**
+     * Lists all blobs in the container that match the specified prefix in lexicographic order
+     * @param blobNamePrefix The prefix to match against blob names in the container.
+     * @param limit Limits the result size to min(limit, number of keys)
+     * @param listener the listener to be notified upon request completion
+     */
     default void listBlobsByPrefixInLexicographicOrder(String blobNamePrefix, int limit, ActionListener<List<BlobMetadata>> listener) {
         if (limit < 0) {
             throw new IllegalArgumentException("limit should not be a negative value");