From 1c634af225f6479346b7fb6a4d3247634b1cf2f2 Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Tue, 29 Sep 2020 10:10:01 +0800
Subject: [PATCH] =?UTF-8?q?[Add][Document]=20CacheStore-API=20=E6=9B=B4?=
 =?UTF-8?q?=E6=96=B0=20Javadoc=20=E5=B9=B6=E6=B7=BB=E5=8A=A0=E5=88=9D?=
 =?UTF-8?q?=E7=89=88=20Readme.md;?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

[Add] README.md 增加子模块的 Readme;
[Document] CollectionCacheStore 更新 Javadoc;
---
 ContentGrabbingJi-CacheStore-api/README.md             | 10 ++++++++++
 .../net/lamgc/cgj/bot/cache/CollectionCacheStore.java  |  2 ++
 2 files changed, 12 insertions(+)
 create mode 100644 ContentGrabbingJi-CacheStore-api/README.md

diff --git a/ContentGrabbingJi-CacheStore-api/README.md b/ContentGrabbingJi-CacheStore-api/README.md
new file mode 100644
index 0000000..9071452
--- /dev/null
+++ b/ContentGrabbingJi-CacheStore-api/README.md
@@ -0,0 +1,10 @@
+# CacheStore-API #
+
+如需开发更多缓存组件，至少需要实现以下接口：
+- CacheStore
+    - 不一定要实现该接口, 可以直接实现 具体的接口（比如 `SingleCacheStore`）
+- CacheStoreFactory
+    - 你还需要为其添加 `@Factory` 注解，否则不会生效。
+- SingleCacheStore
+
+正常情况下，该模块不需要进行更改，即使需要更改，也需要保证向后兼容性。
diff --git a/ContentGrabbingJi-CacheStore-api/src/main/java/net/lamgc/cgj/bot/cache/CollectionCacheStore.java b/ContentGrabbingJi-CacheStore-api/src/main/java/net/lamgc/cgj/bot/cache/CollectionCacheStore.java
index ba2714f..b77f7c8 100644
--- a/ContentGrabbingJi-CacheStore-api/src/main/java/net/lamgc/cgj/bot/cache/CollectionCacheStore.java
+++ b/ContentGrabbingJi-CacheStore-api/src/main/java/net/lamgc/cgj/bot/cache/CollectionCacheStore.java
@@ -22,6 +22,8 @@ import java.util.Collection;
 /**
  * 集合型缓存存储容器.
  * @param <E> 元素类型.
+ * @param <C> 集合类型.
+ * @see Collection
  * @author LamGC
  */
 public interface CollectionCacheStore<E, C extends Collection<E>> extends CacheStore<C> {