add javadoc for metadata log service constructor

Signed-off-by: Sean Kao <[email protected]>
opensearch-project · Jun 22, 2024 · 68f6844 · 68f6844
1 parent 84c483a
commit 68f6844
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/...mons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java b/...mons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java
@@ -10,6 +10,10 @@
 /**
  * Flint metadata log service provides API for metadata log related operations on a Flint index
  * regardless of underlying storage.
+ * <p>
+ * Custom implementations of this interface are expected to provide a public constructor with
+ * the signature {@code public MyCustomService(SparkConf sparkConf)} to be instantiated by
+ * the FlintMetadataLogServiceBuilder.
  */
 public interface FlintMetadataLogService {
 

diff --git a/...src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java b/...src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java
@@ -13,6 +13,10 @@
 
 /**
  * {@link FlintMetadataLogService} builder.
+ * <p>
+ * Custom implementations of {@link FlintMetadataLogService} are expected to provide a public
+ * constructor with the signature {@code public MyCustomService(SparkConf sparkConf)} to be
+ * instantiated by this builder.
  */
 public class FlintMetadataLogServiceBuilder {
   public static FlintMetadataLogService build(FlintOptions options, SparkConf sparkConf) {