From aa4069bc2890442329f74a084bdf4c2a619c92e9 Mon Sep 17 00:00:00 2001
From: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
Date: Mon, 29 Jan 2024 16:32:03 -0800
Subject: [PATCH] Fixing cache-ehcache plugin javadov failures

Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
---
 .../org/opensearch/cache/store/disk/EhcacheDiskCache.java | 8 ++++----
 .../cache/store/StoreAwareCacheRemovalNotification.java   | 4 +++-
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/plugins/cache-ehcache/src/main/java/org/opensearch/cache/store/disk/EhcacheDiskCache.java b/plugins/cache-ehcache/src/main/java/org/opensearch/cache/store/disk/EhcacheDiskCache.java
index 36bbe76ff77fa..18855c3323097 100644
--- a/plugins/cache-ehcache/src/main/java/org/opensearch/cache/store/disk/EhcacheDiskCache.java
+++ b/plugins/cache-ehcache/src/main/java/org/opensearch/cache/store/disk/EhcacheDiskCache.java
@@ -266,7 +266,7 @@ public void put(K key, V value) {
      * @param key Type of key
      * @param loader loader to load the value in case key is missing
      * @return value
-     * @throws Exception
+     * @throws Exception when either internal get or put calls fail.
      */
     @Override
     public V computeIfAbsent(K key, LoadAwareCacheLoader<K, V> loader) throws Exception {
@@ -367,7 +367,7 @@ public Iterable<K> keys() {
 
     /**
      * Gives the current count of keys in disk cache.
-     * @return
+     * @return current count of keys
      */
     @Override
     public long count() {
@@ -576,7 +576,7 @@ public Builder() {}
 
         /**
          * Sets the desired cache type.
-         * @param cacheType
+         * @param cacheType cache type
          * @return builder
          */
         public Builder<K, V> setCacheType(CacheType cacheType) {
@@ -626,7 +626,7 @@ public Builder<K, V> setThreadPoolAlias(String threadPoolAlias) {
 
         /**
          * Cache alias
-         * @param diskCacheAlias
+         * @param diskCacheAlias disk cache alias
          * @return builder
          */
         public Builder<K, V> setDiskCacheAlias(String diskCacheAlias) {
diff --git a/server/src/main/java/org/opensearch/common/cache/store/StoreAwareCacheRemovalNotification.java b/server/src/main/java/org/opensearch/common/cache/store/StoreAwareCacheRemovalNotification.java
index 492dbff3532a1..0c09af3140cf4 100644
--- a/server/src/main/java/org/opensearch/common/cache/store/StoreAwareCacheRemovalNotification.java
+++ b/server/src/main/java/org/opensearch/common/cache/store/StoreAwareCacheRemovalNotification.java
@@ -8,6 +8,7 @@
 
 package org.opensearch.common.cache.store;
 
+import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.common.cache.RemovalNotification;
 import org.opensearch.common.cache.RemovalReason;
 import org.opensearch.common.cache.store.enums.CacheStoreType;
@@ -17,8 +18,9 @@
  * @param <K> Type of key.
  * @param <V> Type of value.
  *
- * @opensearch.internal
+ * @opensearch.experimental
  */
+@ExperimentalApi
 public class StoreAwareCacheRemovalNotification<K, V> extends RemovalNotification<K, V> {
     private final CacheStoreType cacheStoreType;