程序包 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
Various settings for controlling the input and output of a 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()
      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.

      返回:
      Unmodifiable header, every entry represents one line.

    • header

      @NotNull @Deprecated(since="1.18.1") public @NotNull String header()
      已过时。
      use getHeader() instead.
      返回:
      The string header.

    • setHeader

      @NotNull public @NotNull FileConfigurationOptions setHeader(@Nullable @Nullable List<String> value)
      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 - New header, every entry represents one line.
      返回:
      This object, for chaining

    • header

      @NotNull @Deprecated(since="1.18.1") public @NotNull FileConfigurationOptions header(@Nullable @Nullable String value)
      已过时。
      use setHeader() instead
      参数:
      value - The string header.
      返回:
      This object, for chaining.

    • getFooter

      @NotNull public @NotNull List<String> getFooter()
      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.

      返回:
      Unmodifiable footer, every entry represents one line.

    • setFooter

      @NotNull public @NotNull FileConfigurationOptions setFooter(@Nullable @Nullable List<String> value)
      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 - New footer, every entry represents one line.
      返回:
      This object, for chaining

    • parseComments

      public boolean parseComments()
      Gets whether or not comments should be loaded and saved.

      Defaults to true.

      返回:
      Whether or not comments are parsed.

    • parseComments

      @NotNull public @NotNull MemoryConfigurationOptions parseComments(boolean value)
      Sets whether or not comments should be loaded and saved.

      Defaults to true.

      参数:
      value - Whether or not comments are parsed.
      返回:
      This object, for chaining

    • copyHeader

      @Deprecated(since="1.18.1") public boolean copyHeader()
      已过时。
      Call parseComments() instead.
      返回:
      Whether or not comments are parsed.

    • 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