From 115f36c218b0a6d3adff49c2e6b968de83752e80 Mon Sep 17 00:00:00 2001 From: Kaushal Kumar Date: Tue, 7 Jan 2025 15:33:52 -0800 Subject: [PATCH] fix javadoc errors Signed-off-by: Kaushal Kumar --- .../FastPrefixMatchingStructure.java | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/structure/FastPrefixMatchingStructure.java b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/structure/FastPrefixMatchingStructure.java index 654b2687c1d80..a0a09270fa895 100644 --- a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/structure/FastPrefixMatchingStructure.java +++ b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/structure/FastPrefixMatchingStructure.java @@ -10,10 +10,31 @@ import java.util.List; +/** + * Common interface which exposes methods to add/search/delete Rule attributes + */ public interface FastPrefixMatchingStructure { + /** + * Inserts the rule output against the attribute value denoted by key + * @param key + * @param value + */ void insert(String key, String value); + /** + * Searches for a key in structure. + * + * @param key The key to search for. + * @return A list of string values associated with the key or its prefixes. + * Returns an empty list if no matches are found. + */ List search(String key); + /** + * Deletes a key from the structure. + * + * @param key The key to be deleted. + * @return true if the key was successfully deleted, false otherwise. + */ boolean delete(String key); }