程序包 top.shjibi.plugineer.config

类 Config

java.lang.Object
top.shjibi.plugineer.config.Configurable<org.bukkit.configuration.file.YamlConfiguration>
top.shjibi.plugineer.config.Config
public class Config extends Configurable<org.bukkit.configuration.file.YamlConfiguration>
代表了该插件的一种配置文件

  • 字段概要

    字段
    修饰符和类型
    字段
    说明
    protected final org.bukkit.configuration.file.YamlConfiguration
    config
     
    protected final File[]
    files
     
    protected final File
    folder
     
    protected final String
    name
     
    protected final org.bukkit.plugin.java.JavaPlugin
    plugin
     

  • 构造器概要

    构造器
    构造器
    说明
    Config(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull String name)
     
    Config(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull String name, @Nullable String folderPath)
     

  • 方法概要

    修饰符和类型
    方法
    说明
    @NotNull org.bukkit.configuration.ConfigurationSection
    createSection(@NotNull String path)
    在指定路径创建一个ConfigurationSection，之前在此路径的数据将被清空
    @NotNull org.bukkit.configuration.ConfigurationSection
    createSection(@NotNull String path, @NotNull Map<?,?> map)
    在指定路径创建一个ConfigurationSection，之前在此路径的数据将被替换为map
    @NotNull List<String>
    getComments(@NotNull String path)
    获取一个路径中所有的注释
    <T> T
    getConfig(@NotNull Class<T> clazz, @NotNull String path)
    获取一个路径的配置
    @NotNull String
    getConfig(@NotNull String path)
    获取一个路径的配置
    @NotNull org.bukkit.configuration.file.YamlConfiguration
    getData()
     
    @NotNull File[]
    getFiles()
    获取存储数据的所有文件
    @NotNull File
    getFolder()
     
    @NotNull List<String>
    getInlineComments(@NotNull String path)
    获取一个路径中行内注释
    @NotNull String
    getName()
     
    @NotNull org.bukkit.plugin.Plugin
    getPlugin()
    获取使用该数据的文件夹
    protected @NotNull org.bukkit.configuration.file.YamlConfiguration
    load(@NotNull File file)
    从文件中加载数据
    void
    reload()
     
    void
    save()
    保存内存中所有的数据
    void
    setComments(@NotNull String path, @Nullable List<String> comments)
    设置一个路径中所有的注释
    void
    setConfig(@NotNull String path, @Nullable Object value)
    将指定路径的数据设置成value
    void
    setInlineComments(@NotNull String path, @Nullable List<String> comments)
    设置一个路径中行内注释

    从类继承的方法 top.shjibi.plugineer.config.Configurable

    mkdirs, toString

    从类继承的方法 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • 字段详细资料

    • plugin

      protected final org.bukkit.plugin.java.JavaPlugin plugin

    • folder

      protected final File folder

    • files

      protected final File[] files

    • config

      protected final org.bukkit.configuration.file.YamlConfiguration config

    • name

      protected final String name

  • 构造器详细资料

    • Config

      public Config(@NotNull @NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull @NotNull String name)

    • Config

      public Config(@NotNull @NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull @NotNull String name, @Nullable @Nullable String folderPath)

  • 方法详细资料

    • createSection

      @NotNull public @NotNull org.bukkit.configuration.ConfigurationSection createSection(@NotNull @NotNull String path, @NotNull @NotNull Map<?,?> map)
      在指定路径创建一个ConfigurationSection，之前在此路径的数据将被替换为map
      参数:
      path - 要使用的路径
      map - 要使用的数据
      返回:
      创建的ConfigurationSection

    • createSection

      @NotNull public @NotNull org.bukkit.configuration.ConfigurationSection createSection(@NotNull @NotNull String path)
      在指定路径创建一个ConfigurationSection，之前在此路径的数据将被清空
      参数:
      path - 要使用的路径
      返回:
      创建的ConfigurationSection

    • setConfig

      public void setConfig(@NotNull @NotNull String path, @Nullable @Nullable Object value)
      将指定路径的数据设置成value
      参数:
      path - 要使用的路径
      value - 要设置的数据

    • getConfig

      @NotNull public @NotNull String getConfig(@NotNull @NotNull String path)
      获取一个路径的配置
      参数:
      path - 要获取的配置的路径

    • getConfig

      @Nullable public <T> T getConfig(@NotNull @NotNull Class<T> clazz, @NotNull @NotNull String path)
      获取一个路径的配置
      参数:
      clazz - 指定配置的类型，如果不符合该类型，则返回null
      path - 要获取的配置的路径

    • getComments

      @NotNull public @NotNull List<String> getComments(@NotNull @NotNull String path)
      获取一个路径中所有的注释
      参数:
      path - 注释所在的路径

    • getInlineComments

      @NotNull public @NotNull List<String> getInlineComments(@NotNull @NotNull String path)
      获取一个路径中行内注释
      参数:
      path - 行内注释所在的路径

    • setComments

      public void setComments(@NotNull @NotNull String path, @Nullable @Nullable List<String> comments)
      设置一个路径中所有的注释
      参数:
      path - 注释所在的路径
      comments - 注释

    • setInlineComments

      public void setInlineComments(@NotNull @NotNull String path, @Nullable @Nullable List<String> comments)
      设置一个路径中行内注释
      参数:
      path - 行内注释所在的路径
      comments - 注释

    • save

      public void save()
      从类复制的说明: Configurable
      保存内存中所有的数据
      指定者:
      save 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>

    • reload

      public void reload()

    • load

      @NotNull protected @NotNull org.bukkit.configuration.file.YamlConfiguration load(@NotNull @NotNull File file)
      从类复制的说明: Configurable
      从文件中加载数据
      指定者:
      load 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>
      参数:
      file - 需要加载的文件
      返回:
      加载的数据

    • getFiles

      @NotNull public @NotNull File[] getFiles()
      从类复制的说明: Configurable
      获取存储数据的所有文件
      指定者:
      getFiles 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>

    • getName

      @NotNull public @NotNull String getName()
      指定者:
      getName 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>
      返回:
      该数据的名字

    • getFolder

      @NotNull public @NotNull File getFolder()
      指定者:
      getFolder 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>
      返回:
      存储该数据的文件夹

    • getPlugin

      @NotNull public @NotNull org.bukkit.plugin.Plugin getPlugin()
      从类复制的说明: Configurable
      获取使用该数据的文件夹
      指定者:
      getPlugin 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>

    • getData

      @NotNull public @NotNull org.bukkit.configuration.file.YamlConfiguration getData()
      指定者:
      getData 在类中 Configurable<org.bukkit.configuration.file.YamlConfiguration>
      返回:
      内存中所有的数据