From ef70ac77cbf007737bb7c41169d4cdf9a8c010c3 Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Wed, 3 Jun 2020 17:03:54 +0800
Subject: [PATCH] =?UTF-8?q?[Update]=20HotDataCacheStore,=20Cleanable=20?=
 =?UTF-8?q?=E6=9B=B4=E6=96=B0Javadoc;?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/main/java/net/lamgc/cgj/bot/cache/Cleanable.java         | 5 ++++-
 src/main/java/net/lamgc/cgj/bot/cache/HotDataCacheStore.java | 4 ++++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/main/java/net/lamgc/cgj/bot/cache/Cleanable.java b/src/main/java/net/lamgc/cgj/bot/cache/Cleanable.java
index 9daadb2..9e92d72 100644
--- a/src/main/java/net/lamgc/cgj/bot/cache/Cleanable.java
+++ b/src/main/java/net/lamgc/cgj/bot/cache/Cleanable.java
@@ -1,10 +1,13 @@
 package net.lamgc.cgj.bot.cache;
 
 /**
- * 可清理接口, 实现该接口代表该类拥有清理动作.
+ * 可清理接口, 实现该接口代表该类具有清理动作.
  */
 public interface Cleanable {
 
+    /**
+     * 该方法需要CacheStore完成对过期Entry的清除.
+     */
     void clean() throws Exception;
 
 }
diff --git a/src/main/java/net/lamgc/cgj/bot/cache/HotDataCacheStore.java b/src/main/java/net/lamgc/cgj/bot/cache/HotDataCacheStore.java
index ba898c1..f360f53 100644
--- a/src/main/java/net/lamgc/cgj/bot/cache/HotDataCacheStore.java
+++ b/src/main/java/net/lamgc/cgj/bot/cache/HotDataCacheStore.java
@@ -133,6 +133,10 @@ public class HotDataCacheStore<T> implements CacheStore<T>, Cleanable {
         return current.supportedList() && parent.supportedList();
     }
 
+    /**
+     * 检查并清理已过期的Entry.
+     * <p>该方法仅清理Current缓存库, 不会对上游缓存库造成影响.</p>
+     */
     @Override
     public void clean() {
         for(String key : this.current.keys()) {