Package org.bukkit.configuration.file

Class YamlConfiguration

java.lang.Object
org.bukkit.configuration.MemorySection
org.bukkit.configuration.MemoryConfiguration
org.bukkit.configuration.file.FileConfiguration
org.bukkit.configuration.file.YamlConfiguration
All Implemented Interfaces:
Configuration, ConfigurationSection
public class YamlConfiguration extends FileConfiguration
An implementation of Configuration which saves all files in Yaml. Note that this implementation is not synchronized.

  • Field Details

  • Constructor Details

    • YamlConfiguration

      public YamlConfiguration()

  • Method Details

    • saveToString

      @NotNull public String saveToString()
      Description copied from class: FileConfiguration
      Saves this FileConfiguration to a string, and returns it.
      Specified by:
      saveToString in class FileConfiguration
      Returns:
      String containing this configuration.

    • loadFromString

      public void loadFromString(@NotNull String contents) throws InvalidConfigurationException
      Description copied from class: FileConfiguration
      Loads this FileConfiguration from the specified string, as opposed to from file.

      All the values contained within this configuration will be removed, leaving only settings and defaults, and the new values will be loaded from the given string.

      If the string is invalid in any way, an exception will be thrown.

      Specified by:
      loadFromString in class FileConfiguration
      Parameters:
      contents - Contents of a Configuration to load.
      Throws:
      InvalidConfigurationException - Thrown if the specified string is invalid.

    • options

      @NotNull public YamlConfigurationOptions options()
      Description copied from interface: Configuration
      Gets the ConfigurationOptions for this Configuration.

      All setters through this method are chainable.

      Specified by:
      options in interface Configuration
      Overrides:
      options in class FileConfiguration
      Returns:
      Options for this configuration

    • loadConfiguration

      @NotNull public static YamlConfiguration loadConfiguration(@NotNull File file)
      Creates a new YamlConfiguration, loading from the given file.

      Any errors loading the Configuration will be logged and then ignored. If the specified input is not a valid config, a blank config will be returned.

      The encoding used may follow the system dependent default.

      Parameters:
      file - Input file
      Returns:
      Resulting configuration
      Throws:
      IllegalArgumentException - Thrown if file is null

    • loadConfiguration

      @NotNull public static YamlConfiguration loadConfiguration(@NotNull Reader reader)
      Creates a new YamlConfiguration, loading from the given reader.

      Any errors loading the Configuration will be logged and then ignored. If the specified input is not a valid config, a blank config will be returned.

      Parameters:
      reader - input
      Returns:
      resulting configuration
      Throws:
      IllegalArgumentException - Thrown if stream is null