Package pers.neige.neigeitems.utils

Object ConfigUtils

  • All Implemented Interfaces:
    
public class ConfigUtils

    配置文件相关工具类

    • Constructor Detail

    • Method Detail

      • getAllFiles

         final static ArrayList<File> getAllFiles(File dir)

        获取文件夹内所有文件

        Parameters:
        dir - 待获取文件夹
        Returns:

        文件夹内所有文件

      • getAllFiles

         final static ArrayList<File> getAllFiles(String dir)

        获取文件夹内所有文件

        Parameters:
        dir - 待获取文件夹路径
        Returns:

        文件夹内所有文件

      • getAllFiles

         final static ArrayList<File> getAllFiles(Plugin plugin, String dir)

        获取文件夹内所有文件

        Parameters:
        plugin - 待获取文件夹归属插件
        dir - 待获取文件夹路径
        Returns:

        文件夹内所有文件

      • getAllFiles

         final static ArrayList<File> getAllFiles(String plugin, String dir)

        获取文件夹内所有文件

        Parameters:
        plugin - 待获取文件夹归属插件
        dir - 待获取文件夹路径
        Returns:

        文件夹内所有文件

      • getFile

         final static File getFile(String file)

        获取文件夹内文件

        Parameters:
        file - 待获取文件路径
        Returns:

        对应文件

      • getFile

         final static File getFile(Plugin plugin, String file)

        获取文件夹内文件

        Parameters:
        plugin - 待获取文件归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • getFile

         final static File getFile(String plugin, String file)

        获取文件夹内文件

        Parameters:
        plugin - 待获取文件夹归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrNull

         final static File getFileOrNull(String file)

        获取文件夹内文件(不存在时返回null)

        Parameters:
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrNull

         final static File getFileOrNull(Plugin plugin, String file)

        获取文件夹内文件(不存在时返回null)

        Parameters:
        plugin - 待获取文件归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrNull

         final static File getFileOrNull(String plugin, String file)

        获取文件夹内文件(不存在时返回null)

        Parameters:
        plugin - 待获取文件夹归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrCreate

         final static File getFileOrCreate(String file)

        获取文件夹内文件(不存在时创建文件)

        Parameters:
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrCreate

         final static File getFileOrCreate(Plugin plugin, String file)

        获取文件夹内文件(不存在时创建文件)

        Parameters:
        plugin - 待获取文件归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • getFileOrCreate

         final static File getFileOrCreate(String plugin, String file)

        获取文件夹内文件(不存在时创建文件)

        Parameters:
        plugin - 待获取文件夹归属插件
        file - 待获取文件路径
        Returns:

        对应文件

      • clone

         final static ConfigurationSection clone(ConfigurationSection $self)

        深复制ConfigurationSection

        Returns:

        对应ConfigurationSection的克隆

      • clone

         final static List<?> clone(List<?> $self)

        深复制List

        Returns:

        对应List的克隆

      • clone

         final static Map<?, ?> clone(Map<?, ?> $self)

        深复制Map

        Returns:

        对应Map的克隆

      • getConfigSections

         final static ArrayList<ConfigurationSection> getConfigSections(File $self)

        获取文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getConfigSections

         final static ArrayList<ConfigurationSection> getConfigSections(List<File> $self)

        获取所有文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getConfigSectionMap

         final static Map<String, ConfigurationSection> getConfigSectionMap(File $self)

        获取文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getConfigSectionMap

         final static Map<String, ConfigurationSection> getConfigSectionMap(List<File> $self)

        获取所有文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getConfigSectionMap

         final static Map<String, ConfigurationSection> getConfigSectionMap(ConfigurationSection $self)

        获取文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getMap

         final static Map<String, Object> getMap(File $self)

        获取文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getMap

         final static Map<String, Object> getMap(List<File> $self)

        获取所有文件中所有ConfigurationSection

        Returns:

        文件中所有ConfigurationSection

      • getContents

         final static ArrayList<Object> getContents(File $self)

        获取文件中所有顶级节点内容

        Returns:

        文件中所有顶级节点内容

      • toMap

         final static Object toMap(Object data)

        用于 ConfigurationSection 转 HashMap ConfigurationSection 中可能包含 Map, List, ConfigurationSection 及任意值 所有值的处理都放在这个方法里循环调用了, 所以参数和返回值都是Any

        Parameters:
        data - 待转换内容
        Returns:

        转换结果

      • toMap

         final static HashMap<String, Object> toMap(ConfigurationSection $self)

        ConfigurationSection 转 HashMap

        Returns:

        转换结果

      • toStringMap

         final static HashMap<String, String> toStringMap(ConfigurationSection $self)

        ConfigurationSection 转 单层级HashMap<String, String>

        Returns:

        转换结果

      • toIntMap

         final static HashMap<String, Integer> toIntMap(ConfigurationSection $self)

        ConfigurationSection 转 单层级HashMap<String, Int>

        Returns:

        转换结果

      • toDoubleMap

         final static HashMap<String, Double> toDoubleMap(ConfigurationSection $self)

        ConfigurationSection 转 单层级HashMap<String, Double>

        Returns:

        转换结果

      • saveToString

         final static String saveToString(ConfigurationSection $self, String id)

        ConfigurationSection 转 String

        Parameters:
        id - 转换后呈现的节点ID, 一般可以为this.
        Returns:

        转换结果

      • loadFromString

         final static ConfigurationSection loadFromString(String $self)

        String 转 ConfigurationSection

        Returns:

        转换结果

      • loadFromString

         final static ConfigurationSection loadFromString(String $self, String id)

        String 转 ConfigurationSection

        Parameters:
        id - 转换前使用的节点ID
        Returns:

        转换结果

      • loadConfiguration

         final static YamlConfiguration loadConfiguration(File $self)

        File 转 YamlConfiguration

        Returns:

        转换结果

      • coverWith

         final static ConfigurationSection coverWith(ConfigurationSection $self, ConfigurationSection configSection)

        ConfigurationSection 合并(后者覆盖前者, 在前者上操作)

        Parameters:
        configSection - 用于合并覆盖
        Returns:

        合并结果

      • mergeIfAbsent

         final static Boolean mergeIfAbsent(ConfigurationSection config, ConfigurationSection origin)

        用于补全config, 前者为当前config, 后者为默认config. 当默认config中的某个key不存在于当前config时, 将默认值补入当前config.

        Parameters:
        config - 当前config
        origin - 默认config
        Returns:

        是否存在补全行为

      • loadConfig

         final static Unit loadConfig(JavaPlugin $self)

        用于生成或补全插件config. 当不存在config文件时, 将生成默认config文件. 当存在config文件且默认config中的某个key不存在于当前config时, 默认值将补入当前config.

      • loadConfig

         final static Unit loadConfig(JavaPlugin $self, Boolean fixConfig)

        用于生成或加载插件config. 当不存在config文件时, 将生成默认config文件. 当 fixConfig 为 true 时, 如果存在config文件且默认config中的某个key不存在于当前config, 默认值将补入当前config. 当 fixConfig 为 false 时, 将直接加载config.

        Parameters:
        fixConfig - 是否根据默认config进行补全

      • loadGlobalSections

         final static ConfigurationSection loadGlobalSections(ConfigurationSection configSection, Boolean remove)

        全局节点加载

        Parameters:
        remove - 加载完成后是否把globalsections节点删除掉
        Returns:

        操作后配置

      • saveResourceNotWarn

         final static Unit saveResourceNotWarn(JavaPlugin $self, String resourcePath)

        保存默认文件(不进行替换)

        Parameters:
        resourcePath - 文件路径

      • saveResourceNotWarn

         final static Unit saveResourceNotWarn(JavaPlugin $self, String resourcePath, File outFile)

        保存默认文件(不进行替换)

        Parameters:
        resourcePath - 文件路径
        outFile - 输出路径