Fixing cache-ehcache plugin javadov failures

Signed-off-by: Sagar Upadhyaya <[email protected]>
sgup432 · Jan 30, 2024 · aa4069b · aa4069b
1 parent e846ab6
commit aa4069b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 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
@@ -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/...r/src/main/java/org/opensearch/common/cache/store/StoreAwareCacheRemovalNotification.java b/...r/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;