public class YamlConfigurationOptions extends FileConfigurationOptions
YamlConfiguration
Modifier | Constructor | Description |
---|---|---|
protected |
YamlConfigurationOptions(@NotNull YamlConfiguration configuration) |
Modifier and Type | Method | Description |
---|---|---|
@NotNull YamlConfiguration |
configuration() |
Returns the
Configuration that this object is responsible for. |
@NotNull YamlConfigurationOptions |
copyDefaults(boolean value) |
Sets if the
Configuration should copy values from its default
Configuration directly. |
@NotNull YamlConfigurationOptions |
copyHeader(boolean value) |
Sets whether or not the header should be copied from a default source.
|
@NotNull YamlConfigurationOptions |
header(@Nullable String value) |
Sets the header that will be applied to the top of the saved output.
|
int |
indent() |
Gets how much spaces should be used to indent each line.
|
@NotNull YamlConfigurationOptions |
indent(int value) |
Sets how much spaces should be used to indent each line.
|
@NotNull YamlConfigurationOptions |
pathSeparator(char value) |
Sets the char that will be used to separate
ConfigurationSection s |
copyDefaults, pathSeparator
copyHeader, header
protected YamlConfigurationOptions(@NotNull @NotNull YamlConfiguration configuration)
@NotNull public @NotNull YamlConfiguration configuration()
ConfigurationOptions
Configuration
that this object is responsible for.configuration
in class FileConfigurationOptions
@NotNull public @NotNull YamlConfigurationOptions copyDefaults(boolean value)
ConfigurationOptions
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
in class FileConfigurationOptions
value
- Whether or not defaults are directly copied@NotNull public @NotNull YamlConfigurationOptions pathSeparator(char value)
ConfigurationOptions
ConfigurationSection
s
This value does not affect how the Configuration
is stored,
only in how you access the data. The default value is '.'.
pathSeparator
in class FileConfigurationOptions
value
- Path separator@NotNull public @NotNull YamlConfigurationOptions header(@Nullable @Nullable String value)
FileConfigurationOptions
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.
header
in class FileConfigurationOptions
value
- New header@NotNull public @NotNull YamlConfigurationOptions copyHeader(boolean value)
FileConfigurationOptions
If this is true, if a default FileConfiguration
is passed to
MemoryConfiguration.setDefaults(org.bukkit.configuration.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.
copyHeader
in class FileConfigurationOptions
value
- Whether or not to copy the headerpublic int indent()
The minimum value this may be is 2, and the maximum is 9.
@NotNull public @NotNull YamlConfigurationOptions indent(int value)
The minimum value this may be is 2, and the maximum is 9.
value
- New indentCopyright © 2020. All rights reserved.