Javadoc fixes (#3594)

Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
Co-authored-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/configuration/PluginSetting.java

@@ -161,6 +161,7 @@ public <T> List<T> getTypedList(final String attribute, final Class<T> type) {
      * Returns the value of the specified {@literal List<Map<String, String>>}, or {@code defaultValue} if this settings contains no value for
      * the attribute.
      *
+     * @param attribute    attribute to be looked up
      * @param keyType      key type of the Map
      * @param valueType    value type stored in the Map
      * @param <K> The key type

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/EventHandle.java

@@ -42,6 +42,11 @@ public interface EventHandle {
      */
     Instant getInternalOriginationTime();
 
+    /**
+     * registers onRelease consumer with event handle
+     *
+     * @param releaseConsumer consumer to be calledback when event handle is released.
+     */
     void onRelease(BiConsumer<EventHandle, Boolean> releaseConsumer);
 
 }

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigObservable.java

@@ -10,6 +10,9 @@ public interface PluginConfigObservable {
 
     /**
      * Onboard a new {@link PluginConfigObserver} within the plugin.
+     *
+     * @param pluginConfigObserver plugin config observer
+     * @return returns true if the opration is successful, false otherwise
      */
     boolean addPluginConfigObserver(PluginConfigObserver pluginConfigObserver);
 

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigPublisher.java

@@ -7,6 +7,9 @@
 public interface PluginConfigPublisher {
     /**
      * Onboard a new {@link PluginConfigObservable}.
+     *
+     * @param pluginConfigObservable observable plugin configuration
+     * @return true if the operation is successful, false otherwise
      */
     boolean addPluginConfigObservable(PluginConfigObservable pluginConfigObservable);
 

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginFactory.java

@@ -22,6 +22,7 @@ public interface PluginFactory {
      *
      * @param baseClass The class type that the plugin is supporting.
      * @param pluginSetting The {@link PluginSetting} to configure this plugin
+     * @param args variable number of arguments
      * @param <T> The type
      * @return A new instance of your plugin, configured
      * @since 1.2

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/source/coordinator/enhanced/EnhancedSourcePartition.java

@@ -48,6 +48,11 @@ public void setSourcePartitionStoreItem(SourcePartitionStoreItem sourcePartition
     /**
      * Helper method to convert progress state.
      * This is because the state is currently stored as a String in the coordination store.
+     *
+     * @param progressStateClass class of progress state
+     * @param serializedPartitionProgressState serialized value of the partition progress state
+     *
+     * @return returns the converted value of the progress state
      */
     public T convertStringToPartitionProgressState(Class<T> progressStateClass, final String serializedPartitionProgressState) {
         if (Objects.isNull(serializedPartitionProgressState)) {
@@ -69,6 +74,9 @@ public T convertStringToPartitionProgressState(Class<T> progressStateClass, fina
     /**
      * Helper method to convert progress state to String
      * This is because the state is currently stored as a String in the coordination store.
+     *
+     * @param partitionProgressState optional parameter indicating the partition progress state
+     * @return returns the progress state as string
      */
     public String convertPartitionProgressStatetoString(Optional<T> partitionProgressState) {
         if (partitionProgressState.isEmpty()) {