From 82759225b3c230ea652db6b82e79fbaacbb49f84 Mon Sep 17 00:00:00 2001 From: LamGC Date: Fri, 1 Jan 2021 10:13:34 +0800 Subject: [PATCH] =?UTF-8?q?[Change][Document]=20Framework-API=20=E8=B0=83?= =?UTF-8?q?=E6=95=B4=20Framework=20=E7=9A=84=E9=83=A8=E5=88=86=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E5=86=85=E5=AE=B9,=20=E6=9B=B4=E6=94=B9=E7=9B=B8?= =?UTF-8?q?=E5=85=B3=E7=BB=86=E8=8A=82;?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [Document] Framework 修正 '(PluginWrapper, File, FrameworkContext)' 和 'getDataFolder()' 方法的文档细节错误; [Change] Framework 更改 'getDataFolder()' 方法在数据目录创建失败时所输出的日志内容; [Change] Framework 更改 'getDescriptor()' 所抛出的异常类型; --- .../java/net/lamgc/cgj/bot/framework/Framework.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ContentGrabbingJi-framework-api/src/main/java/net/lamgc/cgj/bot/framework/Framework.java b/ContentGrabbingJi-framework-api/src/main/java/net/lamgc/cgj/bot/framework/Framework.java index 5276f49..32504ab 100644 --- a/ContentGrabbingJi-framework-api/src/main/java/net/lamgc/cgj/bot/framework/Framework.java +++ b/ContentGrabbingJi-framework-api/src/main/java/net/lamgc/cgj/bot/framework/Framework.java @@ -35,7 +35,7 @@ public abstract class Framework extends Plugin { /** * 由 FrameworkManager 执行的构造方法. - *

不要在构造方法内做任何处理. 如果你需要, 请在 {@link #initial()} 进行初始化. + *

不要在构造方法内做任何处理. 如果你需要, 请在 {@link #initial()} 进行初始化. * * @param wrapper 包含框架运行期间需要使用对象的包装器. * @param context 框架运行上下文, 由不同 ContentGrabbingJi 实例加载的 Framework 所获得的的 Context 是不一样的. @@ -60,14 +60,14 @@ public abstract class Framework extends Plugin { /** * 获取仅属于该框架的数据存储目录. * - *

调用本方法将会检查目录是否存在, 并在目录不存在时尝试创建. - *

请不要在除数据存储目录外的其他位置存储数据, 这将使用户感到困扰! + *

调用本方法将会检查目录是否存在, 并在目录不存在时尝试创建. + *

请不要在除数据存储目录外的其他位置存储数据, 这将使用户感到困扰! * * @return 返回数据存储目录. */ public final File getDataFolder() { if (!dataFolder.exists() && !dataFolder.mkdirs()) { - log.warn("框架 {} 数据目录创建失败.", getDescriptor().getPluginId()); + log.warn("框架 {} 数据目录创建失败, 请检查是否为应用数据目录提供了读写权限.", getDescriptor().getPluginId()); } return dataFolder; } @@ -81,7 +81,7 @@ public abstract class Framework extends Plugin { if (descriptor instanceof FrameworkDescriptor) { return (FrameworkDescriptor) descriptor; } - throw new IllegalStateException("无法转换 Descriptor 的类型, 框架管理器可能遭到修改!"); + throw new ClassCastException("无法转换 Descriptor 的类型, 框架管理器可能遭到修改!"); } /**