Skip to content

Configuration PFolder

Legoshi edited this page Mar 20, 2020 · 1 revision

ParrotX 中的 PFolder 旨在帮助你简化对数据文件夹的读取与管理。

与 PConfig 类一样,通过继承该类,并覆写一些必需的方法,即可开始使用。

构造器

PFolder(PPlugin plugin, String folderName, String typeName)

  • 参数:
    • plugin 插件的 PPlugin 主类对象,将用于获取文件夹的 File 对象等其他操作。
    • folderName 文件夹名,将用于获取指定文件夹的 File 对象。
    • typeName 数据文件夹的用途名,用于输出调试信息以便于您快速了解到插件配置文件系统中各模块的工作情况。

开始使用

您需要覆写以下方法:

load(File file)

  • 返回值:void
  • 将在加载数据文件夹中的单个配置文件时调用,在该方法中定义加载配置文件的操作,例如新建数据类对象并放入 Map 中。
  • 参数:
    • file 数据文件夹中的单个配置文件。

在覆写以上方法后,您即可开始使用 PFolder,但是有需求时您也可以选择实现以下方法来完善该类。

  • releaseDefaultData() 方法将在目标数据文件夹不存在时调用,在该方法中定义释放默认配置文件的操作,当然您也不一定需要在创建数据文件夹时释放默认配置文件。
  • saveAll() 方法用于用于保存全部的数据文件。
  • delete(String id) 方法用于删除指定数据文件,参数 id 为对应的数据文件在您的 PFolder 中存储的 ID。
  • save(String id) 方法用于保存指定的数据文件,参数 id 为对应的数据文件在您的 PFolder 中存储的 ID。

其他

  • PFolder 与 PConfig 同样提供了一些变量用于在方法中调用,与 PConfig 大同小异。
  • PFolder 类实际上实现了 PDataFolder 接口。
  • 我个人推荐 PFolder 中声明一个 Map<String, FileConfiguration/数据类对象> 变量在 load(File file) 方法中读取后放入 Map 中。

Clone this wiki locally