Configuration PConfig

ParrotX 中的 PConfig 旨在便利您插件单一配置文件的读取与管理。

通过继承该类，并覆写一些方法，即可开始使用，不需再判断文件是否存在并自动释放配置文件等千篇一律的繁琐操作。

构造器

PConfig(PPlugin plugin, String fileName, String typeName)

• 参数：
  • plugin 插件的 PPlugin 主类对象，将用于获取配置文件等其他操作。
  • fileName 自定义配置文件的文件名，将用于获取指定配置文件对象，不需带上 .yml 后缀。
  • typeName 自定义配置文件的用途名，用于输出调试信息以便于您快速了解到插件配置文件系统中各模块的工作情况。

---

开始使用

为了使 PConfig 正常运行，您需要覆写以下方法：

load(File file)

• 返回值：void
• 将在加载配置文件时调用，在该方法中定义加载配置文件的操作，例如赋值类中代表各配置选项的静态常量。
• 参数：
  • file PConfig 所托管的配置文件的 File 对象。

saveDefault()

• 返回值：void
• 将在目标配置文件不存在时调用，在该方法中定义释放默认配置文件的操作。

只需覆写以上两个方法，您即可以开始使用 PConfig，在插件加载时调用 init() 方法即可加载该配置文件。

---

变量与方法

PConfig 类中包含以下变量，您可以在方法中调用他们。

• config 目标配置文件的 FileConfiguration 对象。
• file 目标配置文件的 File 对象。
• plugin 插件主类的 PPlugin 对象。

PConfig 类中已经定义了以下方法，您可以调用他们以进行常规操作。

• reload() 方法实际上调用了 init() 方法以实现重载配置文件操作。
• save() 方法即将 FileConfiguration 对象中的内容保存至 File 对象。
• delete() 方法即尝试删除该配置文件。
• setFile(File file) 方法可以手动重新定义目标配置文件的 File 对象。
• getFileName() 方法将会返回目标配置文件的文件名，不带有 .yml 后缀。
• getTypeName() 方法将会返回目标配置文件的用途名，并带有文件名。
  • 具体格式为 Typename/Filename，例如：插件主配置文件/config。

---

其他

PConfig 类实际上实现了 PConfiguration 接口。