程序包 org.bukkit.configuration.file

类 FileConfigurationOptions

java.lang.Object
org.bukkit.configuration.ConfigurationOptions
org.bukkit.configuration.MemoryConfigurationOptions
org.bukkit.configuration.file.FileConfigurationOptions
直接已知子类:
YamlConfigurationOptions
public class FileConfigurationOptions extends MemoryConfigurationOptions
用于控制 FileConfiguration 输入和输出的各种设置.

  • 构造器详细资料

  • 方法详细资料

    • configuration

      @NotNull public @NotNull FileConfiguration configuration()
      从类复制的说明: ConfigurationOptions
      返回关联这个配置的 Configuration.

      原文: Returns the Configuration that this object is responsible for.

      覆盖:
      configuration 在类中 MemoryConfigurationOptions
      返回:
      Parent configuration

    • copyDefaults

      @NotNull public @NotNull FileConfigurationOptions copyDefaults(boolean value)
      从类复制的说明: ConfigurationOptions
      如果这个Configuration从 它的默认Configuration那里直接 复制值, 就设为true.

      如果值为 true, 将直接从默认源中复制所有的值.

      机器翻译(使得不可能分别设置，默认情况下所提供的值的值和区分。?). 其结果ConfigurationSection.contains(java.lang.String), 将始终返回相同的值ConfigurationSection.isSet(java.lang.String).

      默认值是false.

      原文: Sets if the Configuration should copy values from its default Configuration directly.

      If this is true, all values in the default Configuration will be directly copied, making it impossible to distinguish between values that were set and values that are provided by default. As a result, ConfigurationSection.contains(java.lang.String) will always return the same value as ConfigurationSection.isSet(java.lang.String). The default value is false.

      覆盖:
      copyDefaults 在类中 MemoryConfigurationOptions
      参数:
      value - Whether or not defaults are directly copied
      返回:
      返回 this

    • pathSeparator

      @NotNull public @NotNull FileConfigurationOptions pathSeparator(char value)
      从类复制的说明: ConfigurationOptions
      设置用于分离 ConfigurationSection 中路径的 char.

      这个 char 并不会影响数据的储存, 它只是路径的分隔符. 只会影响你在程序中怎样读取数据.默认为 '.'.

      原文: Sets the char that will be used to separate ConfigurationSections.

      This value does not affect how the Configuration is stored, only in how you access the data. The default value is '.'.

      覆盖:
      pathSeparator 在类中 MemoryConfigurationOptions
      参数:
      value - Path 路径分割符.
      返回:
      返回 this .

    • getHeader

      @NotNull public @NotNull List<String> getHeader()
      获取将应用于保存输出顶部的头部注释.

      此头部注释将以注释形式直接应用在 FileConfiguration 生成的输出的顶部. 无需在头部末尾包含换行符, 因为它会自动添加, 但如果需要额外的间距可以包含一个.

      如果不存在注释, 将返回一个空列表. null 条目代表一个空行, 空字符串代表一个空的注释行.

      原文： Gets the header that will be applied to the top of the saved output.

      This header will be commented out and applied directly at the top of the generated output of the FileConfiguration. It is not required to include a newline at the end of the header as it will automatically be applied, but you may include one if you wish for extra spacing.

      If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

      返回:
      不可修改的头部注释, 每个条目代表一行.

    • header

      @NotNull @Deprecated(since="1.18.1") public @NotNull String header()
      已过时。
      请改用getHeader().
      返回:
      字符串形式的头部注释.

    • setHeader

      @NotNull public @NotNull FileConfigurationOptions setHeader(@Nullable @Nullable List<String> value)
      设置将应用于保存输出顶部的头部注释.

      此头部注释将以注释形式直接应用在 FileConfiguration 生成的输出的顶部. 无需在头部末尾包含换行符, 因为它会自动添加, 但如果需要额外的间距可以包含一个.

      如果不存在注释, 将返回一个空列表. null 条目代表一个空行, 空字符串代表一个空的注释行.

      原文： Sets the header that will be applied to the top of the saved output.

      This header will be commented out and applied directly at the top of the generated output of the FileConfiguration. It is not required to include a newline at the end of the header as it will automatically be applied, but you may include one if you wish for extra spacing.

      If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

      参数:
      value - 新的头部注释, 每个条目代表一行.
      返回:
      此对象, 用于链式调用.

    • header

      @NotNull @Deprecated(since="1.18.1") public @NotNull FileConfigurationOptions header(@Nullable @Nullable String value)
      已过时。
      请改用setHeader()
      参数:
      value - 字符串形式的头部注释.
      返回:
      此对象, 用于链式调用.

    • getFooter

      @NotNull public @NotNull List<String> getFooter()
      获取将应用于保存输出底部的尾部注释.

      此尾部注释将以注释形式直接应用在 FileConfiguration 生成的输出的底部. 无需在尾部开头包含换行符, 因为它会自动添加, 但如果需要额外的间距可以包含一个.

      如果不存在注释, 将返回一个空列表. null 条目代表一个空行, 空字符串代表一个空的注释行.

      原文： Gets the footer that will be applied to the bottom of the saved output.

      This footer will be commented out and applied directly at the bottom of the generated output of the FileConfiguration. It is not required to include a newline at the beginning of the footer as it will automatically be applied, but you may include one if you wish for extra spacing.

      If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

      返回:
      不可修改的尾部注释, 每个条目代表一行.

    • setFooter

      @NotNull public @NotNull FileConfigurationOptions setFooter(@Nullable @Nullable List<String> value)
      设置将应用于保存输出底部的尾部注释.

      此尾部注释将以注释形式直接应用在 FileConfiguration 生成的输出的底部. 无需在尾部开头包含换行符, 因为它会自动添加, 但如果需要额外的间距可以包含一个.

      如果不存在注释, 将返回一个空列表. null 条目代表一个空行, 空字符串代表一个空的注释行.

      原文： Sets the footer that will be applied to the bottom of the saved output.

      This footer will be commented out and applied directly at the bottom of the generated output of the FileConfiguration. It is not required to include a newline at the beginning of the footer as it will automatically be applied, but you may include one if you wish for extra spacing.

      If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

      参数:
      value - 新的尾部注释, 每个条目代表一行.
      返回:
      此对象, 用于链式调用.

    • parseComments

      public boolean parseComments()
      获取是否应该加载和保存注释.

      默认为 true.

      原文： Gets whether or not comments should be loaded and saved.

      Defaults to true.

      返回:
      是否解析注释.

    • parseComments

      @NotNull public @NotNull MemoryConfigurationOptions parseComments(boolean value)
      设置是否应该加载和保存注释.

      默认为 true.

      原文： Sets whether or not comments should be loaded and saved.

      Defaults to true.

      参数:
      value - 是否解析注释.
      返回:
      此对象, 用于链式调用.

    • copyHeader

      @Deprecated(since="1.18.1") public boolean copyHeader()
      已过时。
      请改用parseComments().
      返回:
      是否解析注释.

    • copyHeader

      @NotNull @Deprecated(since="1.18.1") public @NotNull FileConfigurationOptions copyHeader(boolean value)
      已过时。
      Call parseComments(boolean) instead.
      参数:
      value - Should comments be parsed.
      返回:
      This object, for chaining