Package me.confuser.banmanager.common.configuration.file

Class YamlConfigurationOptions

java.lang.Object
me.confuser.banmanager.common.configuration.MemoryConfigurationOptions
me.confuser.banmanager.common.configuration.file.FileConfigurationOptions
me.confuser.banmanager.common.configuration.file.YamlConfigurationOptions
public class YamlConfigurationOptions extends FileConfigurationOptions
Various settings for controlling the input and output of a YamlConfiguration.

  • Method Details

    • configuration

      public YamlConfiguration configuration()
      Returns the Configuration that this object is responsible for.
      Overrides:
      configuration in class FileConfigurationOptions
      Returns:
      Parent configuration

    • copyDefaults

      public YamlConfigurationOptions copyDefaults(boolean value)
      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(String) will always return the same value as ConfigurationSection.isSet(String). The default value is false.

      Overrides:
      copyDefaults in class FileConfigurationOptions
      Parameters:
      value - Whether or not defaults are directly copied
      Returns:
      This object, for chaining

    • pathSeparator

      public YamlConfigurationOptions pathSeparator(char value)
      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 '.'.

      Overrides:
      pathSeparator in class FileConfigurationOptions
      Parameters:
      value - Path separator
      Returns:
      This object, for chaining

    • header

      public YamlConfigurationOptions header(String value)
      Description copied from class: FileConfigurationOptions
      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.

      null is a valid value which will indicate that no header is to be applied.

      Overrides:
      header in class FileConfigurationOptions
      Parameters:
      value - New header
      Returns:
      This object, for chaining

    • copyHeader

      public YamlConfigurationOptions copyHeader(boolean value)
      Description copied from class: FileConfigurationOptions
      Sets whether or not the header should be copied from a default source.

      If this is true, if a default FileConfiguration is passed to MemoryConfiguration.setDefaults(Configuration) then upon saving it will use the header from that config, instead of the one provided here.

      If no default is set on the configuration, or the default is not of type FileConfiguration, or that config has no header (FileConfigurationOptions.header() returns null) then the header specified in this configuration will be used.

      Defaults to true.

      Overrides:
      copyHeader in class FileConfigurationOptions
      Parameters:
      value - Whether or not to copy the header
      Returns:
      This object, for chaining

    • indent

      public int indent()
      Gets how much spaces should be used to indent each line.

      The minimum value this may be is 2, and the maximum is 9.

      Returns:
      How much to indent by

    • indent

      public YamlConfigurationOptions indent(int value)
      Sets how much spaces should be used to indent each line.

      The minimum value this may be is 2, and the maximum is 9.

      Parameters:
      value - New indent
      Returns:
      This object, for chaining

    • pathSeparator

      public char pathSeparator()
      Gets 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 '.'.

      Returns:
      Path separator

    • copyDefaults

      public boolean copyDefaults()
      Checks 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(String) will always return the same value as ConfigurationSection.isSet(String). The default value is false.

      Returns:
      Whether or not defaults are directly copied