improve javadoc for attribute value store

Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com>

Author: kaushalmahi12

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStore.java

@@ -15,14 +15,14 @@
  */
 public interface AttributeValueStore<K, V> {
     /**
-     * Adds the value to the data structure
+     * Adds the value to attribute value store
      * @param key to be added
      * @param value to be added
      */
-    void add(K key, V value);
+    void put(K key, V value);
 
     /**
-     * removes the key and associated value from the data structure
+     * removes the key and associated value from attribute value store
      * @param key to be removed
      */
     void remove(K key);
@@ -35,7 +35,7 @@ public interface AttributeValueStore<K, V> {
     Optional<V> get(K key);
 
     /**
-     * Clears all the keys and their associated values from the structure
+     * Clears all the keys and their associated values from the attribute value store
      */
     void clear();
 

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/DefaultAttributeValueStore.java

@@ -38,7 +38,7 @@ public DefaultAttributeValueStore(PatriciaTrie<V> trie) {
     }
 
     @Override
-    public void add(K key, V value) {
+    public void put(K key, V value) {
         trie.put(key, value);
     }
 
@@ -54,7 +54,7 @@ public Optional<V> get(String key) {
          * It is important to find the largest matching prefix key in the trie efficiently
          * Hence we can do binary search
          */
-        String longestMatchingPrefix = findLongestMatchingPrefix(key);
+        final String longestMatchingPrefix = findLongestMatchingPrefix(key);
 
         /**
          * Now there are following cases for this prefix
@@ -76,12 +76,10 @@ private String findLongestMatchingPrefix(String key) {
 
         while (low < high) {
             int mid = low + (high - low + 1) / 2;
-            String possibleMatchingPrefix = key.substring(0, mid);
-
             /**
              * This operation has O(1) complexity because prefixMap returns only the iterator
              */
-            if (!trie.prefixMap(possibleMatchingPrefix).isEmpty()) {
+            if (!trie.prefixMap(key.substring(0, mid)).isEmpty()) {
                 low = mid;
             } else {
                 high = mid - 1;

plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStoreTests.java

@@ -20,33 +20,33 @@ public void setUp() throws Exception {
         subjectUnderTest = new DefaultAttributeValueStore<>(new PatriciaTrie<>());
     }
 
-    public void testAdd() {
-        subjectUnderTest.add("foo", "bar");
+    public void testPut() {
+        subjectUnderTest.put("foo", "bar");
         assertEquals("bar", subjectUnderTest.get("foo").get());
     }
 
     public void testRemove() {
-        subjectUnderTest.add("foo", "bar");
+        subjectUnderTest.put("foo", "bar");
         subjectUnderTest.remove("foo");
         assertEquals(0, subjectUnderTest.size());
     }
 
     public void tesGet() {
-        subjectUnderTest.add("foo", "bar");
+        subjectUnderTest.put("foo", "bar");
         assertEquals("bar", subjectUnderTest.get("foo").get());
     }
 
     public void testGetWhenNoProperPrefixIsPresent() {
-        subjectUnderTest.add("foo", "bar");
-        subjectUnderTest.add("foodip", "sing");
+        subjectUnderTest.put("foo", "bar");
+        subjectUnderTest.put("foodip", "sing");
         assertTrue(subjectUnderTest.get("foxtail").isEmpty());
-        subjectUnderTest.add("fox", "lucy");
+        subjectUnderTest.put("fox", "lucy");
 
         assertFalse(subjectUnderTest.get("foxtail").isEmpty());
     }
 
     public void testClear() {
-        subjectUnderTest.add("foo", "bar");
+        subjectUnderTest.put("foo", "bar");
         subjectUnderTest.clear();
         assertEquals(0, subjectUnderTest.size());
     }