From 15d8247205765fb39c41354a2b7214d98ac3ba83 Mon Sep 17 00:00:00 2001 From: kkondaka <41027584+kkondaka@users.noreply.github.com> Date: Tue, 7 Nov 2023 12:18:43 -0800 Subject: [PATCH] Javadoc fixes (#3594) Signed-off-by: Krishna Kondaka Co-authored-by: Krishna Kondaka --- .../dataprepper/model/configuration/PluginSetting.java | 1 + .../opensearch/dataprepper/model/event/EventHandle.java | 5 +++++ .../dataprepper/model/plugin/PluginConfigObservable.java | 3 +++ .../dataprepper/model/plugin/PluginConfigPublisher.java | 3 +++ .../dataprepper/model/plugin/PluginFactory.java | 1 + .../coordinator/enhanced/EnhancedSourcePartition.java | 8 ++++++++ 6 files changed, 21 insertions(+) diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/configuration/PluginSetting.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/configuration/PluginSetting.java index 6924cb35bc..a8ea4a3ee1 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/configuration/PluginSetting.java +++ b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/configuration/PluginSetting.java @@ -161,6 +161,7 @@ public List getTypedList(final String attribute, final Class type) { * Returns the value of the specified {@literal List>}, 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 The key type diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/EventHandle.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/EventHandle.java index 6049a196e3..d05dd8e36c 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/EventHandle.java +++ b/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 releaseConsumer); } diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigObservable.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigObservable.java index 6a62e2647a..3c436fc68a 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigObservable.java +++ b/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); diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigPublisher.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigPublisher.java index 66982a8db6..ae3ff0ccb4 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginConfigPublisher.java +++ b/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); diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginFactory.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginFactory.java index b233d89043..155df776f4 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/plugin/PluginFactory.java +++ b/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 The type * @return A new instance of your plugin, configured * @since 1.2 diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/source/coordinator/enhanced/EnhancedSourcePartition.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/source/coordinator/enhanced/EnhancedSourcePartition.java index ac52ace478..0fa683b2a5 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/source/coordinator/enhanced/EnhancedSourcePartition.java +++ b/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 progressStateClass, final String serializedPartitionProgressState) { if (Objects.isNull(serializedPartitionProgressState)) { @@ -69,6 +74,9 @@ public T convertStringToPartitionProgressState(Class 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 partitionProgressState) { if (partitionProgressState.isEmpty()) {