Module bus.setting
Package org.miaixz.bus.setting

Class Loader

java.lang.Object
org.miaixz.bus.setting.Loader
public class Loader extends Object
Setting文件加载器
Since:
Java 17+
Author:
Kimi Liu

  • Constructor Details

    • Loader

      public Loader()

    • Loader

      public Loader(Factory formatterFactory)

    • Loader

      public Loader(Charset charset, boolean isUseVariable)
      构造
      Parameters:
      charset - 编码
      isUseVariable - 是否使用变量

  • Method Details

    • load

      public GroupedMap load(org.miaixz.bus.core.io.resource.Resource resource) throws org.miaixz.bus.core.lang.exception.NotFoundException
      加载设置文件
      Parameters:
      resource - 配置文件URL
      Returns:
      加载是否成功
      Throws:
      org.miaixz.bus.core.lang.exception.NotFoundException - 如果资源不存在，抛出此异常

    • load

      public GroupedMap load(InputStream inputStream) throws IOException
      加载设置文件。 此方法不会关闭流对象
      Parameters:
      inputStream - 文件流
      Returns:
      GroupedMap
      Throws:
      IOException - IO异常

    • store

      public void store(GroupedMap groupedMap, String absolutePath)
      持久化当前设置，会覆盖掉之前的设置 持久化会不会保留之前的分组
      Parameters:
      groupedMap - 分组map
      absolutePath - 设置文件的绝对路径

    • store

      public void store(GroupedMap groupedMap, File file)
      持久化当前设置，会覆盖掉之前的设置 持久化会不会保留之前的分组
      Parameters:
      groupedMap - 分组map
      file - 设置文件

    • setVarRegex

      public Loader setVarRegex(String regex)
      设置变量的正则 正则只能有一个group表示变量本身，剩余为字符 例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
      Parameters:
      regex - 正则
      Returns:
      this

    • setAssignFlag

      public Loader setAssignFlag(char assignFlag)
      赋值分隔符（用于分隔键值对）
      Parameters:
      assignFlag - 正则
      Returns:
      this

    • setValueEditor

      public Loader setValueEditor(Loader.ValueEditor valueEditor)
      设置值编辑器，用于在获取值后编辑返回值，例如解密等 编辑器函数接受一个参数，此参数为待编辑的值，函数返回编辑后的值 注意：此函数调用在变量替换前
      Parameters:
      valueEditor - 编辑器函数
      Returns:
      this

    • getFormatter

      protected Format getFormatter()
      get a default formatter by factory
      Returns:
      Format

    • read

      public IniSetting read(InputStream in) throws IOException
      read ini data from an inputStream
      Parameters:
      in - an ini data inputStream
      Returns:
      ini bean
      Throws:
      IOException - io exception
      See Also:

    • read

      public IniSetting read(File file) throws IOException
      read ini file to bean
      Parameters:
      file - ini file
      Returns:
      ini bean
      Throws:
      IOException - io exception
      See Also:

    • read

      public IniSetting read(Path path) throws IOException
      read ini file to bean
      Parameters:
      path - ini path(file)
      Returns:
      ini bean
      Throws:
      IOException - io exception
      See Also:

    • read

      public IniSetting read(Reader reader) throws IOException
      to buffered and read
      Parameters:
      reader - ini data reader
      Returns:
      the object
      Throws:
      IOException - io exception

    • defaultFormat

      protected IniSetting defaultFormat(Reader reader) throws IOException
      format reader to ini bean
      Parameters:
      reader - reader
      Returns:
      IniSetting bean
      Throws:
      IOException - io exception
      See Also:

    • defaultFormat

      protected IniSetting defaultFormat(Reader reader, int builderCapacity) throws IOException
      format reader to ini bean
      Parameters:
      reader - reader
      builderCapacity - StringBuilder init param
      Returns:
      IniSetting bean
      Throws:
      IOException - io exception

    • getCommentElementFormatterSupplier

      public Supplier<ElementFormatter<IniComment>> getCommentElementFormatterSupplier()

    • setCommentElementFormatterSupplier

      public void setCommentElementFormatterSupplier(Supplier<ElementFormatter<IniComment>> commentElementFormatterSupplier)

    • getSectionElementFormatterSupplier

      public Supplier<ElementFormatter<IniSection>> getSectionElementFormatterSupplier()

    • setSectionElementFormatterSupplier

      public void setSectionElementFormatterSupplier(Supplier<ElementFormatter<IniSection>> sectionElementFormatterSupplier)

    • getPropertyElementFormatterSupplier

      public Supplier<ElementFormatter<IniProperty>> getPropertyElementFormatterSupplier()

    • setPropertyElementFormatterSupplier

      public void setPropertyElementFormatterSupplier(Supplier<ElementFormatter<IniProperty>> propertyElementFormatterSupplier)